vanagon 0.15.37 → 0.18.0

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.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,102 @@
+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/completion'
+require 'vanagon/cli/inspect'
+require 'vanagon/cli/list'
+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
+          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
+          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 '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'
+        @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,83 @@
+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 [default: always_be_scheduling]
+          -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.
+
+        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
+        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,57 @@
+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 [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
+        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

data/lib/vanagon/cli/build_requirements.rb

@@ -0,0 +1,68 @@
+require 'docopt'
+require 'json'
+
+class Vanagon
+  class CLI
+    class BuildRequirements < Vanagon::CLI
+      DOCUMENTATION = <<~DOCOPT.freeze
+        Usage:
+        build_requirements [options] <project-name> <platform>
+
+        Options:
+          -h, --help                       Display help
+          -c, --configdir DIRECTORY        Configuration directory [default: #{Dir.pwd}/configs]
+          -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
+        exit 1
+      end
+
+      def run(options) # rubocop:disable Metrics/AbcSize
+        platform = options[:platform]
+        project = options[:project_name]
+        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 |requirement|
+            # only include external requirements: i.e. those that do not match
+            # other components in the project
+            component_names.include?(requirement)
+          end
+        end
+
+        $stdout.puts
+        $stdout.puts "**** External packages required to build #{project} on #{platform}: ***"
+        $stdout.puts JSON.pretty_generate(build_requirements.flatten.uniq.sort)
+      end
+
+      def options_translate(docopt_options)
+        translations = {
+          '--verbose' => :verbose,
+          '--workdir' => :workdir,
+          '--configdir' => :configdir,
+          '--engine' => :engine,
+          '<project-name>' => :project_name,
+          '<platform>' => :platform,
+        }
+        return docopt_options.map { |k, v| [translations[k], v] }.to_h
+      end
+    end
+  end
+end

data/lib/vanagon/cli/completion.rb

@@ -0,0 +1,43 @@
+require 'docopt'
+
+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
+        puts 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)
+          puts completion_file
+          exit 0
+        else
+          puts "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

@@ -0,0 +1,73 @@
+require 'docopt'
+require 'json'
+
+class Vanagon
+  class CLI
+    class Inspect < Vanagon::CLI
+      DOCUMENTATION = <<~DOCOPT.freeze
+        Usage:
+        inspect [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 [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
+        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)
+          components = driver.project.components.map(&:to_hash)
+          $stdout.puts JSON.pretty_generate(components)
+        end
+      end
+
+      def options_translate(docopt_options)
+        translations = {
+          '--verbose' => :verbose,
+          '--workdir' => :workdir,
+          '--configdir' => :configdir,
+          '--engine' => :engine,
+          '--preserve' => :preserve,
+          '<project-name>' => :project_name,
+          '<platforms>' => :platforms
+        }
+        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