vanagon 0.17.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e09a1563ed504da68687d85b7c7a70e62028b7d1ba24568476d5cae338ae1ebf
-  data.tar.gz: 9da1804bfbf40c86ac845ccf60a76c133b217357117dcd22d43d97c35299aa1d
+  metadata.gz: 6fb1135d000a2b468d3a998b6ef1e7547d26f835d06b67f2ba502fb710d1f06b
+  data.tar.gz: ffac33c290bc103a851d8bc9f468ec8a838465ac0e12125446c86a2b22cbde9e
 SHA512:
-  metadata.gz: 19591339a372853aa653311214de761ead6dfd173218d68c0086691ede75da8d981079408afaf04e5fd362e2c9250c72ac9b1cb8cc3fdbeb16006a6510707176
-  data.tar.gz: 74e995f55e05778820809bbed4c2dcd501896a8d4894e1a38921bb8057cee049d62c42e136e8929c84c9609790738d77be356ed55b499974b3399c6a032d724c
+  metadata.gz: 388e8520c4231c89b4170d3f99ac590caea60e98ebe5ccd2a0b5cee159c595b80b897d45c91dfda3b063da2c636420ae1c8e96a52eb87b17fef1d99d8848ba15
+  data.tar.gz: 1ca438d9b68285bfcf8b269d1fe8217736bad75d868ecb7452fac4a499dab15d3eae8200ab9a4860763c0a5217335f17b4f7561ce58c0984f331356be594607a

data/README.md

@@ -197,8 +197,8 @@ Port of the system where redis is running. Defaults to *6379*.
 ##### `VANAGON_USE_MIRRORS`
 Controls whether component sources are downloaded directly from upstream URLs
 or from configured mirrors. Most Puppet projects using Vanagon default to
-fetching components from internal mirrors. Set this variable to `n` when
-building outside of the Puppet private network to download directly from
+fetching components from internal mirrors. Set this variable to `n` or `false`
+when building outside of the Puppet private network to download directly from
 upstream sources.
 
 ##### `VANAGON_RETRY_COUNT`

data/bin/build

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
 
+require 'vanagon/logger'
+
 script = File.basename($0)
 
-warn "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
+VanagonLogger.info "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
      Use: 'vanagon #{script}' instead."
 
 exec "vanagon", script, *ARGV

data/bin/build_host_info

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
 
+require 'vanagon/logger'
+
 script = File.basename($0)
 
-warn "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
+VanagonLogger.info "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
      Use: 'vanagon #{script}' instead."
 
 exec "vanagon", script, *ARGV

data/bin/build_requirements

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
 
+require 'vanagon/logger'
+
 script = File.basename($0)
 
-warn "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
+VanagonLogger.info "#{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,8 +1,10 @@
 #!/usr/bin/env ruby
 
+require 'vanagon/logger'
+
 script = File.basename($0)
 
-warn "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
+VanagonLogger.info "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
      Use: 'vanagon #{script}' instead."
 
 exec "vanagon", script, *ARGV

data/bin/render

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
 
+require 'vanagon/logger'
+
 script = File.basename($0)
 
-warn "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
+VanagonLogger.info "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
      Use: 'vanagon #{script}' instead."
 
 exec "vanagon", script, *ARGV

data/bin/repo

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+require 'vanagon/logger'
+
 ENV["PROJECT_ROOT"] = Dir.pwd
 
 # Begin warning: This ship script is an internal tool.
@@ -21,7 +23,7 @@ when 'rpm'
 when 'deb'
   Pkg::Util::RakeUtils.invoke_task('pl:jenkins:deb_repos')
 when 'none'
-  $stdout.puts "Skipping repo generation since repo target is set to 'none'"
+  VanagonLogger.warn "Skipping repo generation since repo target is set to 'none'"
 else
   Pkg::Util::RakeUtils.invoke_task('pl:jenkins:rpm_repos')
   Pkg::Util::RakeUtils.invoke_task('pl:jenkins:deb_repos')

data/bin/ship

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
 
+require 'vanagon/logger'
+
 script = File.basename($0)
 
