manageiq-cross_repo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf9a2849a682e80a6099be954de0a7f2a1e3f019b3b04018a5a18aeeec68f905
+  data.tar.gz: 6308f46b490d5af9a923929bd706f9a41e057cd5cbefef8214db7b44f1d8978c
+SHA512:
+  metadata.gz: 1bf15c4fe299adab8a79a0bc37afd619032c2a868adf328db72a9eec4d918f435496872f182349d675347d14220248bdc99399059f8a62af4113433117c4118b
+  data.tar.gz: a910789c67868604ddc3fe304c7268952d474e36d81f120b39553c8dce2d23540984f319dd87f28cdd5dd4d80cdcd7fe01b4d44a97e9887b95b2ea00b4c9cf32

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,15 @@
+dist: xenial
+language: ruby
+rvm:
+- 2.5.5
+cache:
+  bundler: true
+addons:
+  postgresql: '10'
+matrix:
+  fast_finish: true
+env:
+  global:
+  - TEST_REPO=
+  - CORE_REPO=
+  - GEM_REPOS=

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+plugin 'bundler-inject'
+require File.join(Bundler::Plugin.index.load_paths("bundler-inject")[0], "bundler-inject") rescue nil
+
+# Specify your gem's dependencies in manageiq-cross_repo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 ManageIQ Authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# ManageIQ cross-repository testing framework
+
+```
+Usage: manageiq-cross_repo --test-repo repo [--core-repo repo] [--gem-repos repo1 repo2 ...]
+
+manageiq-cross_repo is a cross repository test framework for the ManageIQ project.
+Its purpose is to allow running multiple repository tests suites in the context
+of other repositories and is particularly useful when trying to determine if the
+changes you are making as a developer will affect the other test suites.
+
+Options:
+  -t, --test-repo=<s>     This is the repository which will be tested.
+                          Can also be passed as a TEST_REPO environment variable.
+                           (default: ManageIQ/manageiq@master)
+  -c, --core-repo=<s>     Used to specify a different core branch in which plugin tests will run.
+                           If --test-repo is a plugin, defaults to ManageIQ/manageiq@master.
+                           If --test-repo is a core repo, this option is not allowed.
+                          Can also be passed as a CORE_REPO environment variable.
+  -g, --gem-repos=<s+>    Optional, a list of other plugin/gem overrides which are needed to run the tests.
+                          Can also be passed as a GEM_REPOS environment variable.
+
+  -v, --version           Print version and exit
+  -h, --help              Show this message
+
+Repo Formats:
+  Remote: [org/]repository[@ref|#pr]
+    org:        Optional, defaults to ManageIQ.
+    repository: Required, the name of the repository.
+    @ref:       Optional, defaults to master if #pr not set. Can be a branch, tag, or SHA. Mutually exclusive with #pr.
+    #pr:        Optional, references a pull-request number. Mutually exclusive with @ref.
+
+  Local: Either a fully qualified path or a relative path (e.g. /path/to/repo, ~/relative/to/home, ../relative/to/current/dir)
+
+Examples:
+  # Test a plugin against ManageIQ master
+  manageiq-cross_repo --test-repo manageiq-ui-classic
+
+  # Test a plugin against a ManageIQ SHA
+  manageiq-cross_repo --test-repo manageiq-ui-classic --core-repo manageiq@1234abcd
+
+  # Test a plugin branch
+  manageiq-cross_repo --test-repo manageiq-ui-classic@feature
+
+  # Test a plugin branch from a fork
+  manageiq-cross_repo --test-repo johndoe/manageiq-ui-classic@feature
+
+  # Test a plugin PR
+  manageiq-cross_repo --test-repo manageiq-ui-classic#1234
+
+  # Test a plugin with a set of other plugins
+  manageiq-cross_repo --test-repo manageiq-ui-classic --gem-repos manageiq-providers-vmware@feature manageiq-content@feature
+
+  # Test a plugin branch with a ManageIQ SHA and a set of other plugins
+  manageiq-cross_repo --test-repo manageiq-ui-classic@feature --core-repo manageiq@1234abcd --gem-repos manageiq-providers-vmware@feature manageiq-content@feature
+
+  # Run core tests with ManageIQ master using a gem version
+  manageiq-cross_repo --gem-repos johndoe/manageiq-ui-classic@feature
+
+  # Run core tests for a branch and a set of gems
+  manageiq-cross_repo --test-repo johndoe/manageiq@feature --gem-repos manageiq-providers-vmware@feature manageiq-content@feature
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "manageiq/cross_repo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/manageiq-cross_repo

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+
+require "manageiq-cross_repo"
+require "optimist"
+
+opts = Optimist.options do
+  usage "--test-repo repo [--core-repo repo] [--gem-repos repo1 repo2 ...]"
+
+  version "v#{ManageIQ::CrossRepo::VERSION}\n"
+
+  synopsis <<~EOS.chomp
+
+    manageiq-cross_repo is a cross repository test framework for the ManageIQ project.
+    Its purpose is to allow running multiple repository tests suites in the context
+    of other repositories and is particularly useful when trying to determine if the
+    changes you are making as a developer will affect the other test suites.
+  EOS
+
+  opt :test_repo, <<~EOS, :type => :string, :default => ENV["TEST_REPO"].presence || "ManageIQ/manageiq@master"
+    This is the repository which will be tested.
+    Can also be passed as a TEST_REPO environment variable.
+  EOS
+
+  opt :core_repo, <<~EOS, :type => :string, :default => ENV["CORE_REPO"].presence
+    Used to specify a different core branch in which plugin tests will run.
+     If --test-repo is a plugin, defaults to ManageIQ/manageiq@master.
+     If --test-repo is a core repo, this option is not allowed.
+    Can also be passed as a CORE_REPO environment variable.
+  EOS
+
+  opt :gem_repos, <<~EOS, :type => :strings, :multi => true, :default => Array(ENV["GEM_REPOS"].presence)
+    Optional, a list of other plugin/gem overrides which are needed to run the tests.
+    Can also be passed as a GEM_REPOS environment variable.
+  EOS
+
+  # Manually add these so they appear in the right order in the help output
+  banner ""
+  opt :version, "Print version and exit"
+  opt :help,    "Show this message"
+
+  banner <<~EOS.chomp
+
+    Repo Formats:
+      Remote: [org/]repository[@ref|#pr]
+        org:        Optional, defaults to ManageIQ.
+        repository: Required, the name of the repository.
+        @ref:       Optional, defaults to master if #pr not set. Can be a branch, tag, or SHA. Mutually exclusive with #pr.
+        #pr:        Optional, references a pull-request number. Mutually exclusive with @ref.
+
+      Local: Either a fully qualified path or a relative path (e.g. /path/to/repo, ~/relative/to/home, ../relative/to/current/dir)
+  EOS
+
+  banner <<~EOS.chomp
+
+    Examples:
+      # Test a plugin against ManageIQ master
+      manageiq-cross_repo --test-repo manageiq-ui-classic
+
+      # Test a plugin against a ManageIQ SHA
+      manageiq-cross_repo --test-repo manageiq-ui-classic --core-repo manageiq@1234abcd
+
+      # Test a plugin branch
+      manageiq-cross_repo --test-repo manageiq-ui-classic@feature
+
+      # Test a plugin branch from a fork
+      manageiq-cross_repo --test-repo johndoe/manageiq-ui-classic@feature
+
+      # Test a plugin PR
+      manageiq-cross_repo --test-repo manageiq-ui-classic#1234
+
+      # Test a plugin with a set of other plugins
+      manageiq-cross_repo --test-repo manageiq-ui-classic --gem-repos manageiq-providers-vmware@feature manageiq-content@feature
+
+      # Test a plugin branch with a ManageIQ SHA and a set of other plugins
+      manageiq-cross_repo --test-repo manageiq-ui-classic@feature --core-repo manageiq@1234abcd --gem-repos manageiq-providers-vmware@feature manageiq-content@feature
+
+      # Run core tests with ManageIQ master using a gem version
+      manageiq-cross_repo --gem-repos johndoe/manageiq-ui-classic@feature
+
+      # Run core tests for a branch and a set of gems
+      manageiq-cross_repo --test-repo johndoe/manageiq@feature --gem-repos manageiq-providers-vmware@feature manageiq-content@feature
+  EOS
+end
+
+opts[:gem_repos] = opts[:gem_repos].flatten.flat_map { |repo| repo.split(",").map(&:strip) }
+
+begin
+  ManageIQ::CrossRepo.run(opts[:test_repo], opts[:core_repo], opts[:gem_repos])
+rescue ArgumentError => e
+  Optimist.die e
+end

data/lib/manageiq-cross_repo.rb

@@ -0,0 +1 @@
+require "manageiq/cross_repo"

data/lib/manageiq/cross_repo.rb

@@ -0,0 +1,14 @@
+require "manageiq/cross_repo/version"
+require "manageiq/cross_repo/runner"
+
+require "pathname"
+
+module ManageIQ
+  module CrossRepo
+    REPOS_DIR = Pathname.pwd.join("repos")
+
+    def self.run(*args)
+      Runner.new(*args).run
+    end
+  end
+end

data/lib/manageiq/cross_repo/repository.rb

@@ -0,0 +1,95 @@
+module ManageIQ::CrossRepo
+  class Repository
+    attr_accessor :org, :repo, :ref, :sha, :url, :path
+
+    # ManageIQ::CrossRepo::Repository
+    #
+    # @param identifier [String] the short representation of a repository relative to a server, format [org/]repo[@ref]
+    # @param server [String] The git repo server hosting this repository, default: https://github.com
+    # @example
+    #   Repostory.new("ManageIQ/manageiq@master", server: "https://github.com")
+    def initialize(identifier, server: "https://github.com")
+      @org, @repo, @ref, @sha, @url, @path = parse_identifier(identifier, server)
+    end
+
+    def core?
+      repo.casecmp("manageiq") == 0
+    end
+
+    def ensure_clone
+      return if path.exist?
+
+      require "mixlib/archive"
+      require "open-uri"
+      require "tmpdir"
+      require "zlib"
+
+      puts "Fetching #{tarball_url}"
+
+      Dir.mktmpdir do |dir|
+        Mixlib::Archive.new(open(tarball_url, "rb")).extract(dir)
+
+        content_dir = Pathname.new(dir).children.detect(&:directory?)
+        FileUtils.mkdir_p(path.dirname)
+        FileUtils.mv(content_dir, path)
+      end
+    end
+
+    private
+
+    def parse_identifier(identifier, server)
+      if ["/", "~", "."].include?(identifier[0])
+        path = Pathname.new(identifier).expand_path
+        raise ArgumentError, "Path #{path} does not exist" unless path.exist?
+
+        repo = path.basename.to_s
+        ref  = Dir.chdir(path) { `git rev-parse HEAD`.chomp }
+        sha  = ref
+      else
+        if identifier.include?("#")
+          name, pr = identifier.split("#")
+        else
+          name, ref_or_branch = identifier.split("@")
+          if ref_or_branch.nil?
+            branch = "master"
+          elsif ref_or_branch.match?(/^\h+$/)
+            ref = ref_or_branch
+          else
+            branch = ref_or_branch
+          end
+        end
+
+        org, repo = name.split("/")
+        repo, org = org, "ManageIQ" if repo.nil?
+
+        url  = File.join(server, org, repo)
+
+        sha = if pr
+          git_pr_to_sha(url, pr)
+        elsif branch
+          git_branch_to_sha(url, branch)
+        else
+          ref
+        end
+
+        raise ArgumentError, "#{identifier} does not exist" if sha.nil?
+
+        path = REPOS_DIR.join("#{org}/#{repo}@#{sha}")
+      end
+
+      return org, repo, ref, sha, url, path
+    end
+
+    def tarball_url
+      url && File.join(url, "tarball", sha)
+    end
+
+    def git_branch_to_sha(url, branch)
+      `git ls-remote #{url} #{branch}`.split("\t").first
+    end
+
+    def git_pr_to_sha(url, pr)
+      `git ls-remote #{url} refs/pull/#{pr}/head`.split("\t").first
+    end
+  end
+end

