repo-mgr 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be8fb6163c79ae7f9956b0237f390c4d7764c23ef6f4ffa24c1531a3726187e0
-  data.tar.gz: 60346b9d260718f3a03745b6c90b1fdb80c34ac62458cd999d67a2cadc7b840d
+  metadata.gz: 134dd25e2f420da28416738476d2461cfc4e41e358b9eeefd95740b12fb32b29
+  data.tar.gz: 583f3afd307e6b101df5fb316619c8636882388d93937fe8cd66200d302c03e7
 SHA512:
-  metadata.gz: 8af9d6f12205d03e88d28ed848331708a9c6313ea377fd9c9144a2a2f88070de904784cc63659a42b9f3d110775caeeea636d90953927ed645039f135873eaf9
-  data.tar.gz: 4688c21a24223d81a0b7fb1c9694a59e26cc7b125c4466aecf9a3bbc470c74619d6a2aa61f7469c9acc993c9f48ac4267fece461bc9738018bea819f5019214a
+  metadata.gz: 88e36dd2757d71c32276fa7a7c02c218a0f3dcc2c497b87264388e0ef9a9cd65308b35588ae3b967073ddb823c6bdb3310be6eb47b87f18a63de75526d6b039e
+  data.tar.gz: 0bf223130b5aee561025db95edf42322e09071767c43d2ceddaeee77317a1a808fde24f994cf9995c1e4299424e26ecda35aa0222a047bf6ef6b7ecc0d6d883d

data/README.md

@@ -9,8 +9,12 @@ Features:
  * Create/update deb/rpm repositories.
  * Add/remove packages to these repositories and automatically sign packages using GPG.
  * Repository metadata/manifest signing using GPG.
+ * Publish to remote via git.
 
-To simplify things, aptly (which, kind of obviously, manages deb repositories) uses "stable" as distribution and "main" as component.
+To simplify things:
+
+ * aptly (which, kind of obviously, manages deb repositories) uses "stable" as distribution and "main" as component.
+ * The git publisher uses the `main` branch for `sync` only.
 
 ## Install
 
@@ -35,6 +39,7 @@ repo-mgr check-depends
 | dpkg-sig   | ✔      |
 | createrepo | ✔      |
 | rpm        | ✔      |
+| git        | ✔      |
 +------------+--------+
 ```
 
@@ -48,6 +53,12 @@ For managing rpm repositories:
 
 ```bash
 sudo apt install createrepo rpm
+```
+
+For using the git publisher:
+
+```bash
+sudo apt install git
 ```
 
     n.b `createrepo` is not normally available for Debian and derrivates (including Ubuntu). This tool
@@ -65,11 +76,27 @@ repo-mgr help
 # create repo
 ## --path => a local directory where the repository is published - no remote support at the moment
 ## GPGKEYID is expected as log keyid i.e 16 hex chars
-repo-mgr upsert-repo --name foo --type deb --path path/to/foo --keyid GPGKEYID
+## --publisher - is optional i.e you can still manually publish a local repository
+repo-mgr upsert-repo --name foo --type deb --path path/to/foo --keyid GPGKEYID --publisher git
 
 # sign package, add to repository, and update local repo (includes sign repo release manifest)
 # the local repo is exported to the path indicated in upsert-repo
+# the git publisher also commits the changes as the path for upsert-repo is expected to be
+# a git repository
 repo-mgr add-pkg --repo foo --path path/to/bar_0.0.1_amd64.deb
+
+# publish the repository to a remote - for git publisher this means doing git push
+repo-mgr sync --repo foo
+```
+
+## Migrating from v0.1
+
+The package list is stored into a structure that's prone to lose the list upon re-running `upsert-repo` for `v0.1.x` of this gem. For this reason, the package list data structure has been redesigned within repo-mgr's config file.
+
+So, to migrate from this earlier version, you must run, for every repo:
+
+```bash
+repo-mgr rebuild-pkg-list --repo foo
 ```
 
-You then need to sync the repo to whatever desired target. For the time being, this isn't implemented as the main use case for this tool is publishing into a git repository which is served as GitHub page.
+This rebuilds the data structure in the new config location.

data/lib/repo_mgr/backends/deb.rb

@@ -45,7 +45,7 @@ module RepoMgr
         repo_publish repo
       end
 
-      def check_sig(pkg, allow_fail = false)
+      def check_sig(pkg, allow_fail: false)
         out, status = Open3.capture2e "dpkg-sig --verify #{pkg}"
 
         return out if status.exitstatus.zero? || allow_fail
@@ -55,7 +55,7 @@ module RepoMgr
       end
 
       def sign_pkg(repo, pkg)
-        signature = check_sig pkg, true
+        signature = check_sig pkg, allow_fail: true
 
         unless signature[-6, 5] == 'NOSIG'
           return puts "-- dpkg-sig returned:\n#{signature.first}"