-warn "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
+VanagonLogger.info "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
      Use: 'vanagon #{script}' instead."
 
 exec "vanagon", script, *ARGV

data/bin/sign

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
 
+require 'vanagon/logger'
+
 script = File.basename($0)
 
-warn "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
+VanagonLogger.info "#{script}: Warning: use of stand alone '#{script}' command is deprecated and may be removed.
      Use: 'vanagon #{script}' instead."
 
 exec "vanagon", script, *ARGV

data/extras/completions/vanagon.bash

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+
+_vanagon()
+{
+  local cur prev projects commands template_arg_commands 
+
+  # COMREPLY is an array variable used to store completions  
+  # the completion mechanism uses COMPRELY to display its contents as completions
+  # COMP_WORDS is an array of all the words typed after the name of the program 
+  # COMP_CWORD is an index of the COMP_WORDS array pointing to the current word
+  COMPREPLY=()
+  cur="${COMP_WORDS[COMP_CWORD]}"
+  prev="${COMP_WORDS[COMP_CWORD-1]}"
+  projects=($({ vanagon list -r | sed 1d; } 2>/dev/null))
+  commands="build build_host_info build_requirements completion inspect list render sign ship help"
+  template_arg_commands="build build_host_info build_requirements inspect render "
+
+  # completes with a project if the previous word was a command in template_arg_commands
+  if [[ $template_arg_commands =~ (^| )$prev($| ) ]] ; then
+      _vanagon_avail_templates_projects=$({ vanagon list -r | sed 1d; } 2>/dev/null)
+      # compgen generates completions filtered based on what has been typed by the user
+      COMPREPLY=( $(compgen -W "${_vanagon_avail_templates_projects}" -- "${cur}") )
+  fi 
+
+  # allows multiple platforms to be tab completed 
+  if [[ ${#COMP_WORDS[@]} -gt 3 ]] ; then 
+    _vanagon_avail_templates_platforms=$({ vanagon list -l | sed 1d; } 2>/dev/null)
+    COMPREPLY=( $(compgen -W "${_vanagon_avail_templates_platforms}" -- "${cur}") )
+  fi
+
+  if [[ $1 == $prev ]] ; then
+    # only show top level commands we are at root
+    COMPREPLY=( $(compgen -W "${commands}" -- "${cur}") )
+  fi
+}
+
+# assign tab complete function `_vanagon ` to `vanagon` command 
+complete -F _vanagon vanagon

data/extras/completions/vanagon.zsh

@@ -0,0 +1,41 @@
+_vanagon()
+{
+  local line commands template_arg_commands projects
+
+  commands="build build_host_info build_requirements completion inspect list render sign ship help"
+  template_arg_commands=("build" "build_host_info" "build_requirements" "inspect"  "render")
+  projects=($({ vanagon list -r | sed 1d; } 2>/dev/null))
+
+  # '%p:globbed-files:' sets completion to only offer files matching a 
+  # described pattern.
+  zstyle ':completion:*' file-patterns '%p:globbed-files:'
+  
+  # arguments function provides potential completions to zsh 
+  # specs are of the form n:message:action 
+  _arguments -C \
+    ": :(${commands})" \
+    "*::arg:->args" 
+
+  # (Ie)prevents "invalid subscript"
+  if ((template_arg_commands[(Ie)$line[1]])); then
+    _vanagon_template_sub_projects
+  fi
+  if [[ $projects  =~ (^| )$line[2]($| ) ]]; then
+    _vanagon_template_sub_platforms
+  fi
+}
+
+_vanagon_template_sub_projects()
+{
+  # -W look in certain path but don't append path to tab compelte 
+  # -g enables file matching pattern 
+  # (:r) removes the file extension `.rb` from the completion 
+  _arguments "1: :_files -W $(PWD)/configs/projects/ -g '*.rb(:r)'"
+}
+
+_vanagon_template_sub_platforms()
+{
+  _arguments "*: :_files -W $(PWD)/configs/platforms/ -g '*.rb(:r)'"
+}
+# compdef registeres the completion function: compdef <function-name> <program>
+compdef _vanagon vanagon

data/lib/vanagon/cli.rb

@@ -8,11 +8,15 @@ require 'vanagon/extensions/hashable'
 require 'vanagon/cli/build'
 require 'vanagon/cli/build_host_info'
 require 'vanagon/cli/build_requirements'
+require 'vanagon/cli/completion'
 require 'vanagon/cli/inspect'
+require 'vanagon/cli/list'
 require 'vanagon/cli/render'
 require 'vanagon/cli/ship'
 require 'vanagon/cli/sign'
 
+require 'vanagon/logger'
+
 
 class Vanagon
   class InvalidArgument < StandardError
@@ -27,7 +31,9 @@ class Vanagon
           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
+          completion          outputs path to tab completion script
           inspect             a build dry-run, printing lots of information about the build
+          list                shows a list of available projects and platforms
           render              create local versions of packaging artifacts for project
           sign                sign a package
           ship                upload a package to a distribution server
@@ -46,10 +52,14 @@ class Vanagon
         @sub_parser = Vanagon::CLI::BuildHostInfo.new
       when 'build_requirements'
         @sub_parser = Vanagon::CLI::BuildRequirements.new
+      when 'completion'
+        @sub_parser = Vanagon::CLI::Completion.new
       when 'inspect'
         @sub_parser = Vanagon::CLI::Inspect.new
       when 'render'
         @sub_parser = Vanagon::CLI::Render.new
+      when 'list'
+        @sub_parser = Vanagon::CLI::List.new
       when 'sign'
         @sub_parser = Vanagon::CLI::Sign.new
       when 'ship'
@@ -58,7 +68,7 @@ class Vanagon
         puts DOCUMENTATION
         exit 0
       else
-        warn "vanagon: Error: unknown command: \"#{sub_command}\"\n\n#{DOCUMENTATION}"
+        VanagonLogger.error "vanagon: Error: unknown command: \"#{sub_command}\"\n\n#{DOCUMENTATION}"
         exit 1
       end
 
@@ -87,7 +97,7 @@ class Vanagon
     def parse_options(argv)
       Docopt.docopt(DOCUMENTATION, { argv: argv, options_first: true })
     rescue Docopt::Exit => e
-      puts e.message
+      VanagonLogger.error e.message
       exit 1
     end
   end

data/lib/vanagon/cli/build.rb

@@ -1,4 +1,5 @@
 require 'docopt'
+require 'vanagon/logger'
 
 class Vanagon
   class CLI
@@ -10,7 +11,7 @@ class Vanagon
         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]
+          -e, --engine ENGINE              Custom engine to use [default: always_be_scheduling]
           -o, --only-build COMPONENT,COMPONENT,...
                                            Only build listed COMPONENTs
           -p, --preserve [RULE]            Rule for VM preservation: never, on-failure, always
@@ -19,12 +20,20 @@ class Vanagon
           -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.
+
+        Engines:
+          always_be_scheduling: default engine using Puppet's ABS infrastructure
+          docker: a docker container on the local host
+          ec2: an Amazon EC2 instance
+          hardware: a dedicated hardware device
+          local: the local machine, cannot be used with a target
+          pooler: [deprecated] Puppet's vmpooler
       DOCOPT
 
       def parse(argv)
         Docopt.docopt(DOCUMENTATION, { argv: argv })
       rescue Docopt::Exit => e
-        puts e.message
+        VanagonLogger.error e.message
         exit 1
       end
 
@@ -38,7 +47,7 @@ class Vanagon
 
         platform_list.zip(target_list).each do |pair|
           platform, target = pair
-          artifact = Vanagon::Driver.new(platform, project, options.merge({ 'target' => target }))
+          artifact = Vanagon::Driver.new(platform, project, options.merge({ :target => target }))
           artifact.run
         end
       end

data/lib/vanagon/cli/build_host_info.rb

@@ -1,4 +1,5 @@
 require 'docopt'
+require 'vanagon/logger'
 
 class Vanagon
   class CLI
@@ -10,15 +11,23 @@ class Vanagon
         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]
+          -e, --engine ENGINE              Custom engine to use [default: always_be_scheduling]
           -w, --workdir DIRECTORY          Working directory on the local host
           -v, --verbose                    Only here for backwards compatibility. Does nothing.
+
+        Engines:
+          always_be_scheduling: default engine using Puppet's ABS infrastructure
+          docker: a docker container on the local host
+          ec2: an Amazon EC2 instance
+          hardware: a dedicated hardware device
+          local: the local machine, cannot be used with a target
+          pooler: [deprecated] Puppet's vmpooler
       DOCOPT
 
       def parse(argv)
         Docopt.docopt(DOCUMENTATION, { argv: argv })
       rescue Docopt::Exit => e
-        puts e.message
+        VanagonLogger.error e.message
         exit 1
       end
 
@@ -28,7 +37,7 @@ class Vanagon
 
         platforms.each do |platform|
           driver = Vanagon::Driver.new(platform, project, options)
-          $stdout.puts JSON.generate(driver.build_host_info)
+          VanagonLogger.warn JSON.generate(driver.build_host_info)
         end
       end
 

data/lib/vanagon/cli/build_requirements.rb

@@ -1,5 +1,6 @@
 require 'docopt'
 require 'json'
+require 'vanagon/logger'
 
 class Vanagon
   class CLI
@@ -11,15 +12,23 @@ class Vanagon
         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]
