manageiq-cross_repo 1.1.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 756d32fbaca87b4fcd09bcb95dca76ad5e4560561586431dd64c7ea050d56573
-  data.tar.gz: 9ddbaeb1080a02757d20113cf93f6161086e24d91cc03a8793893900b9933969
+  metadata.gz: ab950b0d16326800267d3cb3444863d955faf40b445bb53f9c825260b6140e97
+  data.tar.gz: 5bae7ad852de74a91a342ca79579609a077971fffb413f3e103dff6d702827bc
 SHA512:
-  metadata.gz: f23fd2b6b57843d2974b06058786d1da8321d8eb83599fe4fe4935006e822ab036d5615cebc407db51c68c25f8d24bb3d78a85e37eb745565b68e66b55b35082
-  data.tar.gz: bd339e043a899aef5fafd10d2a8f85a59fc0d813b19d17c3b738ded4a6809b3f246e548eb2bdba0a11a5298fba3933296ffd4b1583a9fce2808ac62b503c613f
+  metadata.gz: 4dbde8d0c81851702335545def9156efa18573cc91852b05d01aa99921d6cab3517fc9d0bf13a10aa87920826bda255e334708fa74fcb873cb4065dcf712b887
+  data.tar.gz: a607ee34daf7cb9b41263f538a3ba23c4e0ed78c243b939509e8904db020a041ae876fe5991b41b1b0fd476e773f2edfa6b2c8b0156b25b411ba6f23203c97e1

data/.github/workflows/ci.yaml

@@ -0,0 +1,22 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+        - '2.5'
+        - '2.6'
+        - '2.7'
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.github/workflows/manageiq_cross_repo.yaml

@@ -0,0 +1,52 @@
+name: ManageIQ Cross Repo Workflow
+
+on:
+  workflow_call:
+    inputs:
+      test-repos:
+        required: true
+        type: string
+      repos:
+        required: true
+        type: string
+      test-suite:
+        required: false
+        type: string
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        test-repo: ${{ fromJson(inputs.test-repos) }}
+    services:
+      postgres:
+        image: manageiq/postgresql:10
+        env:
+          POSTGRESQL_USER: root
+          POSTGRESQL_PASSWORD: smartvm
+          POSTGRESQL_DATABASE: vmdb_test
+        options: --health-cmd pg_isready --health-interval 2s --health-timeout 5s --health-retries 5
+        ports:
+        - 5432:5432
+    env:
+      TEST_SUITE: ${{ inputs.test-suite }}
+      REPOS: ${{ inputs.repos }}
+      TEST_REPO: ${{ matrix.test-repo }}
+      PGHOST: localhost
+      PGPASSWORD: smartvm
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+        bundler-cache: true
+    - name: Set up Node
+      uses: actions/setup-node@v2
+      with:
+        node-version: 12
+        registry-url: https://npm.manageiq.org/
+    - name: Run tests
+      run: bundle exec manageiq-cross_repo

data/.gitignore

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

data/.whitesource

@@ -0,0 +1,3 @@
+{
+  "settingsInheritedFrom": "ManageIQ/whitesource-config@master"
+}

data/CHANGELOG.md

