module PactBroker::Client::CLI::PactCommands

Public Class Methods

included(thor) click to toggle source
# File lib/pact_broker/client/cli/pact_commands.rb, line 14
def self.included(thor)
  thor.class_eval do
    desc 'publish PACT_DIRS_OR_FILES ...', "Publish pacts to a Pact Broker."
    method_option :consumer_app_version, aliases: "-a", desc: "The consumer application version"
    method_option :branch, aliases: "-h", desc: "Repository branch of the consumer version"
    method_option :auto_detect_version_properties, aliases: "-r", type: :boolean, default: false, desc: "Automatically detect the repository commit, branch and build URL from known CI environment variables or git CLI. Supports Buildkite, Circle CI, Travis CI, GitHub Actions, Jenkins, Hudson, AppVeyor, GitLab, CodeShip, Bitbucket and Azure DevOps."
    method_option :tag, aliases: "-t", type: :array, banner: "TAG", desc: "Tag name for consumer version. Can be specified multiple times."
    method_option :tag_with_git_branch, aliases: "-g", type: :boolean, default: false, required: false, desc: "Tag consumer version with the name of the current git branch. Supports Buildkite, Circle CI, Travis CI, GitHub Actions, Jenkins, Hudson, AppVeyor, GitLab, CodeShip, Bitbucket and Azure DevOps."
    method_option :build_url, desc: "The build URL that created the pact"
    method_option :merge, type: :boolean, default: false, require: false, desc: "If a pact already exists for this consumer version and provider, merge the contents. Useful when running Pact tests concurrently on different build nodes."
    output_option_json_or_text
    shared_authentication_options

    def publish(*pact_files)
      require "pact_broker/client/error"
      require "pact_broker/client/git"
      validate_credentials
      validate_consumer_version
      validate_pact_files(pact_files)
      result = publish_pacts(pact_files)
      $stdout.puts result.message
      exit(1) unless result.success
    rescue PactBroker::Client::Error => e
      raise PactPublicationError, "#{e.class} - #{e.message}"
    end

    desc 'list-latest-pact-versions', 'List the latest pact for each integration'
    shared_authentication_options
    output_option_json_or_table
    def list_latest_pact_versions(*required_but_ignored)
      require 'pact_broker/client/pacts/list_latest_versions'
      result = PactBroker::Client::Pacts::ListLatestVersions.call(options.broker_base_url, options.output, pact_broker_client_options)
      $stdout.puts result.message
      exit(1) unless result.success
    end

    no_commands do
      def validate_pact_files pact_files
        unless pact_files && pact_files.any?
          raise ::Thor::RequiredArgumentMissingError, "No value provided for required pact_files"
        end
      end

      def validate_consumer_version
        if consumer_app_version.blank?
          raise ::Thor::RequiredArgumentMissingError, "No value provided for required option --consumer-app-version"
        end
      end

      def publish_pacts pact_files
        require 'pact_broker/client/publish_pacts'

        write_options = options[:merge] ? { write: :merge } : {}
        consumer_version_params = {
          number: consumer_app_version,
          branch: branch,
          tags: tags,
          build_url: build_url
        }.compact

        PactBroker::Client::PublishPacts.call(
          options.broker_base_url,
          file_list(pact_files),
          consumer_version_params,
          { merge: options[:merge], output: options.output }.compact,
          pact_broker_client_options.merge(write_options)
        )
      end

      def file_list pact_files
        require 'rake/file_list'

        correctly_separated_pact_files = pact_files.collect{ |path| path.gsub(/\\+/, '/') }
        paths = Rake::FileList[correctly_separated_pact_files].collect do | path |
          if File.directory?(path)
            Rake::FileList[File.join(path, "*.json")]
          else
            path
          end
        end.flatten
        validate_pact_path_list(paths)
      end

      def validate_pact_path_list(paths)
        paths.collect do | path |
          if File.exist?(path)
            path
          elsif path.start_with?("-")
            raise Thor::Error.new("ERROR: pact-broker publish was called with invalid arguments #{[path]}")
          else
            raise Thor::Error.new("Specified pact file '#{path}' does not exist. This sometimes indicates one of the arguments has been specified with the wrong name and has been incorrectly identified as a file path. If you are using Docker, check that you have mounted the pact file or directory into the container correctly using `-v`, and have specified the location of the pact file or directory in the *Docker container*, not the *host*.")
          end
        end
      end

      def tags
        t = [*options.tag]
        t << PactBroker::Client::Git.branch(raise_error: true) if options.tag_with_git_branch
        t.compact.uniq
      end

      def branch
        if options.branch.nil? && options.auto_detect_version_properties
          PactBroker::Client::Git.branch(raise_error: true)
        else
          options.branch
        end
      end

      def consumer_app_version
        if defined?(@consumer_app_version)
          @consumer_app_version
        else
          @consumer_app_version = if options.consumer_app_version.blank? && options.auto_detect_version_properties
                                    PactBroker::Client::Git.commit(raise_error: true)
                                  else
                                    options.consumer_app_version
                                  end
        end

      end

      def build_url
        if options.build_url.blank? && options.auto_detect_version_properties
          PactBroker::Client::Git.build_url
        else
          options.build_url
        end
      end
    end
  end
