aptly 0.1.0

data/lib/aptly/repo.rb

@@ -0,0 +1,255 @@
+module Aptly
+  extend self
+
+  # Creates a new repository in aptly
+  #
+  # == Parameters:
+  # name::
+  #   The name to use for the new repository
+  # dist::
+  #   The distribution used during publishing
+  # comment::
+  #   A comment describing the repository
+  # component::
+  #   The component used during publishing
+  #
+  # == Returns:
+  # An Aptly::Repo object
+  #
+  def create_repo name, kwargs={}
+    dist = kwargs.arg :dist, ''
+    comment = kwargs.arg :comment, ''
+    component = kwargs.arg :component, 'main'
+    if list_repos.include? name
+      raise AptlyError.new("Repo '#{name}' already exists")
+    end
+
+    cmd = "aptly repo create"
+    cmd += " -comment=#{comment.quote}" if !comment.empty?
+    cmd += " -distribution=#{dist.quote}" if !dist.empty?
+    cmd += " #{name}"
+
+    runcmd cmd
+    return Repo.new name
+  end
+
+  # Return a list of existing repositories
+  #
+  # == Returns
+  # An array of strings representing repository names
+  #
+  def list_repos
+    out = runcmd 'aptly repo list'
+    parse_list out.lines
+  end
+
+  # Retrieve information about a repository
+  #
+  # == Parameters:
+  # name::
+  #   The name of the repository to retrieve information for
+  #
+  # == Returns:
+  # A hash of repository information
+  #
+  def repo_info name
+    out = runcmd "aptly repo show #{name.quote}"
+    parse_info out.lines
+  end
+
+  class Repo
+    attr_accessor :name, :dist, :component
+    attr_accessor :comment, :num_packages, :archlist
+
+    @name = ''
+    @dist = ''
+    @component = ''
+    @comment = ''
+    @num_packages = 0
+
+    # Instantiates an Aptly::Repo object
+    #
+    # == Parameters:
+    # name::
+    #   The name of the repository
+    #
+    # == Returns:
+    # An Aptly::Repo object
+    #
+    def initialize name
+      if !Aptly::list_repos.include? name
+        raise AptlyError.new "Repo '#{name}' does not exist"
+      end
+
+      info = Aptly::repo_info name
+      @name = info['Name']
+      @comment = info['Comment']
+      @dist = info['Default Distribution']
+      @component = info['Default Component']
+      @num_packages = info['Number of packages'].to_i
+    end
+
+    # Drops an existing aptly repository
+    def drop
+      Aptly::runcmd "aptly repo drop #{@name.quote}"
+    end
+
+    # List all packages contained in a repository
+    #
+    # == Returns:
+    # An array of packages
+    #
+    def list_packages
+      res = []
+      out = Aptly::runcmd "aptly repo show -with-packages #{@name.quote}"
+      Aptly::parse_indented_list out.lines
+    end
+
+    # Add debian packages to a repo
+    #
+    # == Parameters:
+    # path::
+    #   The path to the file or directory source
+    # remove_files::
+    #   When true, deletes source after import
+    #
+    def add path, kwargs={}
+      remove_files = kwargs.arg :remove_files, false
+
+      cmd = 'aptly repo add'
+      cmd += ' -remove-files' if remove_files
+      cmd += " #{@name.quote} #{path}"
+
+      Aptly::runcmd cmd
+    end
+
+    # Imports package resources from existing mirrors
+    #
+    # == Parameters:
+    # from_mirror::
+    #   The name of the mirror to import from
+    # packages::
+    #   A list of debian pkg_spec strings (e.g. "libc6 (>= 2.7-1)")
+    # deps::
+    #   When true, follows package dependencies and adds them
+    #
+    def import from_mirror, kwargs={}
+      deps = kwargs.arg :deps, false
+      packages = kwargs.arg :packages, []
+
+      if packages.length == 0
+        raise AptlyError.new '1 or more packages are required'
+      end
+
+      cmd = 'aptly repo import'
+      cmd += ' -with-deps' if deps
+      cmd += " #{from_mirror.quote} #{@name.quote}"
+      packages.each {|p| cmd += " #{p.quote}"}
+
+      Aptly::runcmd cmd
+    end
+
+    # Copy package resources from one repository to another
+    #
+    # == Parameters:
+    # from_repo::
+    #   The source repository name
+    # to_repo::
+    #   The destination repository name
+    # pkg_spec::
+    #   A debian pkg_spec string
+    # deps::
+    #   When true, follow deps and copy them
+    #
+    def copy from_repo, to_repo, pkg_spec, kwargs={}
+      deps = kwargs.arg :deps, false
+
+      cmd = 'aptly repo copy'
+      cmd += ' -with-deps' if deps
+      cmd += " #{from_repo.quote} #{to_repo.quote} #{pkg_spec.quote}"
+
+      Aptly::runcmd cmd
+    end
+    private :copy
+
+    # Shortcut method to copy resources in from another repository
+    def copy_from from_repo, pkg_spec, kwargs={}
+      deps = kwargs.arg :deps, false
+      copy from_repo, @name, pkg_spec, :deps => deps
+    end
+
+    # Shortcut method to copy resources out to another repository
+    def copy_to to_repo, pkg_spec, kwargs={}
+      deps = kwargs.arg :deps, false
+      copy @name, to_repo, pkg_spec, :deps => deps
+    end
+
+    # Move package resources from one repository to another
+    #
+    # == Parameters:
+    # from_repo::
+    #   The source repository name
+    # to_repo::
+    #   The destination repository name
+    # pkg_spec::
+    #   A debian pkg_spec string
+    # deps::
+    #   When true, follow deps and move them too
+    #
+    def move from_repo, to_repo, pkg_spec, kwargs={}
+      deps = kwargs.arg :deps, false
+
+      cmd = 'aptly repo move'
+      cmd += ' -with-deps' if deps
+      cmd += " #{from_repo.quote} #{to_repo.quote} #{pkg_spec.quote}"
+
+      Aptly::runcmd cmd
+    end
+    private :move
+
+    # Shortcut method to move packages in from another repo
+    def move_from from_repo, pkg_spec, kwargs={}
+      deps = kwargs.arg :deps, false
+      move from_repo, @name, pkg_spec, :deps => deps
+    end
+
+    # Shortcut method to move packages out to another repository
+    def move_to to_repo, pkg_spec, kwargs={}
+      deps = kwargs.arg :deps, false
+      move @name, to_repo, pkg_spec, :deps => deps
+    end
+
+    # Remove packages selectively from a repository
+    #
+    # == Parameters:
+    # pkg_spec::
+    #   A debian pkg_spec string to select packages by
+    #
+    def remove pkg_spec
+      Aptly::runcmd "aptly repo remove #{@name.quote} #{pkg_spec.quote}"
+    end
+
+    # Shortcut method to snapshot an Aptly::Repo object
+    def snapshot name
+      Aptly::create_repo_snapshot name, @name
+    end
+
+    # Shortcut method to publish a repo from an Aptly::Repo instance.
+    def publish args
+      Aptly::publish 'repo', @name, args
+    end
+
+    # save allows you to modify the repository distribution, comment, or
+    # component string by using the attr_accessor's, and then calling this
+    # method to persist them to aptly.
+    def save
+      cmd = "aptly repo edit"
+      cmd += " -distribution=#{@dist.quote}"
+      cmd += " -comment=#{@comment.quote}"
+      cmd += " -component=#{@component.quote}"
+      cmd += " #{@name.quote}"
+
+      Aptly::runcmd cmd
+    end
+  end
+end