@@ -0,0 +1,70 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [2.1.0] - 2022-02-21
+### Changed
+- Update nodejs version to v16 (#79)
+
+## [2.0.0] - 2022-02-08
+### Changed
+- Announce the cross repo run information (#81)
+- Use Github Actions for CI (#82)
+- Replace Travis with Github Actions (#83)
+
+## [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/manageiq-cross_repo/compare/v2.1.0...HEAD
+[2.1.0]: https://github.com/ManageIQ/manageiq-cross_repo/compare/v2.1.0..v2.0.0
+[2.0.0]: https://github.com/ManageIQ/manageiq-cross_repo/compare/v2.0.0...v1.2.1
+[1.2.1]: https://github.com/ManageIQ/manageiq-cross_repo/compare/v1.2.0...v1.2.1
+[1.2.0]: https://github.com/ManageIQ/manageiq-cross_repo/compare/v1.1.3...v1.2.0
+[1.1.3]: https://github.com/ManageIQ/manageiq-cross_repo/compare/v1.1.2...v1.1.3
+[1.1.2]: https://github.com/ManageIQ/manageiq-cross_repo/compare/v1.1.1...v1.1.2
+[1.1.1]: https://github.com/ManageIQ/manageiq-cross_repo/compare/v1.1.0...v1.1.1
+[1.1.0]: https://github.com/ManageIQ/manageiq-cross_repo/compare/v1.0.4...v1.1.0
+[1.0.4]: https://github.com/ManageIQ/manageiq-cross_repo/compare/v1.0.3...v1.0.4
+[1.0.3]: https://github.com/ManageIQ/manageiq-cross_repo/compare/v1.0.2...v1.0.3
+[1.0.2]: https://github.com/ManageIQ/manageiq-cross_repo/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/runner/base.rb

@@ -0,0 +1,99 @@
+require "active_support/core_ext/object/blank"
+require "yaml"
+
+module ManageIQ::CrossRepo
+  class Runner
+    class Base
+      attr_accessor :script_cmd, :config
+
+      def initialize(script_cmd = nil)
+        @script_cmd = script_cmd.presence
+        @config     = load_config!
+      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 '::group::#{section}'",
+          *commands,
+          "echo '::endgroup::'"
+        ]
+      end
+
+      def build_script
+        <<~BASH_SCRIPT
+          #!/bin/bash
+
+          #{build_commands.join("\n")}
+        BASH_SCRIPT
+      end
+
+      def load_config!
+        ci_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 ci_config
+        raise NotImplementedError, "must be implemented in a subclass"
+      end
+
+      def defaults
+        @defaults ||= {
+          "node_js" => {
+            "language" => "node_js",
+            "node_js"  => ["16"],
+            "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,34 @@
+require_relative "./base"
+require "yaml"
+require "active_support/core_ext/enumerable"
+
+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 ci_config
+        github_config = YAML.load_file(CONFIG_FILE)
+
+        steps = github_config["jobs"]["ci"]["steps"]
+        steps_by_name = steps.index_by { |step| step["name"] }
+
+        language = steps.any? { |s| s["uses"] == "ruby/setup-ruby@v1" } ? "ruby" : "node_js"
+
+        result = {"language" => language}
+
+        result["before_install"] = steps_by_name["Set up system"]["run"] if steps_by_name["Set up system"]
+        result["before_script"]  = steps_by_name["Prepare tests"]["run"] if steps_by_name["Prepare tests"]
+        result["script"]         = steps_by_name["Run tests"]["run"]     if steps_by_name["Run tests"]
+
+        result
+      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 ci_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
 
@@ -26,6 +26,7 @@ module ManageIQ::CrossRepo
     end
 
     def run
+      announce_run
       test_repo.ensure_clone
       core_repo.ensure_clone unless test_repo.core?
       prepare_gem_repos
@@ -34,6 +35,15 @@ module ManageIQ::CrossRepo
 
     private
 
+    def announce_run
+      puts "\e[36m Starting cross repo for:\e[0m"
+      puts "  \e[36mtest repo: #{test_repo.identifier}\e[0m"
+      puts "  \e[36mcore repo: #{core_repo.identifier}\e[0m"
+      gem_repos.each do |gr|
+        puts "  \e[36mgem repo:  #{gr.identifier}\e[0m"
+      end
+    end
+
     def bundle_path
       app_path = Pathname.new(ENV["TRAVIS_BUILD_DIR"].presence || Pathname.pwd)
       app_path.join("vendor", "bundle")
@@ -41,12 +51,13 @@ 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
 
     def env_vars
-      {"MANAGEIQ_REPO" => core_repo.path.to_s, "TRAVIS_BUILD_DIR" => test_repo.path.to_s, "BUNDLE_PATH" => bundle_path.to_s, "TEST_SUITE" => test_suite}
+      {"MANAGEIQ_REPO" => core_repo.path.to_s, "BUNDLE_PATH" => bundle_path.to_s, "TEST_SUITE" => test_suite}
     end
 
     def with_test_env
@@ -67,6 +78,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 +115,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.3"
+    VERSION = "2.1.0"
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manageiq-cross_repo
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 2.1.0
 platform: ruby
 authors:
 - ManageIQ Authors
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-27 00:00:00.000000000 Z
+date: 2022-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: manageiq-style
@@ -123,19 +123,22 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: ManageIQ CrossRepo testing library
-email:
+email: 
 executables:
 - manageiq-cross_repo
 extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/workflows/ci.yaml"
+- ".github/workflows/manageiq_cross_repo.yaml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_cc.yml"
 - ".rubocop_local.yml"
-- ".travis.yml"
+- ".whitesource"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -147,15 +150,19 @@ 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
 metadata:
   homepage_uri: https://github.com/ManageIQ/manageiq-cross_repo
   source_code_uri: https://github.com/ManageIQ/manageiq-cross_repo
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -170,8 +177,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key:
+rubygems_version: 3.3.5
+signing_key: 
 specification_version: 4
 summary: ManageIQ CrossRepo testing library
 test_files: []

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-rvm:
-- 2.5.5
-cache: bundler
-addons:
-  postgresql: '10'
-  apt:
-    packages:
-    - libarchive-dev
-matrix:
-  fast_finish: true