vanagon 0.15.38 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ffa8bb7c327a5b46f5403c9fb77cf396c8a9e09fb8d7c7558927bd99830483b
-  data.tar.gz: 8bc7b97f25d0fa5405af34ecddc6e6b00d6c57605d85a16fe232c7477a3083a8
+  metadata.gz: 2fff2c855cb0a9c8555e584f43fe29baa5cc6da9c9d2e938cc077c7049c8e2bf
+  data.tar.gz: 1ee6759c62df9a9eb6c5bf1614c8543ab8a0ff625f444e67471499638745322c
 SHA512:
-  metadata.gz: f63aa10d3742e370faaaaf2c7dd5d7720f6598e60944a4d4917cc1e19b761a606a44fac5809f801bbae99b23f3f0221c958b70e7afb2a619d6fe32c0110a052c
-  data.tar.gz: 4303abc3598c0558b349dee95ad81c1f6354845971323ccbaa73f24d841c4eab7e5df39225ea9f58ae305470ec143f849feb7e0adae296430873263729a536ff
+  metadata.gz: 3fe34a4441dd96772e3c9e6b7a824090b27b898b059f7b08996d8ab8dc5ad695c889e91bbe322829fb2b2359a53a191cf78ac8cfba0ac68a0ce938cc12d5b5db
+  data.tar.gz: 996e0265bfb18a929a44348ef287139fb076d9b351b80e4b99e3a26b16624efafb246bff9fb7a90fdc699b004f934df677a0fc0cee8fd71eee4cb8b984f1c353

data/bin/build

@@ -1,29 +1,8 @@
 #!/usr/bin/env ruby
-load File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "vanagon.rb"))
 
-optparse = Vanagon::OptParse.new("#{File.basename(__FILE__)} <project-name> <platform-name>[,<platform-name>...] [<target>,<target>...] [options]",
-                                 %i[workdir configdir engine preserve verbose skipcheck only_build remote-workdir])
-options = optparse.parse! ARGV
+script = File.basename($0)
 
-project = ARGV[0]
-platforms = ARGV[1]
-targets = ARGV[2]
+warn "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
+     Use: 'vanagon #{script}' instead."
 
-if project.nil? or platforms.nil?
-  warn "project and platform are both required arguments."
-  warn optparse
-  exit 1
-end
-
-platform_list = platforms.split(',')
-if targets
-  target_list = targets.split(',')
-else
-  target_list = []
-end
-
-platform_list.zip(target_list).each do |pair|
-  platform, target = pair
-  artifact = Vanagon::Driver.new(platform, project, options.merge({ :target => target }))
-  artifact.run
-end
+exec "vanagon", script, *ARGV

data/bin/build_host_info

@@ -1,21 +1,8 @@
 #!/usr/bin/env ruby
-require 'json'
 
-load File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "vanagon.rb"))
+script = File.basename($0)
 
-optparse = Vanagon::OptParse.new("#{File.basename(__FILE__)} <project-name> <platform-name> [options]", %i[workdir configdir engine])
-options = optparse.parse! ARGV
+warn "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
+     Use: 'vanagon #{script}' instead."
 
-project = ARGV[0]
-platforms = ARGV[1]
-
-if project.nil? or platforms.nil?
-  warn "project and platform are both required arguments."
-  warn optparse
-  exit 1
-end
-
-platforms.split(',').each do |platform|
-  driver = Vanagon::Driver.new(platform, project, options)
-  $stdout.puts JSON.generate(driver.build_host_info)
-end
+exec "vanagon", script, *ARGV

data/bin/build_requirements

@@ -1,35 +1,8 @@
 #!/usr/bin/env ruby
-require 'json'
-require 'vanagon/extensions/ostruct/json'
-require 'vanagon/extensions/set/json'
-require 'vanagon/extensions/hashable'
 
-load File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "vanagon.rb"))
+script = File.basename($0)
 