data/lib/manageiq/cross_repo/runner.rb

@@ -0,0 +1,89 @@
+require "manageiq/cross_repo/repository"
+require "active_support/core_ext/object/blank"
+
+module ManageIQ::CrossRepo
+  class Runner
+    attr_reader :test_repo, :core_repo, :gem_repos
+
+    def initialize(test_repo, core_repo, gem_repos)
+      @test_repo = Repository.new(test_repo || "ManageIQ/manageiq@master")
+      if @test_repo.core?
+        raise ArgumentError, "You cannot pass core repo when running a core test"           if core_repo.present?
+        raise ArgumentError, "You must pass at least one gem repo when running a core test" if gem_repos.blank?
+
+        @core_repo = @test_repo
+      else
+        raise ArgumentError, "You must pass either a core repo or at least one gem repo when running a plugin test" if core_repo.blank? && gem_repos.blank?
+
+        @core_repo = Repository.new(core_repo || "ManageIQ/manageiq@master")
+      end
+
+      @gem_repos = gem_repos.to_a.map { |repo| Repository.new(repo) }
+    end
+
+    def run
+      test_repo.ensure_clone
+      test_repo.core? ? run_core : run_plugin
+    end
+
+    private
+
+    def run_core
+      prepare_gem_repos
+
+      with_test_env do
+        system!({"TRAVIS_BUILD_DIR" => test_repo.path.to_s}, "bash", "tools/ci/before_install.sh") if ENV["CI"]
+        system!("bin/setup")
+        system!("bundle exec rake")
+      end
+    end
+
+    def run_plugin
+      core_repo.ensure_clone
+      symlink_core_repo_spec
+      prepare_gem_repos
+
+      with_test_env do
+        system!("bin/setup")
+        system!("bundle exec rake")
+      end
+    end
+
+    def with_test_env
+      Dir.chdir(test_repo.path) do
+        Bundler.with_clean_env do
+          yield
+        end
+      end
+    end
+
+    def system!(*args)
+      exit($CHILD_STATUS.exitstatus) unless system(*args)
+    end
+
+    def generate_bundler_d
+      bundler_d_path = core_repo.path.join("bundler.d")
+      override_path  = bundler_d_path.join("overrides.rb")
+
+      if gem_repos.empty?
+        FileUtils.rm_f override_path
+      else
+        content = gem_repos.map { |gem| "override_gem \"#{gem.repo}\", :path => \"#{gem.path}\"" }.join("\n")
+        FileUtils.mkdir_p(bundler_d_path)
+
+        File.write(override_path, content)
+      end
+    end
+
+    def prepare_gem_repos
+      gem_repos.each { |gem_repo| gem_repo.ensure_clone }
+      generate_bundler_d
+    end
+
+    def symlink_core_repo_spec
+      core_spec_symlink = test_repo.path.join("spec", "manageiq")
+      FileUtils.rm_f(core_spec_symlink)
+      FileUtils.ln_s(core_repo.path, core_spec_symlink)
+    end
+  end
+end

