Refactor Appcast

- add support for additional CLI options
- add copy_to_release rake task

Author: digitalmoksha

lib/motion-sparkle-sandbox/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MotionSparkleSandbox
-  VERSION = '2.1.0'
+  VERSION = '2.1.1'
 end

lib/motion/project/appcast.rb

@@ -10,6 +10,7 @@ class Config
       def sparkle(&block)
         @sparkle ||= Motion::Project::Sparkle.new(self)
         @sparkle.instance_eval(&block) if block
+        @sparkle.after_initialize
         @sparkle
       end
     end

lib/motion/project/project.rb

@@ -1,17 +1,23 @@
 # frozen_string_literal: true
 
 # Sparkle specific rake tasks
+# rubocop:disable Metrics/BlockLength
 namespace :sparkle do
   desc 'Sparkle Help'
   task :help do
     puts <<~HELP
+
+
       During initial Sparkle setup, run these rake tasks:
 
       1. `rake sparkle:setup_certificates`
       2. `rake sparkle:setup`
 
       Then after running `rake build:release`, you can run
-      `rake sparkle:package`
+
+      3. `rake sparkle:package`            create the zipped package and release notes
+      4. `rake sparkle:copy_to_release`    copy package/notes into release folder
+      5. `rake sparkle:generate_appcast`   generate the appcast
     HELP
   end
 
@@ -40,6 +46,13 @@
     sparkle.sign_package
   end
 
+  desc 'Copy the release notes and zip archive to the release folder'
+  task :copy_to_release do
+    App.config_without_setup.build_mode = :release
+    sparkle = App.config.sparkle
+    sparkle.copy_to_release
+  end
+
   desc "Generate the appcast xml feed using Sparkle's `generate_appcast`"
   task :generate_appcast do
     App.config_without_setup.build_mode = :release
@@ -83,3 +96,4 @@
     end
   end
 end
+# rubocop:enable Metrics/BlockLength

lib/motion/project/rake_tasks.rb

@@ -27,7 +27,7 @@ def check_feed_url
       end
 
       def check_public_key
-        return true if public_EdDSA_key.present?
+        return true if public_ed_dsa_key.present?
 
         App.fail 'Sparkle :public_key is nil or blank. Please check your Rakefile.'
       end
@@ -45,7 +45,7 @@ def certificates_ok?(silence = false)
           App.fail "Missing `#{private_key_path}`. Please run `rake sparkle:setup_certificates` or check the docs to know where to put them."
         end
 
-        unless public_EdDSA_key.present?
+        unless public_ed_dsa_key.present?
           return false if silence
 
           App.fail "Missing `#{public_key_path}`. Did you configure `release :public_key` correctly in the Rakefile? Advanced: recreate your public key with `rake sparkle:recreate_public_key`"

lib/motion/project/setup.rb

@@ -15,29 +15,22 @@ def initialize(config)
         # verify_installation
       end
 
+      def after_initialize
+        self.feed_url = appcast.feed_url
+      end
+
       def appcast
-        @appcast ||= Appcast.new
+        @appcast ||= Appcast.new(self)
       end
 
       def publish(key, value)
+        return if appcast.process_option(key, value)
+
         case key
         when :public_key
-          self.public_EdDSA_key = value
-        when :base_url
-          appcast.base_url = value
-          self.feed_url = appcast.feed_url
-        when :feed_base_url
-          appcast.feed_base_url = value
-          self.feed_url = appcast.feed_url
-        when :feed_filename
-          appcast.feed_filename = value
-          self.feed_url = appcast.feed_url
+          self.public_ed_dsa_key = value
         when :version
-          version value
-        when :package_base_url, :package_filename, :notes_base_url, :notes_filename, :use_exported_private_key
-          appcast.send "#{key}=", value
-        when :archive_folder
-          appcast.archive_folder = value
+          version(value)
         else
           raise "Unknown Sparkle config option #{key}"
         end
@@ -61,15 +54,13 @@ def feed_url=(url)
         @config.info_plist['SUFeedURL'] = url
       end
 
-      # rubocop:disable Naming/MethodName
-      def public_EdDSA_key
+      def public_ed_dsa_key
         @config.info_plist['SUPublicEDKey']
       end
 
-      def public_EdDSA_key=(key)
+      def public_ed_dsa_key=(key)
         @config.info_plist['SUPublicEDKey'] = key
       end
-      # rubocop:enable Naming/MethodName
 
       # File manipulation and certificates
 
@@ -109,7 +100,7 @@ def generate_keys
 
         if appcast.use_exported_private_key && File.exist?(private_key_path)
           App.info 'Sparkle', "Private key already exported at `#{private_key_path}` and will be used."
-          if public_EdDSA_key.present?
+          if public_ed_dsa_key.present?
             App.info '', <<~EXISTS
               SUPublicEDKey already set
 