-optparse = Vanagon::OptParse.new("#{File.basename(__FILE__)} <project-name> <platform-name> [options]", %i[workdir configdir engine])
-optparse.parse! ARGV
-
-project = ARGV[0]
-platform = ARGV[1]
-
-unless project and platform
-  warn "project and platform are both required arguments."
-  warn optparse
-  exit 1
-end
-
-driver = Vanagon::Driver.new(platform, project)
-components = driver.project.components
-component_names = components.map(&:name)
-build_requirements = []
-components.each do |component|
-  build_requirements << component.build_requires.reject do |req|
-    # only include external requirements: i.e. those that do not match
-    # other components in the project
-    component_names.include?(req)
-  end
-end
-$stdout.puts
-$stdout.puts "**** External packages required to build #{project} on #{platform}: ***"
-$stdout.puts JSON.pretty_generate(build_requirements.flatten.uniq.sort)
+warn "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
+     Use: 'vanagon #{script}' instead."
 
+exec "vanagon", script, *ARGV

data/bin/inspect

@@ -1,25 +1,8 @@
 #!/usr/bin/env ruby
-require 'json'
-require 'vanagon/extensions/ostruct/json'
-require 'vanagon/extensions/set/json'
-require 'vanagon/extensions/hashable'
 
-load File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "vanagon.rb"))
+script = File.basename($0)
 
-optparse = Vanagon::OptParse.new("#{File.basename(__FILE__)} <project-name> <platform-name> [options]", %i[workdir configdir engine])
-options = optparse.parse! ARGV
+warn "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
+     Use: 'vanagon #{script}' instead."
 
-project = ARGV[0]
-platforms = ARGV[1]
-
-unless project or platforms
-  warn "project and platform are both required arguments."
-  warn optparse
-  exit 1
-end
-
-platforms.split(',').each do |platform|
-  driver = Vanagon::Driver.new(platform, project, options)
-  components = driver.project.components.map(&:to_hash)
-  $stdout.puts JSON.pretty_generate(components)
-end
+exec "vanagon", script, *ARGV

data/bin/render

@@ -1,26 +1,8 @@
 #!/usr/bin/env ruby
-load File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "vanagon.rb"))
 
-optparse = Vanagon::OptParse.new(
-  "#{File.basename(__FILE__)} <project-name> <platform-name> [options]",
-  %i[workdir configdir engine]
-)
-options = optparse.parse! ARGV
+script = File.basename($0)
 
-project = ARGV[0]
-platforms = ARGV[1]
+warn "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
+     Use: 'vanagon #{script}' instead."
 
-if project.nil? or platforms.nil?
-  warn "project and platform are both required arguments."
-  warn optparse
-  exit 1
-end
-
-platform_list = platforms.split(',')
-target_list = []
-
-platform_list.zip(target_list).each do |pair|
-  platform, target = pair
-  artifact = Vanagon::Driver.new(platform, project, options.merge({ :target => target }))
-  artifact.render
-end
+exec "vanagon", script, *ARGV

data/bin/ship

@@ -1,32 +1,8 @@
 #!/usr/bin/env ruby
 
-ENV["PROJECT_ROOT"] = Dir.pwd
+script = File.basename($0)
 
-# Begin warning: This ship script is an internal tool.
-# This is not intended to function outside of Puppet Labs' infrastructure.
-# End of warning.
+warn "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
+     Use: 'vanagon #{script}' instead."
 
-artifactory_warning = <<-DOC
-  Unable to ship packages to artifactory. Please make sure you are pointing to a
-  recent version of packaging in your Gemfile. Please also make sure you include
-  the artifactory gem in your Gemfile.
-
-  i.e.,
-  gem 'packaging', :github => 'puppetlabs/packaging', branch: '1.0.x'
-  gem 'artifactory'
-DOC
-
-if Dir["output/**/*"].select { |entry| File.file?(entry) }.empty?
-  fail "No packages to ship in the output directory. Maybe you want to build some first?"
-else
-  require 'packaging'
-  Pkg::Util::RakeUtils.load_packaging_tasks
-  Pkg::Util::RakeUtils.invoke_task('pl:jenkins:ship', 'artifacts', 'output')
-  begin
-    Pkg::Util::RakeUtils.invoke_task('pl:jenkins:ship_to_artifactory', 'output')
-  rescue LoadError
-    warn artifactory_warning
-  rescue StandardError
-    warn artifactory_warning
-  end
-end
+exec "vanagon", script, *ARGV

data/bin/sign

@@ -1,15 +1,8 @@
 #!/usr/bin/env ruby
 
-ENV["PROJECT_ROOT"] = Dir.pwd
+script = File.basename($0)
 