+          -e, --engine ENGINE              Custom engine to use [default: always_be_scheduling]
           -w, --workdir DIRECTORY          Working directory on the local host
           -v, --verbose                    Only here for backwards compatibility. Does nothing.
+
+        Engines:
+          always_be_scheduling: default engine using Puppet's ABS infrastructure
+          docker: a docker container on the local host
+          ec2: an Amazon EC2 instance
+          hardware: a dedicated hardware device
+          local: the local machine, cannot be used with a target
+          pooler: [deprecated] Puppet's vmpooler
       DOCOPT
 
       def parse(argv)
         Docopt.docopt(DOCUMENTATION, { argv: argv })
       rescue Docopt::Exit => e
-        puts e.message
+        VanagonLogger.error e.message
         exit 1
       end
 
@@ -39,9 +48,8 @@ class Vanagon
           end
         end
 
-        $stdout.puts
-        $stdout.puts "**** External packages required to build #{project} on #{platform}: ***"
-        $stdout.puts JSON.pretty_generate(build_requirements.flatten.uniq.sort)
+        VanagonLogger.warn "**** External packages required to build #{project} on #{platform}: ***"
+        VanagonLogger.warn JSON.pretty_generate(build_requirements.flatten.uniq.sort)
       end
 
       def options_translate(docopt_options)