data/lib/aptly/snapshot.rb

@@ -0,0 +1,270 @@
+module Aptly
+  extend self
+
+  # Create a new snapshot of a repo or mirror
+  #
+  # == Parameters:
+  # name::
+  #   The name for the new snapshot
+  # type::
+  #   The type of snapshot. "mirror" and "repo" are supported.
+  # resource_name::
+  #   The name of the mirror or repo
+  #
+  # == Returns:
+  # An Aptly::Snapshot object
+  #
+  def create_snapshot name, type, kwargs={}
+    resource_name = kwargs.arg :resource_name, ''
+
+    if type != 'mirror' && type != 'repo' && type != 'empty'
+      raise AptlyError.new "Invalid snapshot type: #{type}"
+    end
+
+    if list_snapshots.include? name
+      raise AptlyError.new "Snapshot '#{name}' exists"
+    end
+
+    if type == 'mirror' && !list_mirrors.include?(resource_name)
+      raise AptlyError.new "Mirror '#{resource_name}' does not exist"
+    end
+
+    if type == 'repo' && !list_repos.include?(resource_name)
+      raise AptlyError.new "Repo '#{resource_name}' does not exist"
+    end
+
+    cmd = 'aptly snapshot create'
+    cmd += " #{name.quote}"
+    if type == 'empty'
+      cmd += ' empty'
+    else
+      cmd += " from #{type} #{resource_name.quote}"
+    end
+
+    runcmd cmd
+    Snapshot.new name
+  end
+  private :create_snapshot
+
+  # Shortcut method to create a snapshot from a mirror
+  def create_mirror_snapshot name, mirror_name
+    create_snapshot name, 'mirror', :resource_name => mirror_name
+  end
+
+  # Shortcut method to create a snapshot from a repo
+  def create_repo_snapshot name, repo_name
+    create_snapshot name, 'repo', :resource_name => repo_name
+  end
+
+  # Shortcut method to create an empty snapshot
+  def create_empty_snapshot name
+    create_snapshot name, 'empty'
+  end
+
+  # List existing snapshots
+  #
+  # == Returns:
+  # A list of snapshot names
+  #
+  def list_snapshots
+    out = runcmd 'aptly snapshot list'
+    parse_list out.lines
+  end
+
+  # Retrieves information about a snapshot
+  #
+  # == Parameters:
+  # name::
+  #   The name of the snapshot to gather information about
+  #
+  # == Returns:
+  # A hash of snapshot information
+  #
+  def snapshot_info name
+    out = runcmd "aptly snapshot show #{name.quote}"
+    parse_info out.lines
+  end
+
+  # Merge snapshots into a single snapshot. This will create a new snapshot
+  # containing packages from all source snapshots. By default, packages with
+  # the same name-architecture pair are merged from right-over-left, meaning
+  # packages in the last source snapshot may overwrite the same packages in
+  # the first source snapshot if their name-architecture pairs match.
+  #
+  # == Parameters:
+  # dest::
+  #   The destination snapshot name (will be created)
+  # sources::
+  #   The names of source repositories. The order in which these are passed
+  #   matters unless `-latest` is not passed.
+  # latest::
+  #   When true, only the latest of each package will be copied into the
+  #   new snapshot, following a "latest wins" approach.
+  #
+  # == Returns:
+  # An Aptly::Snapshot object for the new snapshot
+  #
+  def merge_snapshots dest, kwargs={}
+    sources = kwargs.arg :sources, []
+    latest = kwargs.arg :latest, false
+
+    if sources.length == 0
+      raise AptlyError.new '1 or more sources are required'
+    end
+
+    if list_snapshots.include? dest
+      raise AptlyError.new "Snapshot '#{dest}' exists"
+    end
+
+    cmd = 'aptly snapshot merge'
+    cmd += ' -latest' if latest
+    cmd += " #{dest.quote}"
+    cmd += " #{sources.join(' ')}"
+
+    runcmd cmd
+    Aptly::Snapshot.new dest
+  end
+
+  class Snapshot
+    attr_accessor :name, :created_at, :description, :num_packages
+
+    @name = ''
+    @created_at = ''
+    @description = ''
+    @num_packages = 0
+
+    # Instantiates a new Aptly::Snapshot instance
+    #
+    # == Parameters:
+    # name::
+    #   The name of the snapshot
+    #
+    # == Returns:
+    # An Aptly::Snapshot instance
+    #
+    def initialize name
+      if !Aptly::list_snapshots.include? name
+        raise AptlyError.new("Snapshot '#{name}' does not exist")
+      end
+
+      info = Aptly::snapshot_info name
+      @name = info['Name']
+      @created_at = info['Created At']
+      @description = info['Description']
+      @num_packages = info['Number of packages'].to_i
+    end
+
+    # Drops an existing snapshot
+    #
+    # == Parameters:
+    # force::
+    #   When true, drops a snapshot regardless of relationships
+    #
+    def drop kwargs={}
+      force = kwargs.arg :force, false
+
+      cmd = 'aptly snapshot drop'
+      cmd += ' -force' if force
+      cmd += " #{@name.quote}"
+
+      Aptly::runcmd cmd
+    end
+
+    # List all packages contained in a snapshot
+    #
+    # == Returns:
+    # An array of packages
+    #
+    def list_packages
+      res = []
+      out = Aptly::runcmd "aptly snapshot show -with-packages #{@name.quote}"
+      Aptly::parse_indented_list out.lines
+    end
+
+    # Pull packages from a snapshot into another, creating a new snapshot.
+    #
+    #  == Parameters:
+    # name::
+    #   The name of the snapshot to pull to
+    # source::
+    #   The repository containing the packages to pull in
+    # dest::
+    #   The name for the new snapshot which will be created
+    # packages::
+    #   An array of package names to search
+    # deps::
+    #   When true, process dependencies
+    # remove::
+    #   When true, removes package versions not found in source
+    #
+    def pull name, source, dest, kwargs={}
+      packages = kwargs.arg :packages, []
+      deps = kwargs.arg :deps, true
+      remove = kwargs.arg :remove, true
+
+      if packages.length == 0
+        raise AptlyError.new "1 or more package names are required"
+      end
+
+      cmd = 'aptly snapshot pull'
+      cmd += ' -no-deps' if !deps
+      cmd += ' -no-remove' if !remove
+      cmd += " #{name.quote} #{source.quote} #{dest.quote}"
+      if !packages.empty?
+        packages.each {|p| cmd += " #{p.quote}"}
+      end
+
+      Aptly::runcmd cmd
+      Aptly::Snapshot.new dest
+    end
+    private :pull
+
+    # Shortcut method to pull packages to the current snapshot
+    def pull_from source, dest, kwargs={}
+      packages = kwargs.arg :packages, []
+      deps = kwargs.arg :deps, true
+      remove = kwargs.arg :remove, true
+
+      pull @name, source, dest, :packages => packages, :deps => deps, :remove => remove
+    end
+
+    # Shortcut method to push packages from the current snapshot
+    def push_to dest, source, kwargs={}
+      packages = kwargs.arg :packages, []
+      deps = kwargs.arg :deps, true
+      remove = kwargs.arg :remove, true
+
+      pull source, @name, dest, :packages => packages, :deps => deps, :remove => remove
+    end
+
+    # Verifies an existing snapshot is able to resolve dependencies. This method
+    # currently only returns true/false status.
+    #
+    # == Parameters:
+    # sources::
+    #   Additional snapshot sources to be considered during verification
+    # follow_source::
+    #   When true, verify all source packages as well
+    #
+    # == Returns:
+    # An array containing any missing deps. Empty list means all verified.
+    #
+    def verify kwargs={}
+      sources = kwargs.arg :sources, []
+      follow_source = kwargs.arg :follow_source, false
+
+      cmd = 'aptly snapshot verify'
+      cmd += ' -dep-follow-source' if follow_source
+      cmd += " #{@name.quote}"
+      cmd += " #{sources.join(' ')}" if !sources.empty?
+
+      out = Aptly::runcmd cmd
+      Aptly::parse_indented_list out
+    end
+
+    # Shortcut method to publish a snapshot from an Aptly::Snapshot instance.
+    def publish args
+      Aptly::publish 'snapshot', @name, args
+    end
+  end
+end