-# Begin warning: This sign script is an internal tool.
-# This is not intended to function outside of Puppet Labs' infrastructure.
-# End of warning.
+warn "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
+     Use: 'vanagon #{script}' instead."
 
-if Dir["output/**/*"].select { |entry| File.file?(entry) }.empty?
-  fail "No packages to sign in the output directory. Maybe you want to build some first?"
-end
-
-require 'packaging'
-Pkg::Util::RakeUtils.load_packaging_tasks
-Pkg::Util::RakeUtils.invoke_task('pl:jenkins:sign_all', 'output')
+exec "vanagon", script, *ARGV

data/bin/vanagon

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+load File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "vanagon.rb"))
+
+vanagon = Vanagon::CLI.new
+
+vanagon.run(vanagon.parse(ARGV))

data/lib/vanagon.rb

@@ -8,7 +8,7 @@ VANAGON_VERSION = Gem.loaded_specs["vanagon"].version.to_s
 $:.unshift(LIBDIR) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(LIBDIR)
 
-require 'vanagon/optparse'
+require 'vanagon/cli'
 require 'vanagon/driver'
 
 # The main entry point is {Vanagon::Driver}.

data/lib/vanagon/cli.rb

@@ -0,0 +1,94 @@
+require 'docopt'
+require 'json'
+
+require 'vanagon/extensions/ostruct/json'
+require 'vanagon/extensions/set/json'
+require 'vanagon/extensions/hashable'
+
+require 'vanagon/cli/build'
+require 'vanagon/cli/build_host_info'
+require 'vanagon/cli/build_requirements'
+require 'vanagon/cli/inspect'
+require 'vanagon/cli/render'
+require 'vanagon/cli/ship'
+require 'vanagon/cli/sign'
+
+
+class Vanagon
+  class InvalidArgument < StandardError
+  end
+
+  class CLI
+    DOCUMENTATION = <<~DOCOPT.freeze
+      Usage:
+          vanagon <command> [<args>]...
+
+      Commands are:
+          build               build a package given a project and platform
+          build_host_info     print information about build hosts
+          build_requirements  print external packages required to build project
+          inspect             a build dry-run, printing lots of information about the build
+          render              create local versions of packaging artifacts for project
+          sign                sign a package
+          ship                upload a package to a distribution server
+          help                print this help
+    DOCOPT
+
+    def parse(argv) # rubocop:disable Metrics/AbcSize
+      parsed_options = parse_options(argv)
+      sub_command = parsed_options['<command>']
+      sub_argv = parsed_options['<args>']
+
+      case sub_command
+      when 'build'
+        @sub_parser = Vanagon::CLI::Build.new
+      when 'build_host_info'
+        @sub_parser = Vanagon::CLI::BuildHostInfo.new
+      when 'build_requirements'
+        @sub_parser = Vanagon::CLI::BuildRequirements.new
+      when 'inspect'
+        @sub_parser = Vanagon::CLI::Inspect.new
+      when 'render'
+        @sub_parser = Vanagon::CLI::Render.new
+      when 'sign'
+        @sub_parser = Vanagon::CLI::Sign.new
+      when 'ship'
+        @sub_parser = Vanagon::CLI::Ship.new
+      when 'help'
+        puts DOCUMENTATION
+        exit 0
+      else
+        warn "vanagon: Error: unknown command: \"#{sub_command}\"\n\n#{DOCUMENTATION}"
+        exit 1
+      end
+
+      raw_options = @sub_parser.parse(sub_argv)
+      options = @sub_parser.options_translate(raw_options)
+      @sub_parser.options_validate(options)
+      return options
+    end
+
+    def run(options)
+      @sub_parser.run(options)
+    end
+
+    # Do validation of options
+    def options_validate(options)
+      options
+    end
+
+    # Provide a translation from parsed docopt options to older optparse options
+    def options_translate(docopt_options)
+      docopt_options
+    end
+
+    private
+
+    def parse_options(argv)
+      Docopt.docopt(DOCUMENTATION, { argv: argv, options_first: true })
+    rescue Docopt::Exit => e
+      puts e.message
+      exit 1
+    end
+  end
+end

data/lib/vanagon/cli/build.rb