data/lib/vanagon/cli/completion.rb

@@ -0,0 +1,44 @@
+require 'docopt'
+require 'vanagon/logger'
+
+class Vanagon
+  class CLI
+    class Completion < Vanagon::CLI
+      DOCUMENTATION = <<~DOCOPT.freeze
+        Usage:
+          completion [options]
+
+        Options:
+          -h, --help                       Display help
+          -s, --shell SHELL                Specify shell for completion script [default: bash]
+      DOCOPT
+
+      def parse(argv)
+        Docopt.docopt(DOCUMENTATION, { argv: argv })
+      rescue Docopt::Exit => e
+        VanagonLogger.error e.message
+        exit 1
+      end
+
+      def run(options)
+        shell = options[:shell].downcase.strip
+        completion_file = File.expand_path(File.join('..', '..', '..', '..', 'extras', 'completions', "vanagon.#{shell}"), __FILE__)
+
+        if File.exist?(completion_file)
+          VanagonLogger.warn completion_file
+          exit 0
+        else
+          VanagonLogger.error "Could not find completion file for '#{shell}': No such file #{completion_file}"
+          exit 1
+        end
+      end
+
+      def options_translate(docopt_options)
+        translations = {
+          '--shell' => :shell,
+        }
+        return docopt_options.map { |k, v| [translations[k], v] }.to_h
+      end
+    end
+  end
+end