@@ -139,12 +130,12 @@ def generate_keys
           return
         end
 
-        results, status = Open3.capture2e(generate_keys_app, '-p')
+        results, status = Open3.capture2e(generate_keys_app, '-p', '--account', appcast.cli_options[:account])
 
         if status.success?
-          App.info 'Sparkle', 'Public/private keys found in the keychain'
+          App.info 'Sparkle', "Public/private keys found in the keychain for account #{appcast.cli_options[:account]}"
 
-          if results.strip == public_EdDSA_key
+          if results.strip == public_ed_dsa_key
             App.info 'Sparkle', 'Keychain public key matches `SUPublicEDKey`'
 
             if appcast.use_exported_private_key && !File.exist?(private_key_path)
@@ -155,7 +146,7 @@ def generate_keys
               Keychain public key DOES NOT match `SUPublicEDKey`
 
                   Keychain public key:      #{results.strip}
-                  SUPublicEDKey public key: #{public_EdDSA_key}
+                  SUPublicEDKey public key: #{public_ed_dsa_key}
 
             NOT_MATCHED
               .indent(11, skip_first_line: true)
@@ -173,15 +164,15 @@ def generate_keys
       def create_private_key
         App.info 'Sparkle',
                  'Generating a new signing key into the Keychain. This may take a moment, depending on your machine.'
-        results, status = Open3.capture2e(generate_keys_app)
+        results, status = Open3.capture2e(generate_keys_app, '--account', appcast.cli_options[:account])
 
         App.fail 'Sparkle could not generate keys' unless status.success?
 
         puts
         puts results.lines[1..].join.indent(11)
 
         # Extract the public key so we can use it in message
-        results, status = Open3.capture2e(generate_keys_app, '-p')
+        results, status = Open3.capture2e(generate_keys_app, '-p', '--account', appcast.cli_options[:account])
 
         App.fail 'Unable to read public key' unless status.success?
 
@@ -199,7 +190,7 @@ def create_private_key
 
       # Export the private key from the keychain
       def export_private_key
-        _results, status = Open3.capture2e(generate_keys_app, '-x', private_key_path.to_s)
+        _results, status = Open3.capture2e(generate_keys_app, '-x', private_key_path.to_s, '--account', appcast.cli_options[:account])
 
         App.fail 'Unable to export private key' unless status.success?
 
@@ -216,6 +207,92 @@ def export_private_key
           .indent(11)
       end
 
+      # copy the release notes and zip archive into the releases_folder,
+      # where the appcast will get built
+      def copy_to_release
+        path = (project_path + releases_folder).realpath
+        zip_file_path = (sparkle_release_path + zip_file).realpath
+
+        [release_notes_path, zip_file_path].each do |file|
+          FileUtils.cp(file, "#{path}/")
+          App.info 'Copied', "./#{path}/#{file}"
+        end
+      end
+
+      # Generate the appcast.
+      # Note: We do not support the old DSA keys, only the newer EdDSA keys.
+      #       See https://sparkle-project.org/documentation/eddsa-migration
+      def generate_appcast
+        generate_appcast_app = "#{vendored_sparkle_path}/bin/generate_appcast"
+        path = (project_path + releases_folder).realpath
+        appcast_filename = (path + appcast.feed_filename)
+        appcast.cli_options[:output_path] = appcast_filename
+
+        FileUtils.mkdir_p(path) unless File.exist?(path)
+
+        App.info('Sparkle', "Generating appcast using `#{generate_appcast_app}`")
+        puts "from files in `#{path}`...".indent(11)
+
+        args = appcast.prepare_args
+
+        App.info 'Executing', [generate_appcast_app, *args, path.to_s].join(' ')
+
+        results, status = Open3.capture2e(generate_appcast_app, *args, path.to_s)
+
+        App.info('Sparkle', "Saved appcast to `#{appcast_filename}`") if status.success?
+        puts results.indent(11)
+
+        return unless status.success?
+
+        puts
+        puts "SUFeedURL     : #{feed_url}".indent(11)
+        puts "SUPublicEDKey : #{public_ed_dsa_key}".indent(11)
+      end
+
+      def generate_appcast_help
+        generate_appcast_app = "#{vendored_sparkle_path}/bin/generate_appcast"
+        results, _status = Open3.capture2e(generate_appcast_app, '--help')
+
+        puts results
+      end
+
+      def create_release_notes
+        App.fail "Release notes template not found as expected at ./#{release_notes_template_path}" unless File.exist?(release_notes_template_path)
+
+        create_release_folder
+
+        File.open(release_notes_path.to_s, 'w') do |f|
+          template = File.read(release_notes_template_path)
+          f << ERB.new(template).result(binding)
+        end
+
+        App.info 'Create', "./#{release_notes_path}"
+      end
+
+      def release_notes_template_path
+        sparkle_config_path.join('release_notes.template.erb')
+      end
+
+      def release_notes_content_path
+        sparkle_config_path.join('release_notes.content.html')
+      end
+
+      def release_notes_path
+        sparkle_release_path + (appcast.notes_filename || "#{app_name}.#{@config.short_version}.html")
+      end
+
+      def release_notes_content
+        if File.exist?(release_notes_content_path)
+          File.read(release_notes_content_path)
+        else
+          App.fail "Missing #{release_notes_content_path}"
+        end
+      end
+
+      def release_notes_html
+        release_notes_content
+      end
+
       # A few helpers
 
       def project_path
