revision 1.5.3 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0aeac36b67440a0670c7b89fc3602ae9bfda2bc43add4f6ac3dbb44c0d2d7a45
-  data.tar.gz: 4fa17d34cd367afafb0afb75343405a793ad2f732364ce36680059907d4b8f92
+  metadata.gz: d15b43ba3833b4581b97b89a7c5ba40890373b5cc85f1186f5917e9ad5d5fb21
+  data.tar.gz: badf688375adaab009a16f4e03a250cb77725fcc3d140d3b47a38d7e8436a575
 SHA512:
-  metadata.gz: 231c4a899d91b78bc32e160b382b160df9a3e09f0953b81f16101b981bcb350d0252140e9cf075c5daeba75b91b968e54e2b7d382d3e3c949eb2d0fbcc1d01cd
-  data.tar.gz: 6f63c22ed930a5a3830c89fe2902ff9ec6a9ebb01e79810bfa3690e28f25c3ae6e2f85a16d63c4c9a90a8ff6b681f1c937fd1082830381b4c9166de2f0368522
+  metadata.gz: 33dea1ba91f478dc674d9c5b3f23f875b9ca192f9a3efa2a27f2e0e33b39a119ffb367353dd17e7b3ecb4ce17df64747b0edef415ea66eb9a1fe8604fae73378
+  data.tar.gz: 7c386e43dd4f3979462f0e0d4c1ca6ae29409f042d5239f5b1434ba7bb8ef4836d5ca70b0786bf86e0b83a4102191f60f4f23df883341c67a0fcd2b851f4d5d7

data/.gitignore

@@ -13,3 +13,5 @@ Gemfile.lock
 
 README.html
 *.zip
+test-output
+*.md5

data/README.org

@@ -23,7 +23,7 @@
 # or alternatively #+SETUPFILE: theme-readtheorg.setup
 
 * Overview