data/lib/manageiq/cross_repo/version.rb

@@ -0,0 +1,5 @@
+module ManageIQ
+  module CrossRepo
+    VERSION = "0.1.0"
+  end
+end

data/manageiq-cross_repo.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/manageiq/cross_repo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "manageiq-cross_repo"
+  spec.version       = ManageIQ::CrossRepo::VERSION
+  spec.authors       = ["ManageIQ Authors"]
+
+  spec.summary       = %q{ManageIQ CrossRepo testing library}
+  spec.description   = %q{ManageIQ CrossRepo testing library}
+  spec.homepage      = "https://github.com/ManageIQ/manageiq-cross_repo"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ManageIQ/manageiq-cross_repo"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "mixlib-archive"
+  spec.add_dependency "optimist"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: manageiq-cross_repo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ManageIQ Authors
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mixlib-archive
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: optimist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ManageIQ CrossRepo testing library
+email: 
+executables:
+- manageiq-cross_repo
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/manageiq-cross_repo
+- lib/manageiq-cross_repo.rb
+- lib/manageiq/cross_repo.rb
+- lib/manageiq/cross_repo/repository.rb
+- lib/manageiq/cross_repo/runner.rb
+- lib/manageiq/cross_repo/version.rb
+- manageiq-cross_repo.gemspec
+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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: ManageIQ CrossRepo testing library
+test_files: []