@@ -73,6 +73,21 @@ module RepoMgr
         Tools.error "unable to sign #{pkg} - dpkg-sig returned:\n#{out}"
       end
 
+      def rebuild_pkg_list(repo)
+        out, status = Open3.capture2e "aptly -config=#{@aptly_config_file} "\
+          "-with-packages repo show #{repo}"
+
+        unless status.exitstatus.zero?
+          Tools.error "aptly repo show failed with with:\n#{out}"
+        end
+
+        pkgs = out.split
+        mark = pkgs.find_index 'Packages:'
+        pkgs = pkgs.drop(mark + 1)
+
+        pkgs.map { |e| "#{e}.deb" }
+      end
+
       private
 
       def init_aptly_config

data/lib/repo_mgr/backends/rpm.rb

@@ -69,6 +69,12 @@ module RepoMgr
         Tools.error "unable to sign #{pkg} - rpm --addsign returned:\n#{out}"
       end
 
+      def rebuild_pkg_list(repo)
+        Dir["#{@config.cfg_dir}/rpms/#{repo}/**/*.rpm"].map do |e|
+          File.basename e
+        end
+      end
+
       private
 
       def extract_arch(pkg)

data/lib/repo_mgr/cli.rb

@@ -8,6 +8,7 @@ require 'terminal-table'
 require_relative 'tools'
 require_relative 'config'
 require_relative 'backends'
+require_relative 'publishers'
 
 module RepoMgr
   # implements CLI interface
@@ -20,12 +21,16 @@ module RepoMgr
       %w[deb rpm]
     end
 
+    def self.publishers
+      %w[git]
+    end
+
     desc 'check-depends', 'Check dependencies'
 
     def check_depends
       rows = []
 
-      %w[aptly dpkg-sig createrepo rpm].each do |bin_dep|
+      %w[aptly dpkg-sig createrepo rpm git].each do |bin_dep|
         rows << if Tools.which bin_dep
                   [bin_dep, '✔'.green]
                 else
@@ -45,13 +50,14 @@ module RepoMgr
                   desc: 'Directory path where to build the repository'
     option :keyid, type: :string, required: true, aliases: %w[-k],
                    desc: 'GPG key id used to sign the repository metadata'
+    option :publisher, type: :string, aliases: %w[-r], enum: publishers,
+                       desc: 'Publisher used to sync repo data to remote target'
 
     def upsert_repo
       FileUtils.mkdir_p options[:path]
 
       config = Config.new
-      config.upsert_repo options[:name], options[:type], options[:path],
-                         options[:keyid]
+      config.upsert_repo options
 
       backend = Backends.load options[:type], config
       backend.add_repo options[:name]
@@ -66,12 +72,14 @@ module RepoMgr
       config = Config.new
 
       config.cfg[:repos].each do |name, repo|
-        rows << [name, repo[:type], repo[:path], repo[:keyid]]
+        rows << [name, repo[:type], repo[:path], repo[:keyid], repo[:publisher]]
       end
 
       return puts '-- No repos have been created' if rows.count.zero?
 
-      puts Terminal::Table.new headings: %w[Name Type Path KeyID], rows: rows
+      puts Terminal::Table.new(
+        headings: %w[Name Type Path KeyID Publisher], rows: rows
+      )
     end
 
     desc 'add-pkg', 'Add package to repository'
@@ -85,6 +93,12 @@ module RepoMgr
       backend.add_pkg options[:repo], options[:path]
       config.add_pkg options[:repo], options[:path]
 
+      pub_type = config.cfg[:repos][options[:repo]][:publisher]
+      if pub_type
+        publisher = Publishers.load pub_type, config
+        publisher.save options[:repo], options[:path]
+      end
+
       puts "-- Added #{File.basename(options[:path])} to "\
         "#{options[:repo]} repository"
     end
@@ -94,7 +108,7 @@ module RepoMgr
                   desc: 'The repository to list the packages from'
 
     def list_pkgs
-      packages = Config.new.cfg[:repos][options[:repo]][:packages]
+      packages = Config.new.cfg[:packages][options[:repo]]
 
       if packages.nil?
         Tools.error "#{options[:repo]} repo does not have any packages"
@@ -130,6 +144,38 @@ module RepoMgr
       puts backend.check_sig options[:path]
     end
 