@@ -0,0 +1,75 @@
+require 'docopt'
+
+class Vanagon
+  class CLI
+    class Build < Vanagon::CLI
+      DOCUMENTATION = <<~DOCOPT.freeze
+        Usage:
+        build [options] <project-name> <platforms> [<targets>]
+
+        Options:
+          -h, --help                       Display help
+          -c, --configdir DIRECTORY        Configuration directory [default: #{Dir.pwd}/configs]
+          -e, --engine ENGINE              Custom engine to use [base, local, docker, pooler] [default: pooler]
+          -o, --only-build COMPONENT,COMPONENT,...
+                                           Only build listed COMPONENTs
+          -p, --preserve [RULE]            Rule for VM preservation: never, on-failure, always
+                                             [Default: always]
+          -r, --remote-workdir DIRECTORY   Working directory on the remote host
+          -s, --skipcheck                  Skip the "check" stage when building components
+          -w, --workdir DIRECTORY          Working directory on the local host
+          -v, --verbose                    Only here for backwards compatibility. Does nothing.
+      DOCOPT
+
+      def parse(argv)
+        Docopt.docopt(DOCUMENTATION, { argv: argv })
+      rescue Docopt::Exit => e
+        puts e.message
+        exit 1
+      end
+
+      def run(options) # rubocop:disable Metrics/AbcSize
+        project = options[:project_name]
+        platform_list = options[:platforms].split(',')
+        target_list = []
+        unless options[:targets].nil? || options[:targets].empty?
+          target_list = options[:targets].split(',')
+        end
+
+        platform_list.zip(target_list).each do |pair|
+          platform, target = pair
+          artifact = Vanagon::Driver.new(platform, project, options.merge({ 'target' => target }))
+          artifact.run
+        end
+      end
+
+      def options_translate(docopt_options)
+        translations = {
+          '--verbose' => :verbose,
+          '--workdir' => :workdir,
+          '--remote-workdir' => :"remote-workdir",
+          '--configdir' => :configdir,
+          '--engine' => :engine,
+          '--skipcheck' => :skipcheck,
+          '--preserve' => :preserve,
+          '--only-build' => :only_build,
+          '<project-name>' => :project_name,
+          '<platforms>' => :platforms,
+          '<targets>' => :targets
+        }
+        return docopt_options.map { |k, v| [translations[k], v] }.to_h
+      end
+
+      def options_validate(options)
+        # Handle --preserve option checking
+        valid_preserves = %w[always never on-failure]
+        unless valid_preserves.include? options[:preserve]
+          raise InvalidArgument, "--preserve option can only be one of: " +
+                                 valid_preserves.join(', ')
+        end
+        options[:preserve] = options[:preserve].to_sym
+        return options
+      end
+    end
+  end
+end

data/lib/vanagon/cli/build_host_info.rb

@@ -0,0 +1,49 @@
+require 'docopt'
+
+class Vanagon
+  class CLI
+    class BuildHostInfo < Vanagon::CLI
+      DOCUMENTATION = <<~DOCOPT.freeze
+        Usage:
+        build_host_info [options] <project-name> <platforms>
+
+        Options:
+          -h, --help                       Display help
+          -c, --configdir DIRECTORY        Configuration directory [default: #{Dir.pwd}/configs]
+          -e, --engine ENGINE              Custom engine to use [base, local, docker, pooler] [default: pooler]
+          -w, --workdir DIRECTORY          Working directory on the local host
+          -v, --verbose                    Only here for backwards compatibility. Does nothing.
+      DOCOPT
+
+      def parse(argv)
+        Docopt.docopt(DOCUMENTATION, { argv: argv })
+      rescue Docopt::Exit => e
+        puts e.message
+        exit 1
+      end
+
+      def run(options)
+        platforms = options[:platforms].split(',')
+        project = options[:project_name]
+
+        platforms.each do |platform|
+          driver = Vanagon::Driver.new(platform, project, options)
+          $stdout.puts JSON.generate(driver.build_host_info)
+        end
+      end
+
+      def options_translate(docopt_options)
+        translations = {
+          '--verbose' => :verbose,
+          '--workdir' => :workdir,
+          '--configdir' => :configdir,
+          '--engine' => :engine,
+          '<project-name>' => :project_name,
+          '<platforms>' => :platforms,
+          '<targets>' => :targets
+        }
+        return docopt_options.map { |k, v| [translations[k], v] }.to_h
+      end
+    end
+  end
+end