end

Public Instance Methods

branch() click to toggle source
# File lib/pact_broker/client/cli/pact_commands.rb, line 115
def branch
  if options.branch.nil? && options.auto_detect_version_properties
    PactBroker::Client::Git.branch(raise_error: true)
  else
    options.branch
  end
end
build_url() click to toggle source
# File lib/pact_broker/client/cli/pact_commands.rb, line 136
def build_url
  if options.build_url.blank? && options.auto_detect_version_properties
    PactBroker::Client::Git.build_url
  else
    options.build_url
  end
end
consumer_app_version() click to toggle source
# File lib/pact_broker/client/cli/pact_commands.rb, line 123
def consumer_app_version
  if defined?(@consumer_app_version)
    @consumer_app_version
  else
    @consumer_app_version = if options.consumer_app_version.blank? && options.auto_detect_version_properties
                              PactBroker::Client::Git.commit(raise_error: true)
                            else
                              options.consumer_app_version
                            end
  end

end
file_list(pact_files) click to toggle source
# File lib/pact_broker/client/cli/pact_commands.rb, line 83
def file_list pact_files
  require 'rake/file_list'

  correctly_separated_pact_files = pact_files.collect{ |path| path.gsub(/\\+/, '/') }
  paths = Rake::FileList[correctly_separated_pact_files].collect do | path |
    if File.directory?(path)
      Rake::FileList[File.join(path, "*.json")]
    else
      path
    end
  end.flatten
  validate_pact_path_list(paths)
end
list_latest_pact_versions(*required_but_ignored) click to toggle source
# File lib/pact_broker/client/cli/pact_commands.rb, line 43
def list_latest_pact_versions(*required_but_ignored)
  require 'pact_broker/client/pacts/list_latest_versions'
  result = PactBroker::Client::Pacts::ListLatestVersions.call(options.broker_base_url, options.output, pact_broker_client_options)
  $stdout.puts result.message
  exit(1) unless result.success
end
publish(*pact_files) click to toggle source
# File lib/pact_broker/client/cli/pact_commands.rb, line 27
def publish(*pact_files)
  require "pact_broker/client/error"
  require "pact_broker/client/git"
  validate_credentials
  validate_consumer_version
  validate_pact_files(pact_files)
  result = publish_pacts(pact_files)
  $stdout.puts result.message
  exit(1) unless result.success
rescue PactBroker::Client::Error => e
  raise PactPublicationError, "#{e.class} - #{e.message}"
end
publish_pacts(pact_files) click to toggle source
# File lib/pact_broker/client/cli/pact_commands.rb, line 63
def publish_pacts pact_files
  require 'pact_broker/client/publish_pacts'

  write_options = options[:merge] ? { write: :merge } : {}
  consumer_version_params = {
    number: consumer_app_version,
    branch: branch,
    tags: tags,
    build_url: build_url
  }.compact

  PactBroker::Client::PublishPacts.call(
    options.broker_base_url,
    file_list(pact_files),
    consumer_version_params,
    { merge: options[:merge], output: options.output }.compact,
    pact_broker_client_options.merge(write_options)
  )
end
tags() click to toggle source
# File lib/pact_broker/client/cli/pact_commands.rb, line 109
def tags
  t = [*options.tag]
  t << PactBroker::Client::Git.branch(raise_error: true) if options.tag_with_git_branch
  t.compact.uniq
end
validate_consumer_version() click to toggle source
# File lib/pact_broker/client/cli/pact_commands.rb, line 57
def validate_consumer_version
  if consumer_app_version.blank?
    raise ::Thor::RequiredArgumentMissingError, "No value provided for required option --consumer-app-version"
  end
end
validate_pact_files(pact_files) click to toggle source
# File lib/pact_broker/client/cli/pact_commands.rb, line 51
def validate_pact_files pact_files
  unless pact_files && pact_files.any?
    raise ::Thor::RequiredArgumentMissingError, "No value provided for required pact_files"
  end
end
validate_pact_path_list(paths) click to toggle source
# File lib/pact_broker/client/cli/pact_commands.rb, line 97
def validate_pact_path_list(paths)
  paths.collect do | path |
    if File.exist?(path)
      path
    elsif path.start_with?("-")
      raise Thor::Error.new("ERROR: pact-broker publish was called with invalid arguments #{[path]}")
    else
      raise Thor::Error.new("Specified pact file '#{path}' does not exist. This sometimes indicates one of the arguments has been specified with the wrong name and has been incorrectly identified as a file path. If you are using Docker, check that you have mounted the pact file or directory into the container correctly using `-v`, and have specified the location of the pact file or directory in the *Docker container*, not the *host*.")
    end
  end
end