+    desc 'rebuild-pkg-list', 'Rebuild package list from local pkg cache'
+    option :repo, type: :string, required: true, aliases: %w[-r],
+                  desc: 'The repository to rebuild pkg list for'
+    def rebuild_pkg_list
+      config = Config.new
+      backend = Backends.load config.cfg[:repos][options[:repo]][:type], config
+      pkgs = backend.rebuild_pkg_list options[:repo]
+
+      pkgs.each do |pkg|
+        config.add_pkg options[:repo], pkg
+      end
+
+      puts "-- Rebuilt #{options[:repo]} repo pkg list"
+    end
+
+    desc 'sync', 'Sync local repo to remote target using repo publisher'
+    option :repo, type: :string, required: true, aliases: %w[-r],
+                  desc: 'The repository to sync to remote target via publisher'
+    def sync
+      config = Config.new
+      pub_type = config.cfg[:repos][options[:repo]][:publisher]
+
+      unless pub_type
+        Tools.error "#{options[:repo]} repo does not have a publisher"
+      end
+
+      publisher = Publishers.load pub_type, config
+      publisher.sync options[:repo]
+
+      puts "-- Synchronised #{options[:repo]} using #{pub_type} publisher"
+    end
+
     private
 
     def load_backend(path)

data/lib/repo_mgr/config.rb

@@ -15,7 +15,9 @@ module RepoMgr
       FileUtils.mkdir_p @cfg_dir
 
       @cfg_file = "#{@cfg_dir}/repo-mgr.yml"
-      File.write @cfg_file, { repos: {} }.to_yaml unless File.exist? @cfg_file
+      unless File.exist? @cfg_file
+        File.write @cfg_file, { repos: {}, packages: {} }.to_yaml
+      end
 
       @cfg = YAML.load_file @cfg_file
     end
@@ -24,17 +26,24 @@ module RepoMgr
       File.write @cfg_file, @cfg.to_yaml
     end
 
-    def upsert_repo(name, type, path, keyid)
+    def upsert_repo(options)
+      name = options[:name]
+      type = options[:type]
+
       if @cfg[:repos][name] && @cfg[:repos][name][:type] != type
         Tools.error "unable to change type for #{name} repository"
       end
 
       @cfg[:repos][name] = {
         type: type,
-        path: path,
-        keyid: keyid
+        path: options[:path],
+        keyid: options[:keyid]
       }
 
+      if options[:publisher]
+        @cfg[:repos][name][:publisher] = options[:publisher]
+      end
+
       save
     end
 
@@ -43,14 +52,15 @@ module RepoMgr
         Tools.error "unable to add packages to #{repo} - repo does not exist"
       end
 
-      @cfg[:repos][repo][:packages] ||= []
+      @cfg[:packages] ||= {}
+      @cfg[:packages][repo] ||= []
       pkg = File.basename path
 
-      if @cfg[:repos][repo][:packages].include?(pkg)
+      if @cfg[:packages][repo].include?(pkg)
         Tools.error "you already have #{pkg} in your #{repo} repo"
       end
 
-      @cfg[:repos][repo][:packages] << pkg
+      @cfg[:packages][repo] << pkg
 
       save
     end
@@ -61,9 +71,10 @@ module RepoMgr
           '- repo does not exist'
       end
 
-      @cfg[:repos][repo][:packages] ||= []
+      @cfg[:packages] ||= {}
+      @cfg[:packages][repo] ||= []
       pkg = File.basename path
-      @cfg[:repos][repo][:packages].delete pkg
+      @cfg[:packages][repo].delete pkg
 
       save
     end

data/lib/repo_mgr/publishers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: false
+
+require_relative 'publishers/git'
+
+module RepoMgr
+  # factory loader for RepoMgr::Publisher::Foo objects
+  class Publishers
+    def self.load(publisher, config)
+      @obj ||= {}
+
+      @obj[publisher] ||= Object.const_get(
+        "RepoMgr::Publisher::#{publisher.capitalize}"
+      ).new(config)
+
+      @obj[publisher]
+    end
+  end
+end

data/lib/repo_mgr/publishers/git.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: false
+
+require 'git'
+
+module RepoMgr
+  module Publisher
+    # git publisher
+    class Git
+      def initialize(config)
+        @config = config
+      end
+
+      # method invoked when the local deb/rpm repository is built
+      # for git, this requires a commit into the target git repository
+      # which is the target for deb/rpm repository export
+      def save(repo, pkg)
+        git = ::Git.open @config.cfg[:repos][repo][:path]
+        git.add(all: true)
+        git.commit "Add #{File.basename(pkg)}."
+      end
+
+      # method invoked when the local deb/rpm repository is published
+      # for git, this is pushing to a remote
+      def sync(repo)
+        git = ::Git.open @config.cfg[:repos][repo][:path]
+        git.push(git.remote('origin'), 'main')
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repo-mgr
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ștefan Rusu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-17 00:00:00.000000000 Z
+date: 2021-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
 - !ruby/object:Gem::Dependency
   name: gpgme
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +154,8 @@ files:
 - lib/repo_mgr/backends/rpm.rb
 - lib/repo_mgr/cli.rb
 - lib/repo_mgr/config.rb
+- lib/repo_mgr/publishers.rb
+- lib/repo_mgr/publishers/git.rb
 - lib/repo_mgr/tools.rb
 homepage: https://github.com/mr-staker/repo-mgr
 licenses: