manageiq-cross_repo 1.1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cae79b4ed33115478d43ed4afef93fc5af092ab1fd03d540709704556fe25718
-  data.tar.gz: 8ba6a4011ac76bc19a9417e2c63342b1c44d145313336e10ae1107fc3cdfc336
+  metadata.gz: 8b41a33500bc19d1787fc628f2b36526425dafe94b8176376205b3d77e6b8c56
+  data.tar.gz: fcb915b5746293c0f0969cda70116337a5b27795ec94673fe123dfb3357460d4
 SHA512:
-  metadata.gz: 0d1083beae51b21b888b569aafad5a267908c816c71665969251ab1fc7b3e240854fa29102184dcd4e2dc031c044b5403b8e08a6c0845c9d5ad7a804c93680c8
-  data.tar.gz: 16cddb73598fc9c17684907e2f0ba272cded605c31764d50791fc43b2db72bd212000d6f1e3c568679d5b028321b15900e53b2d0f01994bfd0a2ec340bbd2161
+  metadata.gz: f99033869bee7e81ccf5a3fa68ad5c0cbe4d775e50372cccdb79474a92385c9ea258be6754015ef1ca3deb2c4db2dfcd400115e3b571db1dfb956d0f61a84f66
+  data.tar.gz: '082df5577e2c09309900e1782f621c05764b8de1d25b22b63a41eecfe4d71d040cc1290d5abe241d6093547419be14f09d762587dda8d3b6ac759ed6a43ef05e'

data/.gitignore

@@ -11,3 +11,4 @@
 .rspec_status
 
 Gemfile.lock
+/repos/

data/CHANGELOG.md