@@ -242,10 +319,6 @@ def private_key_path
         sparkle_config_path.join(EDDSA_PRIV_KEY)
       end
 
-      def legacy_private_key_path
-        sparkle_config_path.join(DSA_PRIV_KEY)
-      end
-
       def app_bundle_path
         Pathname.new(@config.app_bundle_raw('MacOSX'))
       end
@@ -262,8 +335,8 @@ def zip_file
         appcast.package_filename || "#{app_name}.#{@config.short_version}.zip"
       end
 
-      def archive_folder
-        appcast.archive_folder
+      def releases_folder
+        appcast.releases_folder
       end
 
       def app_file

lib/motion/project/sparkle.rb

@@ -7,3 +7,4 @@ vendor
 
 sparkle/release
 sparkle/config
+sparkle/config/eddsa_priv.key

sample-app/.gitignore

@@ -25,8 +25,8 @@ Motion::Project::App.setup do |app|
 
   app.sparkle do
     publish :base_url, 'http://example.com/your_app_folder/releases/'
-    publish :public_key, '06Iq4HGJFToJrA8lqWWG0SCqqtGXLuEN1Wgy/CVJBnI='
-    publish :archive_folder, '../published/releases/v2.2/'
+    publish :public_key, '1/eJupmw4JH+iFQIlh99nS2qvwYealJsNzFN3LL6FFE=x'
+    publish :releases_folder, 'tmp/releases/v2.2/'
 
     # Appcast Feed
     # publish :feed_base_url, 'http://downloads.example.com/releases' # defaults to base_url
@@ -40,5 +40,8 @@ Motion::Project::App.setup do |app|
     # publish :package_base_url, 'http://downloads.example.com/releases/' # defaults to base_url
 
     # publish :use_exported_private_key, true
+
+    publish :account, 'motion-sparkle-sandbox.sample-app'
+    publish :full_release_notes_url, 'http://example.com/full_release_notes_changed_again.html'
   end
 end

sample-app/Rakefile

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require File.expand_path('spec_utils', __dir__)
+
+describe 'Appcast' do
+  describe 'arguments' do
+    before do
+      @appcast = Motion::Project::Sparkle::Appcast.new(nil)
+    end
+
+    it 'defaults to empty' do
+      args = @appcast.prepare_args
+
+      expect(args).to eq []
+    end
+
+    it 'sets all command line options' do
+      expected_results = [
+        '--account=test1',
+        '-s=test2',
+        '--download-url-prefix=test3',
+        '--release-notes-url-prefix=test4',
+        '--full-release-notes-url=test5',
+        '--link=test6',
+        '--versions=test7',
+        '--maximum-deltas=test8',
+        '--delta-compression=test9',
+        '--delta-compression-level=test10',
+        '--channel=test11',
+        '--major-version=test12',
+        '--ignore-skipped-upgrades-below-version=test13',
+        '--phased-rollout-interval=test14',
+        '--critical-update-version=test15',
+        '--informational-update-versions=test16',
+        '-o=test17'
+      ]
+
+      @appcast.process_option(:account, 'test1')
+      @appcast.process_option(:private_eddsa_key, 'test2')
+      @appcast.process_option(:download_url_prefix, 'test3')
+      @appcast.process_option(:release_notes_url_prefix, 'test4')
+      @appcast.process_option(:full_release_notes_url, 'test5')
+      @appcast.process_option(:link, 'test6')
+      @appcast.process_option(:versions, 'test7')
+      @appcast.process_option(:maximum_deltas, 'test8')
+      @appcast.process_option(:delta_compression, 'test9')
+      @appcast.process_option(:delta_compression_level, 'test10')
+      @appcast.process_option(:channel, 'test11')
+      @appcast.process_option(:major_version, 'test12')
+      @appcast.process_option(:ignore_skipped_upgrades_below_version, 'test13')
+      @appcast.process_option(:phased_rollout_interval, 'test14')
+      @appcast.process_option(:critical_update_version, 'test15')
+      @appcast.process_option(:informational_update_versions, 'test16')
+      @appcast.process_option(:output_path, 'test17')
+      args = @appcast.prepare_args
+
+      expect(args).to match_array expected_results
+    end
+  end
+end