deb-s3-x 0.7.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTljYmMxOWI3NDE1YmQ0YTg5ODZlZWJhNmYwMDlkODgyNDQyYWU3NA==
+  data.tar.gz: !binary |-
+    YmRmY2YxYmIxMTAwZTIxMDBmYWRiMWJmYmZkZDJkZGE1MzI1Y2I4Ng==
+SHA512:
+  metadata.gz: !binary |-
+    NmM3MDgzODllYTk5NGRkMjUyYjlmOWU4NTQxNWZjNjFjOGQ5NTg3YmNjMWJj
+    MTZmYmYwYWI3YzgxNTUzNWQyMzA3NmUxMzQzZDY2MDc0ZmM5Y2YyZjU4ZGRk
+    ODJhOTc0NWY5YWVlYzVlZjFjNzg3NjFjNWRjODU3NjAyZWFlY2M=
+  data.tar.gz: !binary |-
+    ZGY5MmE0ZjRmN2U5MGQ1NWY5MTMxODUxNmU4YTlhNWY2NmExYjU0Y2IwZDk5
+    ODA3ODY2YWM1MDVkNjk2NDcxMzRhOTc4ODc1YTEzMDk4MmFiOTEyZjA5Nzkz
+    ZmEzYTYyOWZlNDRlMTZhNmUxNzA5MDVjYjU2ZDlmZTNlYWRkYTU=

data/README.md