@@ -0,0 +1,58 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [1.2.1] - 2022-01-11
+### Fixed
+- Fix unpacking the hash for ruby 3 support
+
+## [1.2.0] - 2021-12-15
+### Changed
+- Add support for test repos using Github Actions
+
+### Fixed
+- If the list of repos is empty default to the core repo
+
+## [1.1.3] - 2021-08-27
+### Changed
+- Add retry to ensure_clone (#74)
+
+## [1.1.2] - 2021-05-13
+### Changed
+- Fix newer activesupport pulling in newer tzinfo and causing automate engine specs to fail
+
+## [1.1.1] - 2021-02-22
+### Changed
+- [#71] Pass BUNDLE_PATH env var to test script
+
+## [1.1.0] - 2021-02-05
+### Changed
+- Fix a warning from Kernel#open
+- Add a --script-cmd and SCRIPT_CMD option
+- Parse .travis.yml and run before_*/install/script sections
+
+## [1.0.4] - 2020-04-14
+### Changed
+- Run tools/ci/before_install.sh for all plugins
+
+## [1.0.3] - 2020-03-05
+### Changed
+- Prefer testing using the merge commit if it exists rather than the PR head
+
+## [1.0.2] - 2020-02-04
+### Changed
+- Fix an issue extracting tgz files smaller than 10Kb
+- Fix an issue overriding gems whose repo name doesn't match
+
+[Unreleased]: https://github.com/ManageIQ/more_core_extensions/compare/v1.2.1...HEAD
+[1.2.1]: https://github.com/ManageIQ/more_core_extensions/compare/v1.2.0...v1.2.1
+[1.2.0]: https://github.com/ManageIQ/more_core_extensions/compare/v1.1.3...v1.2.0
+[1.1.3]: https://github.com/ManageIQ/more_core_extensions/compare/v1.1.2...v1.1.3
+[1.1.2]: https://github.com/ManageIQ/more_core_extensions/compare/v1.1.1...v1.1.2
+[1.1.1]: https://github.com/ManageIQ/more_core_extensions/compare/v1.1.0...v1.1.1
+[1.1.0]: https://github.com/ManageIQ/more_core_extensions/compare/v1.0.4...v1.1.0
+[1.0.4]: https://github.com/ManageIQ/more_core_extensions/compare/v1.0.3...v1.0.4
+[1.0.3]: https://github.com/ManageIQ/more_core_extensions/compare/v1.0.2...v1.0.3
+[1.0.2]: https://github.com/ManageIQ/more_core_extensions/compare/v1.0.1...v1.0.2

data/README.md

@@ -16,8 +16,12 @@ Options:
                           If any of the repositories in the list are a core repository that will
                           be used as the root repository, otherwise ManageIQ/manageiq@master will be the default.
                           Can also be passed as a REPOS environment variable.
-  -s, --script-cmd=<s>    Optional, a command string for running the specs.  Defaults to `bundle exec rake`.
                            (default: )
+  -e, --test-suite=<s>    Optional, the name of a rake test suite to pass as an environment variable to the test being run.
+                          This is commonly used by the CI config to conditionally perform different setup tasks
+                          and also to run different test suites, e.g. spec:javascript.
+  -s, --script-cmd=<s>    Optional, a command string for running the specs.
+                          If present this will override the the script section of the test_repo's CI config
 
   -v, --version           Print version and exit
   -h, --help              Show this message

data/exe/manageiq-cross_repo

@@ -33,13 +33,13 @@ opts = Optimist.options do
 
   opt :test_suite, <<~EOS, :type => :string, :default => ENV["TEST_SUITE"].presence
     Optional, the name of a rake test suite to pass as an environment variable to the test being run.
-    This is commonly used by the .travis.yml to conditionally perform different setup tasks
+    This is commonly used by the CI config to conditionally perform different setup tasks
     and also to run different test suites, e.g. spec:javascript.
   EOS
 
   opt :script_cmd, <<~EOS, :type => :string, :default => ENV["SCRIPT_CMD"].presence
     Optional, a command string for running the specs.
-    If present this will override the the script section of the test_repo's .travis.yml
+    If present this will override the the script section of the test_repo's CI config
   EOS
 
 

data/lib/manageiq/cross_repo/repository.rb

@@ -31,7 +31,9 @@ module ManageIQ::CrossRepo
       require "tmpdir"
       require "zlib"
 
-      puts "Fetching #{tarball_url}"
+      retries ||= 0
+
+      puts "Fetching #{tarball_url}#{retry_count(retries)}"
 
       Dir.mktmpdir do |dir|
         Mixlib::Archive.new(open_tarball_url(tarball_url)).extract(dir)
@@ -40,6 +42,12 @@ module ManageIQ::CrossRepo
         FileUtils.mkdir_p(path.dirname)
         FileUtils.mv(content_dir, path)
       end
+    rescue => e
+      retries += 1
+      raise if retries > 3
+
+      sleep 1
+      retry
     end
 
     private
@@ -167,5 +175,11 @@ module ManageIQ::CrossRepo
     def git_pr_to_sha(url, pr)
       git_branch_to_sha(url, "refs/pull/#{pr}/merge") || git_branch_to_sha(url, "refs/pull/#{pr}/head")
     end
+
+    def retry_count(num)
+      return if num == 0
+
+      "  (retry #{num}/3)"
+    end
   end
 end

data/lib/manageiq/cross_repo/runner/base.rb

@@ -0,0 +1,102 @@
+require "active_support/core_ext/object/blank"
+require "yaml"
+
+module ManageIQ::CrossRepo
+  class Runner
+    class Base
+      attr_accessor :script_cmd
+
+      def initialize(script_cmd = nil)
+        @script_cmd = script_cmd.presence
+      end
+
+      def build_test_script
+        load_config!
+        build_script
+      end
+
+      private
+
+      def environment_setup_commands
+        commands = []
+
+        if config["node_js"]
+          commands << "source ~/.nvm/nvm.sh"
+          commands += Array(config["node_js"]).map do |node_version|
+            "nvm install #{node_version}"
+          end
+        end
+
+        commands.any? ? build_section("environment", *commands) : commands
+      end
+
+      def section_commands
+        sections = %w[before_install install before_script script]
+        sections.flat_map do |section|
+          commands = build_section_commands(section)
+          build_section(section, *commands) if commands.present?
+        end.compact
+      end
+
+      def build_commands
+        environment_setup_commands + section_commands
+      end
+
+      def build_section_commands(section)
+        # Travis sections can have a single command or an array of commands
+        Array(config[section]).map { |cmd| "#{cmd} || exit $?" }
+      end
+
+      def build_section(section, *commands)
+        [
+          "echo 'travis_fold:start:#{section}'",
+          *commands,
+          "echo 'travis_fold:end:#{section}'"
+        ]
+      end
+
+      def build_script
+        <<~BASH_SCRIPT
+          #!/bin/bash
+
+          #{build_commands.join("\n")}
+        BASH_SCRIPT
+      end
+
+      def load_config!
+        config
+      end
+
+      def config
+        @config ||= travis_config.tap do |config|
+          # Set missing sections to the proper defaults
+          config["install"] ||= defaults[config["language"]]["install"]
+
+          config["script"] = script_cmd if script_cmd.present?
+          config["script"] ||= defaults[config["language"]]["script"]
+        end
+      end
+
+      def travis_config
+        raise NotImplementedError, "must be implemented in a subclass"
+      end
+
+      def defaults
+        @defaults ||= {
+          "node_js" => {
+            "language" => "node_js",
+            "node_js"  => ["12"],
+            "install"  => "npm install",
+            "script"   => "npm test"
+          },
+          "ruby"    => {
+            "language" => "ruby",
+            "rvm"      => ["2.7"],
+            "install"  => "bundle install --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle}",
+            "script"   => "bundle exec rake"
+          }
+        }.freeze
+      end
+    end
+  end
+end

data/lib/manageiq/cross_repo/runner/github.rb

@@ -0,0 +1,30 @@
+require_relative "./base"
+require "yaml"
+
+module ManageIQ::CrossRepo
+  class Runner
+    class Github < Base
+      CONFIG_FILE = ".github/workflows/ci.yaml".freeze
+
+      def self.available?
+        File.exist?(CONFIG_FILE)
+      end
+
+      private
+
+      def travis_config
+        steps = github_config["jobs"]["ci"]["steps"]
+        language = steps.any? { |s| s["uses"] == "ruby/setup-ruby@v1" } ? "ruby" : "node_js"
+
+        defaults[language].clone.tap do |config|
+          script_step = steps.detect { |s| s["name"] == "Run tests" }
+          config["script"] = script_step["run"] if script_step
+        end
+      end
+
+      def github_config
+        YAML.load_file(CONFIG_FILE)
+      end
+    end
+  end
+end

data/lib/manageiq/cross_repo/runner/travis.rb

@@ -0,0 +1,20 @@
+require_relative "./base"
+require "yaml"
+
+module ManageIQ::CrossRepo
+  class Runner
+    class Travis < Base
+      CONFIG_FILE = ".travis.yml".freeze
+
+      def self.available?
+        File.exist?(CONFIG_FILE)
+      end
+
+      private
+
+      def travis_config
+        YAML.load_file(CONFIG_FILE)
+      end
+    end
+  end
+end

data/lib/manageiq/cross_repo/runner.rb

@@ -1,5 +1,7 @@
 require "manageiq/cross_repo/repository"
+require "active_support/core_ext/class/subclasses"
 require "active_support/core_ext/object/blank"
+Dir.glob(File.join(__dir__, "runner", "*")).sort.each { |f| require f }
 
 module ManageIQ::CrossRepo
   class Runner
@@ -16,8 +18,6 @@ module ManageIQ::CrossRepo
 
         @core_repo = @test_repo
       else
-        raise ArgumentError, "You must pass at least one repo when running a plugin test." if repos.blank?
-
         @core_repo ||= Repository.new("ManageIQ/manageiq@master")
       end
 
@@ -41,7 +41,8 @@ module ManageIQ::CrossRepo
 
     def run_tests
       with_test_env do
-        run_test_script(build_test_script)
+        test_script = script_source.new(script_cmd).build_test_script
+        run_test_script(test_script)
       end
     end
 
@@ -67,6 +68,10 @@ module ManageIQ::CrossRepo
       exit($?.exitstatus) unless $?.success?
     end
 
+    def script_source
+      Base.descendants.detect(&:available?)
+    end
+
     def generate_bundler_d
       bundler_d_path = core_repo.path.join("bundler.d")
       override_path  = bundler_d_path.join("overrides.rb")
@@ -100,74 +105,5 @@ module ManageIQ::CrossRepo
 
       system!(env_vars, "/bin/bash -s", :in => r, :out => $stdout, :err => $stderr)
     end
-
-    def build_test_script
-      load_travis_yml!
-
-      commands = environment_setup_commands
-
-      sections = %w[before_install install before_script script]
-      commands += sections.flat_map do |section|
-        # Travis sections can have a single command or an array of commands
-        section_commands = Array(travis_yml[section]).map { |cmd| "#{cmd} || exit $?" }
-        next if section_commands.blank?
-
-        [
-          "echo 'travis_fold:start:#{section}'",
-          *section_commands,
-          "echo 'travis_fold:end:#{section}'"
-        ]
-      end.compact
-
-      <<~BASH_SCRIPT
-        #!/bin/bash
-
-        #{commands.join("\n")}
-      BASH_SCRIPT
-    end
-
-    def environment_setup_commands
-      setup_commands = []
-
-      if travis_yml["node_js"]
-        setup_commands << "source ~/.nvm/nvm.sh"
-        setup_commands += Array(travis_yml["node_js"]).map do |node_version|
-          "nvm install #{node_version}"
-        end
-      end
-
-      setup_commands
-    end
-
-    def load_travis_yml!
-      # Load the test_repo's .travis.yml file
-      travis_yml
-
-      # Set missing travis sections to the proper defaults
-      travis_yml["install"] ||= travis_defaults[travis_yml["language"]]["install"]
-
-      travis_yml["script"] = script_cmd if script_cmd.present?
-      travis_yml["script"] ||= travis_defaults[travis_yml["language"]]["script"]
-    end
-
-    def travis_yml
-      @travis_yml ||= begin
-        require "yaml"
-        YAML.load_file(".travis.yml")
-      end
-    end
-
-    def travis_defaults
-      @travis_defaults ||= {
-        "node_js" => {
-          "install" => "npm install",
-          "script"  => "npm test"
-        },
-        "ruby"    => {
-          "install" => "bundle install --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle}",
-          "script"  => "bundle exec rake"
-        }
-      }.freeze
-    end
   end
 end

data/lib/manageiq/cross_repo/version.rb

@@ -1,5 +1,5 @@
 module ManageIQ
   module CrossRepo
-    VERSION = "1.1.1"
+    VERSION = "1.2.1"
   end
 end

data/lib/manageiq/cross_repo.rb

@@ -7,8 +7,8 @@ module ManageIQ
   module CrossRepo
     REPOS_DIR = Pathname.pwd.join("repos")
 
-    def self.run(*args)
-      Runner.new(*args).run
+    def self.run(**args)
+      Runner.new(**args).run
     end
   end
 end

data/manageiq-cross_repo.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "simplecov"
 
-  spec.add_dependency "activesupport"
+  spec.add_dependency "activesupport", "~> 6.0.3"
   spec.add_dependency "ffi-libarchive"
   spec.add_dependency "mixlib-archive"
   spec.add_dependency "optimist"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manageiq-cross_repo
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.1
 platform: ruby
 authors:
 - ManageIQ Authors
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-22 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: manageiq-style
@@ -70,16 +70,16 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.0.3
 - !ruby/object:Gem::Dependency
   name: ffi-libarchive
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,7 @@ files:
 - ".rubocop_cc.yml"
 - ".rubocop_local.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -147,8 +148,12 @@ files:
 - lib/manageiq/cross_repo.rb
 - lib/manageiq/cross_repo/repository.rb
 - lib/manageiq/cross_repo/runner.rb
+- lib/manageiq/cross_repo/runner/base.rb
+- lib/manageiq/cross_repo/runner/github.rb
+- lib/manageiq/cross_repo/runner/travis.rb
 - lib/manageiq/cross_repo/version.rb
 - manageiq-cross_repo.gemspec
+- repos/.gitkeep
 homepage: https://github.com/ManageIQ/manageiq-cross_repo
 licenses:
 - MIT
@@ -170,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: ManageIQ CrossRepo testing library