vanagon 0.16.0 → 0.19.0

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

data/lib/vanagon/cli/inspect.rb

@@ -1,5 +1,6 @@
 require 'docopt'
 require 'json'
+require 'vanagon/logger'
 
 class Vanagon
   class CLI
@@ -11,18 +12,26 @@ 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]
 
           -p, --preserve [RULE]            Rule for VM preservation: never, on-failure, always
                                              [Default: on-failure]
           -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
 
@@ -33,7 +42,7 @@ class Vanagon
         platforms.each do |platform|
           driver = Vanagon::Driver.new(platform, project, options)
           components = driver.project.components.map(&:to_hash)
-          $stdout.puts JSON.pretty_generate(components)
+          VanagonLogger.warn JSON.pretty_generate(components)
         end
       end
 

data/lib/vanagon/cli/list.rb

@@ -0,0 +1,74 @@
+require 'docopt'
+require 'vanagon/logger'
+
+class Vanagon
+  class CLI
+    class List < Vanagon::CLI
+      DOCUMENTATION = <<~DOCOPT.freeze
+        Usage:
+          list [options]
+
+        Options:
+          -h, --help                       Display help
+          -c, --configdir DIRECTORY        Configuration directory [default: #{Dir.pwd}/configs]
+          -l, --platforms                  Display a list of platforms
+          -r, --projects                   Display a list of projects
+          -s, --use-spaces                 Displays the list as space separated
+      DOCOPT
+
+      def parse(argv)
+        Docopt.docopt(DOCUMENTATION, { argv: argv })
+      rescue Docopt::Exit => e
+        VanagonLogger.error e.message
+        exit 1
+      end
+
+      def output(list, use_spaces)
+        return list.join(' ') if use_spaces
+        return list
+      end
+
+      def run(options) # rubocop:disable Metrics/AbcSize
+        if Dir.exist?(File.join(options[:configdir], 'platforms')) == false ||
+           Dir.exist?(File.join(options[:configdir], 'projects')) == false
+
+          VanagonLogger.error "Path to #{File.join(options[:configdir], 'platforms')} or #{File.join(options[:configdir], 'projects')} not found."
+          exit 1
+        end
+
+        platform_list = Dir.children(File.join(options[:configdir], 'platforms')).map do |platform|
+          File.basename(platform, File.extname(platform))
+        end
+
+        project_list = Dir.children(File.join(options[:configdir], 'projects')).map do |project|
+          File.basename(project, File.extname(project))
+        end
+
+        if options[:projects] == options[:platforms]
+          puts "- Projects", output(project_list, options[:use_spaces]), "\n", "- Platforms", output(platform_list, options[:use_spaces])
+          return
+        end
+
+        if options[:projects]
+          puts "- Projects", output(project_list, options[:use_spaces])
+          return
+        end
+
+        if options[:platforms]
+          puts "- Platforms", output(platform_list, options[:use_spaces])
+          return
+        end
+      end
+
+      def options_translate(docopt_options)
+        translations = {
+          '--configdir' => :configdir,
+          '--platforms' => :platforms,
+          '--projects' => :projects,
+          '--use-spaces' => :use_spaces,
+        }
+        return docopt_options.map { |k, v| [translations[k], v] }.to_h
+      end
+    end
+  end
+end

data/lib/vanagon/cli/render.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
 

data/lib/vanagon/cli/ship.rb

@@ -1,4 +1,5 @@
 require 'docopt'
+require 'vanagon/logger'
 
 class Vanagon
   class CLI
@@ -11,10 +12,10 @@ class Vanagon
           -h, --help                       Display help
       DOCOPT
 
-      def self.parse(argv)
+      def parse(argv)
         Docopt.docopt(DOCUMENTATION, { argv: argv })
       rescue Docopt::Exit => e
-        puts e.message
+        VanagonLogger.error e.message
         exit 1
       end
 
@@ -32,7 +33,7 @@ class Vanagon
         DOC
 
         if Dir['output/**/*'].select { |entry| File.file?(entry) }.empty?
-          warn 'vanagon: Error: No packages to ship in the "output" directory. Maybe build some first?'
+          VanagonLogger.error 'vanagon: Error: No packages to ship in the "output" directory. Maybe build some first?'
           exit 1
         end
 
@@ -42,9 +43,9 @@ class Vanagon
         begin
           Pkg::Util::RakeUtils.invoke_task('pl:jenkins:ship_to_artifactory', 'output')
         rescue LoadError
-          warn artifactory_warning
+          VanagonLogger.error artifactory_warning
         rescue StandardError
-          warn artifactory_warning
+          VanagonLogger.error artifactory_warning
         end
       end
     end

data/lib/vanagon/cli/sign.rb

@@ -1,4 +1,5 @@
 require 'docopt'
+require 'vanagon/logger'
 
 class Vanagon
   class CLI
@@ -14,14 +15,14 @@ class Vanagon
       def parse(argv)
         Docopt.docopt(DOCUMENTATION, { argv: argv })
       rescue Docopt::Exit => e
-        puts e.message
+        VanagonLogger.error e.message
         exit 1
       end
 
       def run(_)
         ENV['PROJECT_ROOT'] = Dir.pwd
         if Dir['output/**/*'].select { |entry| File.file?(entry) }.empty?
-          warn 'sign: Error: No packages to sign in the "output" directory. Maybe build some first?'
+          VanagonLogger.error 'sign: Error: No packages to sign in the "output" directory. Maybe build some first?'
           exit 1
         end
 

data/lib/vanagon/component.rb

@@ -3,6 +3,8 @@ require 'vanagon/component/rules'
 require 'vanagon/component/source'
 require 'vanagon/component/source/rewrite'
 
+require 'vanagon/logger'
+
 class Vanagon
   class Component
     include Vanagon::Utilities
@@ -138,9 +140,9 @@ class Vanagon
       dsl.instance_eval(File.read(compfile), compfile, 1)
       dsl._component
     rescue StandardError => e
-      warn "Error loading project '#{name}' using '#{compfile}':"
-      warn e
-      warn e.backtrace.join("\n")
+      VanagonLogger.error "Error loading project '#{name}' using '#{compfile}':"
+      VanagonLogger(e)
+      VanagonLogger.error e.backtrace.join("\n")
       raise e
     end
 
@@ -254,18 +256,18 @@ class Vanagon
     def fetch_mirrors(options)
       mirrors.to_a.shuffle.each do |mirror|
         begin
-          warn %(Attempting to fetch from mirror URL "#{mirror}")
+          VanagonLogger.info %(Attempting to fetch from mirror URL "#{mirror}")
           @source = Vanagon::Component::Source.source(mirror, options)
           return true if source.fetch
         rescue SocketError
           # SocketError means that there was no DNS/name resolution
           # for whatever remote protocol the mirror tried to use.
-          warn %(Unable to resolve mirror URL "#{mirror}")
+          VanagonLogger.error %(Unable to resolve mirror URL "#{mirror}")
         rescue RuntimeError
           # Source retrieval does not consistently return a meaningful
           # namespaced error message, which means we're brute-force rescuing
           # RuntimeError. Not a good look, and we should fix this.
-          warn %(Unable to retrieve mirror URL "#{mirror}")
+          VanagonLogger.error %(Unable to retrieve mirror URL "#{mirror}")
         end
       end
       false
@@ -277,7 +279,7 @@ class Vanagon
     # @return [Boolean] return True if the source can be retrieved,
     #   or False otherwise
     def fetch_url(options)
-      warn %(Attempting to fetch from canonical URL "#{url}")
+      VanagonLogger.info %(Attempting to fetch from canonical URL "#{url}")
       @source = Vanagon::Component::Source.source(url, options)
       # Explicitly coerce the return value of #source.fetch,
       # because each subclass of Vanagon::Component::Source returns
@@ -319,7 +321,7 @@ class Vanagon
           @version ||= source.version
         end
       else
-        warn "No source given for component '#{@name}'"
+        VanagonLogger.info "No source given for component '#{@name}'"
 
         # If there is no source, we don't want to try to change directories, so we just change to the current directory.
         @dirname = './'
@@ -407,7 +409,7 @@ class Vanagon
     # @return [String] environment suitable for inclusion in a Makefile
     # @deprecated
     def get_environment
-      warn <<-WARNING.undent
+      VanagonLogger.info <<-WARNING.undent
         #get_environment is deprecated; environment variables have been moved
         into the Makefile, and should not be used within a Makefile's recipe.
         The #get_environment method will be removed by Vanagon 1.0.0.

data/lib/vanagon/component/dsl.rb

@@ -1,4 +1,5 @@
 require 'vanagon/component'
+require 'vanagon/logger'
 require 'vanagon/patch'
 require 'ostruct'
 require 'json'
@@ -131,8 +132,8 @@ class Vanagon
       # component
       #
       # @param requirement [String] a package that is required at runtime for this component
-      def requires(requirement)
-        @component.requires << requirement
+      def requires(requirement, version = nil)
+        @component.requires << OpenStruct.new(:requirement => requirement, :version => version)
       end
 
       # Indicates that this component replaces a system level package. Replaces can be collected and used by the project and package.
@@ -237,7 +238,7 @@ class Vanagon
 
         if @component.platform.is_windows?
           unless mode.nil? && owner.nil? && group.nil?
-            warn "You're trying to set the mode, owner, or group for windows. I don't know how to do that, ignoring!"
+            VanagonLogger.info "You're trying to set the mode, owner, or group for windows. I don't know how to do that, ignoring!"
           end
         else
           mode ||= '0644'
@@ -407,7 +408,7 @@ class Vanagon
         install_flags = ['-d']
         if @component.platform.is_windows?
           unless mode.nil? && owner.nil? && group.nil?
-            warn "You're trying to set the mode, owner, or group for windows. I don't know how to do that, ignoring!"
+            VanagonLogger.info "You're trying to set the mode, owner, or group for windows. I don't know how to do that, ignoring!"
           end
         else
           install_flags << "-m '#{mode}'" unless mode.nil?
@@ -422,7 +423,7 @@ class Vanagon
       # @param env [Hash] mapping of keys to values to add to the environment for the component
       def environment(*env)
         if env.size == 1 && env.first.is_a?(Hash)
-          warn <<-WARNING.undent
+          VanagonLogger.info <<-WARNING.undent
             the component DSL method signature #environment({Key => Value}) is deprecated
             and will be removed by Vanagon 1.0.0.