@@ -0,0 +1,126 @@
+# deb-s3
+
+[![Build Status](https://travis-ci.org/krobertson/deb-s3.svg?branch=master)](https://travis-ci.org/krobertson/deb-s3)
+
+`deb-s3` is a simple utility to make creating and managing APT repositories on
+S3.
+
+Most existing existing guides on using S3 to host an APT repository have you
+using something like [reprepro](http://mirrorer.alioth.debian.org/) to generate
+the repository file structure, and then [s3cmd](http://s3tools.org/s3cmd) to
+sync the files to S3.
+
+The annoying thing about this process is it requires you to maintain a local
+copy of the file tree for regenerating and syncing the next time. Personally,
+my process is to use one-off virtual machines with
+[Vagrant](http://vagrantup.com), script out the build process, and then would
+prefer to just upload the final `.deb` from my Mac.
+
+With `deb-s3`, there is no need for this. `deb-s3` features:
+
+* Downloads the existing package manifest and parses it.
+* Updates it with the new package, replacing the existing entry if already
+  there or adding a new one if not.
+* Uploads the package itself, the Packages manifest, and the Packages.gz
+  manifest. It will skip the uploading if the package is already there.
+* Updates the Release file with the new hashes and file sizes.
+
+## Getting Started
+
+You can simply install it from rubygems:
+
+```console
+$ gem install deb-s3
+```
+
+Or to run the code directly, just check out the repo and run Bundler to ensure
+all dependencies are installed:
+
+```console
+$ git clone https://github.com/krobertson/deb-s3.git
+$ cd deb-s3
+$ bundle install
+```
+
+Now to upload a package, simply use:
+
+```console
+$ deb-s3 upload --bucket my-bucket my-deb-package-1.0.0_amd64.deb
+>> Examining package file my-deb-package-1.0.0_amd64.deb
+>> Retrieving existing package manifest
+>> Uploading package and new manifests to S3
+   -- Transferring pool/m/my/my-deb-package-1.0.0_amd64.deb
+   -- Transferring dists/stable/main/binary-amd64/Packages
+   -- Transferring dists/stable/main/binary-amd64/Packages.gz
+   -- Transferring dists/stable/Release
+>> Update complete.
+```
+
+```
+Usage:
+  deb-s3 upload FILES
+
+Options:
+  -a, [--arch=ARCH]                     # The architecture of the package in the APT repository.
+      [--sign=SIGN]                     # Sign the Release file. Use --sign with your key ID to use a specific key.
+  -p, [--preserve-versions]             # Whether to preserve other versions of a package in the repository when uploading one.
+  -b, [--bucket=BUCKET]                 # The name of the S3 bucket to upload to.
+  -c, [--codename=CODENAME]             # The codename of the APT repository.
+                                        # Default: stable
+  -m, [--component=COMPONENT]           # The component of the APT repository.
+                                        # Default: main
+      [--access-key-id=ACCESS_KEY]      # The access key for connecting to S3.
+      [--secret-access-key=SECRET_KEY]  # The secret key for connecting to S3.
+  -v, [--visibility=VISIBILITY]         # The access policy for the uploaded files. Can be public, private, or authenticated.
+                                        # Default: public
+
+Uploads the given files to a S3 bucket as an APT repository.
+```
+
+You can also delete packages from the APT repository. Please keep in mind that
+this does NOT delete the .deb file itself, it only removes it from the list of
+packages in the specified component, codename and architecture.
+
+Now to delete the package:
+```console
+$ deb-s3 delete --arch amd64 --bucket my-bucket --versions 1.0.0 my-deb-package
+>> Retrieving existing manifests
+   -- Deleting my-deb-package version 1.0.0
+>> Uploading new manifests to S3
+   -- Transferring dists/stable/main/binary-amd64/Packages
+   -- Transferring dists/stable/main/binary-amd64/Packages.gz
+   -- Transferring dists/stable/Release
+>> Update complete.
+
+````
+
+You can also verify an existing APT repository on S3 using the `verify` command:
+
+```console
+deb-s3 verify -b my-bucket
+>> Retrieving existing manifests
+>> Checking for missing packages in: stable/main i386
+>> Checking for missing packages in: stable/main amd64
+>> Checking for missing packages in: stable/main all
+```
+
+```
+Usage:
+  deb-s3 verify
+
+Options:
+  -f, [--fix-manifests]                 # Whether to fix problems in manifests when verifying.
+      [--sign=SIGN]                     # Sign the Release file. Use --sign with your key ID to use a specific key.
+  -b, [--bucket=BUCKET]                 # The name of the S3 bucket to upload to.
+  -c, [--codename=CODENAME]             # The codename of the APT repository.
+                                        # Default: stable
+  -m, [--component=COMPONENT]           # The component of the APT repository.
+                                        # Default: main
+      [--access-key-id=ACCESS_KEY]      # The access key for connecting to S3.
+      [--secret-access-key=SECRET_KEY]  # The secret key for connecting to S3.
+  -v, [--visibility=VISIBILITY]         # The access policy for the uploaded files. Can be public, private, or authenticated.
+                                        # Default: public
+
+Verifies that the files in the package manifests exist
+```
+

data/bin/deb-s3

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rubygems'
+require 'deb/s3/cli'
+
+Deb::S3::CLI.start
+

data/lib/deb/s3.rb

@@ -0,0 +1,6 @@
+# -*- encoding : utf-8 -*-
+module Deb
+  module S3
+    VERSION = "0.7.1.1"
+  end
+end

data/lib/deb/s3/cli.rb

@@ -0,0 +1,531 @@
+# -*- encoding : utf-8 -*-
+require "aws"
+require "thor"
+
+# Hack: aws requires this!
+require "json"
+
+require "deb/s3"
+require "deb/s3/utils"
+require "deb/s3/manifest"
+require "deb/s3/package"
+require "deb/s3/release"
+
+class Deb::S3::CLI < Thor
+  class_option :bucket,
+  :type     => :string,
+  :aliases  => "-b",
+  :desc     => "The name of the S3 bucket to upload to."
+
+  class_option :prefix,
+  :type     => :string,
+  :desc     => "The path prefix to use when storing on S3."
+
+  class_option :origin,
+  :type     => :string,
+  :aliases  => "-o",
+  :desc     => "The origin to use in the repository Release file."
+
+  class_option :suite,
+  :type     => :string,
+  :desc     => "The suite to use in the repository Release file."
+
+  class_option :codename,
+  :default  => "stable",
+  :type     => :string,
+  :aliases  => "-c",
+  :desc     => "The codename of the APT repository."
+
+  class_option :component,
+  :default  => "main",
+  :type     => :string,
+  :aliases  => "-m",
+  :desc     => "The component of the APT repository."
+
+  class_option :section,
+  :type     => :string,
+  :aliases  => "-s",
+  :hide     => true
+
+  class_option :access_key_id,
+  :type     => :string,
+  :desc     => "The access key for connecting to S3."
+
+  class_option :secret_access_key,
+  :type     => :string,
+  :desc     => "The secret key for connecting to S3."
+
+  class_option :endpoint,
+  :type     => :string,
+  :desc     => "The region endpoint for connecting to S3.",
+  :default  => "s3.amazonaws.com"
+
+  class_option :proxy_uri,
+  :type     => :string,
+  :desc     => "The URI of the proxy to send service requests through."
+
+  class_option :use_ssl,
+  :default  => true,
+  :type     => :boolean,
+  :desc     => "Whether to use HTTP or HTTPS for request transport."
+
+  class_option :visibility,
+  :default  => "public",
+  :type     => :string,
+  :aliases  => "-v",
+  :desc     => "The access policy for the uploaded files. " +
+    "Can be public, private, or authenticated."
+
+  class_option :sign,
+  :type     => :string,
+  :desc     => "Sign the Release file when uploading a package," +
+    "or when verifying it after removing a package." +
+    "Use --sign with your key ID to use a specific key."
+
+  class_option :gpg_options,
+  :default => "",
+  :type    => :string,
+  :desc    => "Additional command line options to pass to GPG when signing"
+
+  class_option :encryption,
+  :default  => false,
+  :type     => :boolean,
+  :aliases  => "-e",
+  :desc     => "Use S3 server side encryption"
+
+  class_option :quiet,
+  :type => :boolean,
+  :aliases => "-q",
+  :desc => "Doesn't output information, just returns status appropriately."
+
+  class_option :cache_control,
+  :type     => :string,
+  :aliases  => "-C",
+  :desc     => "Add cache-control headers to S3 objects"
+
+  desc "upload FILES",
+  "Uploads the given files to a S3 bucket as an APT repository."
+
+  option :arch,
+  :type     => :string,
+  :aliases  => "-a",
+  :desc     => "The architecture of the package in the APT repository."
+
+  option :preserve_versions,
+  :default  => false,
+  :type     => :boolean,
+  :aliases  => "-p",
+  :desc     => "Whether to preserve other versions of a package " +
+    "in the repository when uploading one."
+
+  def upload(*files)
+    if files.nil? || files.empty?
+      error("You must specify at least one file to upload")
+    end
+
+    # make sure all the files exists
+    if missing_file = files.find { |pattern| Dir.glob(pattern).empty? }
+      error("File '#{missing_file}' doesn't exist")
+    end
+
+    # configure AWS::S3
+    configure_s3_client
+
+    # retrieve the existing manifests
+    log("Retrieving existing manifests")
+    release  = Deb::S3::Release.retrieve(options[:codename], options[:origin], options[:suite], options[:cache_control])
+    manifests = {}
+    release.architectures.each do |arch|
+      manifests[arch] = Deb::S3::Manifest.retrieve(options[:codename], component, arch, options[:cache_control])
+    end
+
+    packages_arch_all = []
+
+    # examine all the files
+    files.collect { |f| Dir.glob(f) }.flatten.each do |file|
+      log("Examining package file #{File.basename(file)}")
+      pkg = Deb::S3::Package.parse_file(file)
+      url_filename = "#{pkg.name}-#{pkg.full_version}_#{pkg.architecture}.deb"
+      pkg.url_filename = "pool/#{options[:codename]}/#{component}/#{pkg.name[0]}/#{pkg.name[0..1]}/#{url_filename}"
+
+      # copy over some options if they weren't given
+      arch = options[:arch] || pkg.architecture
+
+      # validate we have them
+      error("No architcture given and unable to determine one for #{file}. " +
+            "Please specify one with --arch [i386|amd64].") unless arch
+
+      # If the arch is all and the list of existing manifests is none, then
+      # throw an error. This is mainly the case when initializing a brand new
+      # repository. With "all", we won't know which architectures they're using.
+      if arch == "all" && manifests.count == 0
+        error("Package #{File.basename(file)} had architecture \"all\", " +
+              "however noexisting package lists exist. This can often happen " +
+              "if the first package you are add to a new repository is an " +
+              "\"all\" architecture file. Please use --arch [i386|amd64] or " +
+              "another platform type to upload the file.")
+      end
+
+      # retrieve the manifest for the arch if we don't have it already
+      manifests[arch] ||= Deb::S3::Manifest.retrieve(options[:codename], component, arch, options[:cache_control])
+
+      # add package in manifests
+      manifests[arch].add(pkg, options[:preserve_versions])
+
+      # If arch is all, we must add this package in all arch available
+      if arch == 'all'
+        packages_arch_all << pkg
+      end
+    end
+
+    manifests.each do |arch, manifest|
+      next if arch == 'all'
+      packages_arch_all.each do |pkg|
+        manifest.add(pkg, options[:preserve_versions], false)
+      end
+    end
+
+    # upload the manifest
+    log("Uploading packages and new manifests to S3")
+    manifests.each_value do |manifest|
+      manifest.write_to_s3 { |f| sublog("Transferring #{f}") }
+      release.update_manifest(manifest)
+    end
+    release.write_to_s3 { |f| sublog("Transferring #{f}") }
+
+    log("Update complete.")
+  end
+
+  desc "list", "Lists packages in given codename, component, and optionally architecture"
+
+  option :long,
+  :type     => :boolean,
+  :aliases  => '-l',
+  :desc     => "Shows all package information in original format",
+  :default  => false
+
+  option :arch,
+  :type     => :string,
+  :aliases  => "-a",
+  :desc     => "The architecture of the package in the APT repository."
+
+  def list
+    configure_s3_client
+
+    release = Deb::S3::Release.retrieve(options[:codename])
+    archs = release.architectures
+    archs &= [options[:arch]] if options[:arch] && options[:arch] != "all"
+    widths = [0, 0]
+    rows = archs.map { |arch|
+      manifest = Deb::S3::Manifest.retrieve(options[:codename], component,
+                                            arch, options[:cache_control])
+      manifest.packages.map do |package|
+        if options[:long]
+          package.generate
+        else
+          [package.name, package.full_version, package.architecture].tap do |row|
+            row.each_with_index do |col, i|
+              widths[i] = [widths[i], col.size].max if widths[i]
+            end
+          end
+        end
+      end
+    }.flatten(1)
+
+    if options[:long]
+      $stdout.puts rows.join("\n")
+    else
+      rows.each do |row|
+        $stdout.puts "% -#{widths[0]}s  % -#{widths[1]}s  %s" % row
+      end
+    end
+  end
+
+  desc "show PACKAGE VERSION ARCH", "Shows information about a package."
+
+  def show(package_name, version, arch)
+    if version.nil?
+      error "You must specify the name of the package to show."
+    end
+    if version.nil?
+      error "You must specify the version of the package to show."
+    end
+    if arch.nil?
+      error "You must specify the architecture of the package to show."
+    end
+
+    configure_s3_client
+
+    # retrieve the existing manifests
+    manifest = Deb::S3::Manifest.retrieve(options[:codename], component, arch,
+                                          options[:cache_control])
+    package = manifest.packages.detect { |p|
+      p.name == package_name && p.full_version == version
+    }
+    if package.nil?
+      error "No such package found."
+    end
+
+    puts package.generate
+  end
+
+  desc "copy PACKAGE TO_CODENAME TO_COMPONENT ",
+    "Copy the package named PACKAGE to given codename and component. If --versions is not specified, copy all versions of PACKAGE. Otherwise, only the specified versions will be copied. Source codename and component is given by --codename and --component options."
+
+  option :cache_control,
+  :type     => :string,
+  :aliases  => "-C",
+  :desc     => "Add cache-control headers to S3 objects"
+
+  option :arch,
+    :type     => :string,
+    :aliases  => "-a",
+    :desc     => "The architecture of the package in the APT repository."
+
+  option :versions,
+    :default  => nil,
+    :type     => :array,
+    :desc     => "The space-delimited versions of PACKAGE to delete. If not" +
+    "specified, ALL VERSIONS will be deleted. Fair warning." +
+    "E.g. --versions \"0.1 0.2 0.3\""
+
+  option :preserve_versions,
+    :default  => false,
+    :type     => :boolean,
+    :aliases  => "-p",
+    :desc     => "Whether to preserve other versions of a package " +
+    "in the repository when uploading one."
+
+  def copy(package_name, to_codename, to_component)
+    if package_name.nil?
+      error "You must specify a package name."
+    end
+    if to_codename.nil?
+      error "You must specify a codename to copy to."
+    end
+    if to_component.nil?
+      error "You must specify a component to copy to."
+    end
+
+    arch = options[:arch]
+    if arch.nil?
+      error "You must specify the architecture of the package to copy."
+    end
+
+    versions = options[:versions]
+    if versions.nil?
+      warn "===> WARNING: Copying all versions of #{package_name}"
+    else
+      log "Versions to copy: #{versions.join(', ')}"
+    end
+
+    configure_s3_client
+
+    # retrieve the existing manifests
+    log "Retrieving existing manifests"
+    from_manifest = Deb::S3::Manifest.retrieve(options[:codename],
+                                               component, arch,
+                                               options[:cache_control])
+    to_release = Deb::S3::Release.retrieve(to_codename)
+    to_manifest = Deb::S3::Manifest.retrieve(to_codename, to_component, arch,
+                                             options[:cache_control])
+    packages = from_manifest.packages.select { |p|
+      p.name == package_name &&
+        (versions.nil? || versions.include?(p.full_version))
+    }
+    if packages.size == 0
+      error "No packages found in repository."
+    end
+
+    packages.each do |package|
+      to_manifest.add package, options[:preserve_versions], false
+    end
+
+    to_manifest.write_to_s3 { |f| sublog("Transferring #{f}") }
+    to_release.update_manifest(to_manifest)
+    to_release.write_to_s3 { |f| sublog("Transferring #{f}") }
+
+    log "Copy complete."
+  end
+
+  desc "delete PACKAGE",
+    "Remove the package named PACKAGE. If --versions is not specified, delete" +
+    "all versions of PACKAGE. Otherwise, only the specified versions will be " +
+    "deleted."
+
+  option :arch,
+    :type     => :string,
+    :aliases  => "-a",
+    :desc     => "The architecture of the package in the APT repository."
+
+  option :versions,
+    :default  => nil,
+    :type     => :array,
+    :desc     => "The space-delimited versions of PACKAGE to delete. If not" +
+    "specified, ALL VERSIONS will be deleted. Fair warning." +
+    "E.g. --versions \"0.1 0.2 0.3\""
+
+  def delete(package)
+    if package.nil?
+      error("You must specify a package name.")
+    end
+
+    versions = options[:versions]
+    if versions.nil?
+      warn("===> WARNING: Deleting all versions of #{package}")
+    else
+      log("Versions to delete: #{versions.join(', ')}")
+    end
+
+    arch = options[:arch]
+    if arch.nil?
+      error("You must specify the architecture of the package to remove.")
+    end
+
+    configure_s3_client
+
+    # retrieve the existing manifests
+    log("Retrieving existing manifests")
+    release  = Deb::S3::Release.retrieve(options[:codename], options[:origin], options[:suite])
+    manifest = Deb::S3::Manifest.retrieve(options[:codename], component, options[:arch], options[:cache_control])
+
+    deleted = manifest.delete_package(package, versions)
+    if deleted.length == 0
+        if versions.nil?
+            error("No packages were deleted. #{package} not found.")
+        else
+            error("No packages were deleted. #{package} versions #{versions.join(', ')} could not be found.")
+        end
+    else
+        deleted.each { |p|
+            sublog("Deleting #{p.name} version #{p.version}")
+        }
+    end
+
+    log("Uploading new manifests to S3")
+    manifest.write_to_s3 {|f| sublog("Transferring #{f}") }
+    release.update_manifest(manifest)
+    release.write_to_s3 {|f| sublog("Transferring #{f}") }
+
+    log("Update complete.")
+  end
+
+
+  desc "verify", "Verifies that the files in the package manifests exist"
+
+  option :fix_manifests,
+  :default  => false,
+  :type     => :boolean,
+  :aliases  => "-f",
+  :desc     => "Whether to fix problems in manifests when verifying."
+
+  def verify
+    configure_s3_client
+
+    log("Retrieving existing manifests")
+    release = Deb::S3::Release.retrieve(options[:codename], options[:origin], options[:suite])
+
+    release.architectures.each do |arch|
+      log("Checking for missing packages in: #{options[:codename]}/#{options[:component]} #{arch}")
+      manifest = Deb::S3::Manifest.retrieve(options[:codename], component,
+                                            arch, options[:cache_control])
+      missing_packages = []
+
+      manifest.packages.each do |p|
+        unless Deb::S3::Utils.s3_exists? p.url_filename_encoded
+          sublog("The following packages are missing:\n\n") if missing_packages.empty?
+          puts(p.generate)
+          puts("")
+
+          missing_packages << p
+        end
+      end
+
+      if options[:sign] || (options[:fix_manifests] && !missing_packages.empty?)
+        log("Removing #{missing_packages.length} package(s) from the manifest...")
+        missing_packages.each { |p| manifest.packages.delete(p) }
+        manifest.write_to_s3 { |f| sublog("Transferring #{f}") }
+        release.update_manifest(manifest)
+        release.write_to_s3 { |f| sublog("Transferring #{f}") }
+
+        log("Update complete.")
+      end
+    end
+  end
+
+  private
+
+  def component
+    return @component if @component
+    @component = if (section = options[:section])
+                   warn("===> WARNING: The --section/-s argument is " \
+                        "deprecated, please use --component/-m.")
+                   section
+                 else
+                   options[:component]
+                 end
+  end
+
+  def puts(*args)
+    $stdout.puts(*args) unless options[:quiet]
+  end
+
+  def log(message)
+    puts ">> #{message}" unless options[:quiet]
+  end
+
+  def sublog(message)
+    puts "   -- #{message}" unless options[:quiet]
+  end
+
+  def error(message)
+    $stderr.puts "!! #{message}" unless options[:quiet]
+    exit 1
+  end
+
+  def provider
+    access_key_id     = options[:access_key_id]
+    secret_access_key = options[:secret_access_key]
+
+    if access_key_id.nil? ^ secret_access_key.nil?
+      error("If you specify one of --access-key-id or --secret-access-key, you must specify the other.")
+    end
+
+    static_credentials = {}
+    static_credentials[:access_key_id]     = access_key_id     if access_key_id
+    static_credentials[:secret_access_key] = secret_access_key if secret_access_key
+
+    AWS::Core::CredentialProviders::DefaultProvider.new(static_credentials)
+  end
+
+  def configure_s3_client
+    error("No value provided for required options '--bucket'") unless options[:bucket]
+
+    settings = {
+      :s3_endpoint => options[:endpoint],
+      :proxy_uri   => options[:proxy_uri],
+      :use_ssl     => options[:use_ssl]
+    }
+    settings.merge!(provider.credentials)
+
+    Deb::S3::Utils.s3          = AWS::S3.new(settings)
+    Deb::S3::Utils.bucket      = options[:bucket]
+    Deb::S3::Utils.signing_key = options[:sign]
+    Deb::S3::Utils.gpg_options = options[:gpg_options]
+    Deb::S3::Utils.prefix      = options[:prefix]
+    Deb::S3::Utils.encryption  = options[:encryption]
+
+    # make sure we have a valid visibility setting
+    Deb::S3::Utils.access_policy =
+      case options[:visibility]
+      when "public"
+        :public_read
+      when "private"
+        :private
+      when "authenticated"
+        :authenticated_read
+      else
+        error("Invalid visibility setting given. Can be public, private, or authenticated.")
+      end
+  end
+end