-This gem automates revision management for source projects. The tool is language agnostic (used for C, ruby and matlab projects, to date -- though you're probably better off using bundler for ruby projects). It supports per-project configuration using a yaml-format file called =releasables.yaml= located at the project root.
+This gem automates revision management for source projects. The tool is language agnostic (used for C, ruby, python and matlab projects, to date -- though you're probably better off using bundler for ruby projects). It supports per-project configuration using a yaml-format file called =releasables.yaml= located at the project root.
 
 It currently supports the following functionality
 - Manage 3-component revision IDs embedded natively in source file
@@ -31,9 +31,10 @@ It currently supports the following functionality
 - Automatically prompts for a changelog entry each time a revision identifier is incremented
 - Optionally commits and tags changes to a git repo after an update to the revision ID
 - Builds and archives projects in zip format (including release notes and arbitrary release artefacts defined
-- Deploys
+- Deploys build artefacts to one or more defined (local or remote) filesystem locations
+- Automatically generates md5sums when archiving or deploying build artefacts
 
-Worked on sporadically to allow me to tag, archive and deploy projects in multiple languages in a consistent fashion.
+Hacked on sporadically to allow me to tag, archive and deploy projects in multiple languages in a consistent fashion.
 
 * Installation
 ** Dependencies
@@ -101,7 +102,7 @@ Run the executable with no arguments to get usage instructions in your console w
 
 #+RESULTS:
 #+begin_example
-Loading releasable definitions from /home/cormacc/dev/gem/revision/releasables.yaml ...
+Loading releasable definitions from /home/cormacc/nmd/gem/revision/releasables.yaml ...
 Commands:
   revision --version, -v   # print the version
   revision archive         # Archive releasable(s)
@@ -111,6 +112,7 @@ Commands:
   revision help [COMMAND]  # Describe available commands or one specific command
   revision info            # Display info for all defined releasables
   revision major           # Increment major revision index
+  revision md5             # Compute md5sums for current build artefacts
   revision minor           # Increment minor revision index
   revision package         # Build and archive releasables
   revision patch           # Increment patch revision index
@@ -166,36 +168,39 @@ The lines beginning with '#' are explanatory comments
 #+END_NOTE
 
 #+BEGIN_SRC yaml
-    - :id: my_releasable
-      :revision:
-        # Source file containing the revision identifier
-        # This will also include changelog entries, embedded as comments
-        :src: lib/revision/version.rb
-        # Regex matching the source revision identifier. Must contain the following named capture groups
-        # - major, minor, patch :: Numeric (uint) sequences representing the three revision ID components
-        # - sep1, sep2 :: the characters separating the revision components
-        # - prefix, postfix :: sufficient syntactic context to match the revision ID uniquely
-        # N.B. this regex matches the version ID from the standard bundler gem skeleton,
-        # e.g. VERSION = "1.1.0"
-        :regex: (?<prefix>VERSION = ")(?<major>\d+)(?<sep1>\.)(?<minor>\d+)(?<sep2>\.)(?<patch>\d+)(?<postfix>")
-        # Comment char for the project language -- prefixed to each line of changelog entries
-        # Quotes only necessary here to prevent # being interpreted as the beginning of a YAML comment
-        :comment_prefix: "#"
-        # Sequence of build steps -- each item should be a valid shell command, prefixed with the YAML sequence item token, '- '
-        :build_steps:
-          - bundle exec rake install
-          # Sequence defining the files (build artefacts) to package in the release archive.
-          # Each artefact definition must include a :src: key/value pair.
-          # An optional :dest: value may be provided to rename the file during packaging, or just (as in the first entry below)
-          # to flatten the folder structure.
-          # Any <VER> (or <REV>) in the :src: or :dest: placeholders wil be replaced with the current revision ID
-          # The revision archive will also include the revision history extracted as a text file
-          :artefacts:
-            # A binary artefact -- the
-            - :src: pkg/revision-<VER>.gem
-              :dest: revision-<VER>.gem
-              # This document -- the :dest: value defaults to duplicating :src: if not specified
-              - :src: README.org
+  :releasables
+  - :id: my_releasable
+    :revision:
+      # Source file containing the revision identifier
+      # This will also include changelog entries, embedded as comments
+      :src: lib/revision/version.rb
+      # Regex matching the source revision identifier. Must contain the following named capture groups
+      # - major, minor, patch :: Numeric (uint) sequences representing the three revision ID components
+      # - sep1, sep2 :: the characters separating the revision components
+      # - prefix, postfix :: sufficient syntactic context to match the revision ID uniquely
+      # N.B. this regex matches the version ID from the standard bundler gem skeleton,
+      # e.g. VERSION = "1.1.0"
+      :regex: (?<prefix>VERSION = ")(?<major>\d+)(?<sep1>\.)(?<minor>\d+)(?<sep2>\.)(?<patch>\d+)(?<postfix>")
+      # Comment char for the project language -- prefixed to each line of changelog entries
+      # Quotes only necessary here to prevent # being interpreted as the beginning of a YAML comment
+      :comment_prefix: "#"
+      # Sequence of build steps -- each item should be a valid shell command, prefixed with the YAML sequence item token, '- '
+      :build_steps:
+        - bundle exec rake install
+        # Sequence defining the files (build artefacts) to package in the release archive.
+        # Each artefact definition must include a :src: key/value pair.
+        # An optional :dest: value may be provided to rename the file during packaging, or just (as in the first entry below)
+        # to flatten the folder structure.
+        # Any <VER> (or <REV>) in the :src: or :dest: placeholders wil be replaced with the current revision ID
+        # The revision archive will also include the revision history extracted as a text file
+      :artefacts:
+        # A binary artefact
+        - :src: pkg/revision-<VER>.gem
+          :dest: revision-<VER>.gem
+        # ':dest:' defaults to the string specified for ':src:' if not specified explicitly
+        # md5sums are generated by default for each artefact -- the ':md5:' option allows this to be disabled per-artefact
+        - :src: README.org
+          :md5: false
 #+END_SRC
 
 **** TODO (or at least consider) add support for overridable defaults
@@ -213,32 +218,32 @@ managing some embedded C projects, and the default values reflect this.
 #+END_NOTE
 
 #+BEGIN_SRC yaml
-    :releasables:
-      - :id: mbt_cd_firmware
-        :revision:
-          :src: src/FirmwareRevision.c
-          :build_steps:
-            - make --jobs=8 -f Makefile CONF=bootloadable
-            :artefacts:
-              - :src: dist/bootloadable/production/firmware.production.hex
-                :dest: mbt_cd_firmware_v<REV>.bootloadable.hex
-                - :src: dist/default/production/firmware.production.hex
-                  :dest: mbt_cd_firmware_v<REV>.standalone.hex
+  :releasables:
+    - :id: mbt_cd_firmware
+      :revision:
+        :src: src/FirmwareRevision.c
+      :build_steps:
+        - make --jobs=8 -f Makefile CONF=bootloadable
+      :artefacts:
+        - :src: dist/bootloadable/production/firmware.production.hex
+          :dest: mbt_cd_firmware_v<REV>.bootloadable.hex
+        - :src: dist/default/production/firmware.production.hex
+          :dest: mbt_cd_firmware_v<REV>.standalone.hex
 #+END_SRC
 
 **** Ruby project
 
 #+BEGIN_SRC yaml
-    :releasables:
-      - :id: revision
-        :revision:
-          :src: lib/revision/version.rb
-          :regex: (?<prefix>VERSION = ")(?<major>\d+)(?<sep1>\.)(?<minor>\d+)(?<sep2>\.)(?<patch>\d+)(?<postfix>")
-          :comment_prefix: "#"
-          :build_steps:
-            - bundle exec rake install
-            :artefacts:
-              - :src: pkg/revision-<VER>.gem
+  :releasables:
+  - :id: revision
+    :revision:
+      :src: lib/revision/version.rb
+      :regex: (?<prefix>VERSION = ")(?<major>\d+)(?<sep1>\.)(?<minor>\d+)(?<sep2>\.)(?<patch>\d+)(?<postfix>")
+      :comment_prefix: "#"
+    :build_steps:
+      - bundle exec rake install
+    :artefacts:
+      - :src: pkg/revision-<VER>.gem
 #+END_SRC
 
 *** Heirarchical project
@@ -250,7 +255,7 @@ at that root could include them as follows...
 #+BEGIN_SRC yaml
     :releasables:
       - :folder: examples/c
-        - :folder: examples/ruby
+      - :folder: examples/ruby
 #+END_SRC
 
 **** TODO consider supporting a higher-level aggregate revision ID
@@ -260,7 +265,7 @@ at that root could include them as follows...
       :src: release_log.txt
       :releasables:
         - :folder: examples/c
-          - :folder: examples/ruby
+        - :folder: examples/ruby
 #+END_SRC
 
 * Development

data/lib/revision/cli.rb

@@ -4,6 +4,7 @@ require_relative 'releasable'
 require_relative 'info'
 require_relative 'errors'
 require_relative 'version'
+require_relative 'md5'
 
 module Revision
   class CLI < Thor
@@ -105,6 +106,21 @@ module Revision
       select_one.tag
     end
 
+    desc 'md5', 'Compute md5sums for current build artefacts'
+    method_option :file, :aliases => "-f", :type => :string, :default => nil ,:desc => "File to md5sum (defaults to build artefacts defined in yaml)"
+    def md5
+      r = select_one
+      files = options[:file].nil? ?
+                r.artefacts.select { |a| a[:md5]==true }.map { |a| a[:src] } :
+                [options[:file]]
+      raise "No files specified" unless files.length
+      puts "Calculating md5sum for files #{files}"
+      for f in files
+        md5sum = Revision::MD5.from_file(f)
+        puts "#{md5sum}"
+      end
+    end
+
     private
 
     def id_options

data/lib/revision/md5.rb

@@ -0,0 +1,51 @@
+require 'digest'
+
+class Revision::MD5
+
+  READ_CHUNK_KB = 1024
+  FILENAME_EXTENSION = "md5"
+
+  attr_reader :root, :filename
+
+  def self.from_file(filepath, filename: nil)
+    raise "File #{filepath} not found" unless File.exist?(filepath)
+    filename ||= File.basename(filepath)
+    root = File.dirname(filepath)
+    stream = File.open(filepath, 'rb')
+    new(stream, filename, root: root)
+  end
+
+  def initialize(ioreader, filename, root: nil)
+    root ||= Dir.getwd
+    @reader = ioreader
+    @root = root
+    @filename = filename
+  end
+
+  def calc
+    md5 = Digest::MD5.new
+    bytes_per_chunk = READ_CHUNK_KB*1024
+    while chunk = @reader.read(bytes_per_chunk)
+      md5 << chunk
+    end
+    md5.hexdigest
+  end
+
+  def to_s
+    <<~EOT
+    #{calc} #{@filename}
+    EOT
+  end
+
+  def md5filename
+    "#{@filename}.#{FILENAME_EXTENSION}"
+  end
+
+  def write(filepath: nil)
+    filepath ||= File.join(@root, md5filename)
+    filename = File.basename(filepath)
+    File.open(filepath, "w") { |f| f.write "#{calc} #{filename}" }
+    filepath
+  end
+
+end

data/lib/revision/releasable.rb

@@ -68,7 +68,8 @@ module Revision
       # Legacy definition syntax compatibility
       @build_def = config[:build] ? config[:build] : { environment: { variables: {}}, steps: config[:build_steps]}
       @artefacts = config[:artefacts] || []
-      @artefacts.each { |a| a[:dest] ||= a[:src] } unless @artefacts.nil? || @artefacts.empty?
+      @artefacts.each { |a| a[:dest] ||= File.basename(a[:src]) } unless @artefacts.nil? || @artefacts.empty?
+      # @artefacts.each { |a| a[:md5] = true if a[:md5].nil? } unless @artefacts.nil? || @artefacts.empty?
       @config = config
     end
 
@@ -187,46 +188,61 @@ module Revision
       "#{@id}_revision_history_v#{@revision}.txt"
     end
 
-    def artefact_map(dest_prefix = '')
-      amap = {}
-      @artefacts.each_with_index do |a, index|
-        src = a[:src].gsub(REVISION_PLACEHOLDER, @revision.to_s)
-        dest = a[:dest].gsub(REVISION_PLACEHOLDER, @revision.to_s)
-        if Gem.win_platform? && !src.end_with?('.exe') && File.exist?(File.join(@root, src + '.exe'))
-          puts "... windows platform -- appending '.exe' (#{src})"
-          src += '.exe'
-          dest += '.exe' unless dest.end_with?('.exe')
-        end
-        src = File.join(@root,src)
-        dest = dest_prefix.empty? ? dest : File.join(dest_prefix, dest)
-        amap[src] = dest
+    def interp_rev(string)
+      string.gsub(REVISION_PLACEHOLDER, @revision.to_s)
+    end
+
+    def normalise_artefact(a)
+      src_norm = interp_rev(a[:src])
+      a_norm = {
+        src: src_norm,
+        dest: a[:dest].nil? ? File.basename(src_norm) : interp_rev(a[:dest]),
+        md5: a[:md5].nil? ? true : a[:md5]
+      }
+      if Gem.win_platform? && !a_norm[:src].end_with?('.exe') && File.exist?(File.join(@root, a_norm[:src] + '.exe'))
+        puts "... windows platform -- appending '.exe' ('#{a_norm[:src]}' -> '#{a_norm[src]}.exe')"
+        a_norm[:src] += '.exe'
+        a_norm[:dest] += '.exe' unless a_norm[:dest].end_with?('.exe')
       end
-      amap
+      a_norm
+    end
+
+    def artefacts
+      @artefacts.map { |a| normalise_artefact(a)}
     end
 
     def archive
       puts "Archiving #{@artefacts.length} build artefacts as #{archive_name}..."
-      amap = artefact_map
       if File.exist?(archive_name)
         puts "... deleting existing archive"
         File.delete(archive_name)
       end
       Zip::File.open(archive_name, Zip::File::CREATE) do |zipfile|
-        amap.each.with_index(1) do |entry, idx|
-          src, dest = entry
-          #TODO: Add directory processing....
-          puts "... (#{idx}/#{amap.length}) #{src} => #{dest}"
-          zipfile.add(dest, src)
+        zip_entries = artefacts
+        zip_entries.each.with_index(1) do |a, idx|
+          puts "... (#{idx}/#{zip_entries.length}) #{a[:dest]} :: <= #{a[:src]}"
+          zipfile.add(a[:dest], a[:src])
+          if a[:md5]
+            md5name = "#{a[:dest]}.md5"
+            puts "... (#{idx}/#{zip_entries.length}) #{a[:dest]} :: embedding md5sum (#{md5name})"
+            zipfile.get_output_stream(md5name) { |os| os.write("#{MD5.from_file(a[:src])}")}
+          else
+            puts "... (#{idx}/#{zip_entries.length}) #{a[:dest]} :: no md5sum required"
+          end
         end
         puts "... embedding revision history as #{changelog_name} "
         zipfile.get_output_stream(changelog_name) { |os| output_changelog(os)}
       end
+      archive_md5 = MD5.from_file(archive_name)
+      puts "... generating archive md5sum as #{archive_md5.md5filename} "
+      archive_md5.write
 
       if @config.dig(:archive)
         archive_root = File.expand_path(@config[:archive])
         puts "... moving #{archive_name} to #{archive_root}"
         FileUtils.mkdir_p(archive_root)
         FileUtils.mv(archive_name, archive_root)
+        FileUtils.mv(archive_md5.md5filename, archive_root)
       end
     end
 
@@ -244,12 +260,6 @@ module Revision
 
       raise Errors::NotSpecified.new(':deploy') if destinations.empty?
 
-      #... Eliminated global deployment pre/post functions.
-      #... if applicable to all dests, the logic should probably be a build step...
-      # if @config.dig(:deploy, :pre)
-      #   exec_pipeline('deploy (pre)', @config[:deploy][:pre])
-      # end
-
       destinations.each do |d|
         destination = File.expand_path(d[:dest])
 
@@ -257,21 +267,23 @@ module Revision
           exec_pipeline('deploy (pre / #{d[:dest]})', d[:pre])
         end
 
-        puts "Deploying #{@artefacts.length} build artefacts to #{destination}..."
+        puts "Deploying #{artefacts.length} build artefacts to #{destination}..."
         if not File.exist?(destination)
           puts "... folder not found -> creating ... '#{destination}'"
           FileUtils.mkdir_p(destination)
         end
-        amap = artefact_map(destination)
-        amap.each.with_index(1) do |entry, idx|
-          src, dest = entry
-          puts "... (#{idx}/#{amap.length}) #{src} => #{dest}"
+        artefacts.each.with_index(1) do |a, idx|
+          # src, dest = entry
+          src = File.join(@root,a[:src])
+          dest = destination.empty? ? a[:dest] : File.join(destination, a[:dest])
+          puts "... (#{idx}/#{artefacts.length}) #{src} => #{dest}"
           if File.exist?(dest)
             puts "... deleting existing '#{dest}' ..."
             FileUtils.rm_rf(dest)
           end
-          puts "... deploying '#{src}' -> '#{dest}"
+          puts "... deploying '#{src}' -> '#{dest}'"
           FileUtils.cp_r(src,dest)
+          puts "... writing md5sum for '#{dest}' to '#{MD5.from_file(dest).write}'" if a[:md5]
         end
         File.open(File.join(destination,changelog_name),'w') { |f| output_changelog(f)}
 
@@ -280,9 +292,6 @@ module Revision
         end
       end
 
-      # if @config.dig(:deploy, :post)
-      #   exec_pipeline('deploy (post)', @config[:deploy][:post])
-      # end
     end
 
     def package

data/lib/revision/version.rb

@@ -1,10 +1,13 @@
 # Defines the revision ID for the revision gem
 module Revision
-  VERSION = "1.5.3".freeze
+  VERSION = "1.6.0".freeze
 end
 
 # <BEGIN CHANGELOG>
 #
+# Version 1.6.0 (01 Dec 2021)
+# - New feature: Automated MD5sum generation during 'archive' and 'deploy' tasks
+#
 # Version 1.5.3 (26 Oct 2021)
 # - Multiple deployment destinations bugfix -- only last destination was being used.
 #

data/releasables.yaml

@@ -5,6 +5,17 @@
       :regex: (?<prefix>VERSION = ")(?<major>\d+)(?<sep1>\.)(?<minor>\d+)(?<sep2>\.)(?<patch>\d+)(?<postfix>".freeze)
       :comment_prefix: "#"
     :build_steps:
+      - mkdir -p test-output/2
       - bundle exec rake install
+    #Define 3 build artefacts as test cases for 'deploy' and 'archive' tasks
+    #Expect MD5 file to be generated by default for first entry (where not specified explicitly)
     :artefacts:
       - :src: pkg/revision-<VER>.gem
+      - :src: README.org
+        :md5: false
+      - :src: Rakefile
+        :md5: true
+    #Define two deployment destinations to verify multiple deployments work as intended
+    :deploy:
+      - :dest: ./test-output
+      - :dest: ./test-output/2

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: revision
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 1.6.0
 platform: ruby
 authors:
 - Cormac Cannon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -201,6 +201,7 @@ files:
 - lib/revision/cli.rb
 - lib/revision/errors.rb
 - lib/revision/info.rb
+- lib/revision/md5.rb
 - lib/revision/releasable.rb
 - lib/revision/string_case.rb
 - lib/revision/version.rb