sambot 0.1.69 → 0.1.83

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51c431904343df42faaf16c519b84a78274d0523
-  data.tar.gz: 0a49af56edb773ae663c2a9f868270b75f8064bf
+  metadata.gz: a37d00724675ee46fdcf68b9ee7cdb2d1382d954
+  data.tar.gz: f5109307d67e54161b76ae51ee00e8ad4efe767c
 SHA512:
-  metadata.gz: 93ae2180f67a75a58e13534dceef64499a8bf4912e367e80b5e406caf4f9276e610918dab9075a93e31cd840d8533a5e8d9911c85bec84e951842ed5686a979e
-  data.tar.gz: 848bc4ae662bb690e05ffdfff4999a81bad9984d16db873bf9d3f464c44aa21619fc5973e93d79b6bcd0acf392c7f59efffcc0b12c5b3a2a1a6ef4d7987889b5
+  metadata.gz: 76dcfeb1c4f34cd18c03483011b78eb23dd015d18529227f6f24e0a50dfc23bfb7bc488cb0c03a02024470f4c209c0a1ef3d33341f13a62e00d15ea130202328
+  data.tar.gz: '08bfa75fda01edd760e02431c29fd960df0e0fc0de7b8645fe0c69949f08e5fa0db11ea39e958ec6af92751b8ed4651beef67319cf0235022ed4dc68f9997e67'

data/lib/sambot/cli.rb

@@ -1,35 +1,33 @@
 require 'thor'
-require_relative 'domain/common/application_exception'
+require_relative 'domain/common/application_error'
 require_relative 'domain/common/file_checker'
-require_relative 'domain/secrets/vault'
-require_relative 'domain/workstations/hosts'
-require_relative 'domain/workstations/env'
-require_relative 'domain/workstations/ssh_config_file'
-require_relative 'domain/workstations/ssh_config_section'
-require_relative 'domain/workstations/ssh_parser'
-require_relative 'domain/common/ui'
 require_relative 'domain/common/config'
 require_relative 'domain/common/runtime'
 require_relative 'domain/common/template_provider'
-require_relative 'domain/cookbooks/kitchen'
-require_relative 'domain/cookbooks/assistant_chef'
-require_relative 'domain/cookbooks/metadata'
+require_relative 'domain/chef/kitchen'
+require_relative 'domain/chef/metadata'
+require_relative 'domain/ssh/config_file'
+require_relative 'domain/ssh/config_section'
+require_relative 'domain/ssh/parser'
+require_relative 'domain/bastion_host'
+require_relative 'domain/dns'
+require_relative 'domain/session'
+require_relative 'domain/vault'
+require_relative 'domain/ui'
+require_relative 'domain/cookbook'
+require_relative 'domain/workstation'
 require_relative 'commands/cookbook'
-require_relative 'commands/secret'
-require_relative 'commands/teamcity'
+require_relative 'commands/session'
 require_relative 'commands/workstation'
 
 module Sambot
   class CLI < Thor
 
-    desc 'teamcity', 'Manage TeamCity'
-    subcommand 'teamcity', Sambot::Commands::TeamCity
-
     desc 'cookbook', 'Manage Chef cookbooks'
     subcommand 'cookbook', Sambot::Commands::Cookbook
 
-    desc 'secret', 'Manage secrets inside Chef cookbooks'
-    subcommand 'secret', Sambot::Commands::Secret
+    desc 'session', 'Manage sessions'
+    subcommand 'session', Sambot::Commands::Session
 
     desc 'workstation', 'Manage engineer workstations'
     subcommand 'workstation', Sambot::Commands::Workstation

data/lib/sambot/commands/cookbook.rb

@@ -6,64 +6,82 @@ module Sambot
 
     class Cookbook < Thor
 
-      include Domain::Common::UI
-      include Domain::Common::Runtime
+      Runtime = Sambot::Domain::Common::Runtime
+      ApplicationError = Sambot::Domain::Common::ApplicationError
+
+      GUIDE =
+      {
+        clean: {
+          SHORT_DESC: 'Remove all generated build files from a cookbook',
+          LONG_DESC:  <<-LONGDESC
+          `sambot cookbook clean` will remove all files generated by `sambot cookbook build`.
+          This is required to ensure the generated files are not stored in source control.
+          LONGDESC
+        },
+        build: {
+          SHORT_DESC: 'Builds a cookbook from its configuration file',
+          LONG_DESC:  <<-LONGDESC
+          `sambot cookbook build` will generate all the files required for the functioning
+          of a Chef cookbook from a configuration file. The motivation behind this setup is to
+          standardize and simplify the Chef cookbook creation workflow. The configuration file should be
+          called .config.yml and stored in the root of the Chef cookbook.
+          LONGDESC
+        },
+        generate: {
+          SHORT_DESC: 'Creates a new cookbook',
+          LONG_DESC: <<-LONGDESC
+          `sambot cookbook generate` will create a new cookbook. This can be either a
+          wrapper cookbook or an instance role cookbook.
+          LONGDESC
+        },
+        version: {
+          SHORT_DESC: 'Gives the cookbook version as a TeamCity service message',
+          LONG_DESC: ''
+        }
+      }
 
       namespace 'cookbook'
 
-      desc 'clean', 'Remove all generated build files from a cookbook'
-      long_desc <<-LONGDESC
-        `sambot cookbook clean` will remove all files generated by `sambot cookbook build`.
-        This is required to ensure the generated files are not stored in source control.
-      LONGDESC
+      desc 'clean', GUIDE[:clean][:SHORT_DESC]
+      long_desc GUIDE[:clean][:LONG_DESC]
       def clean
-        ensure_latest
-        info('Removing all generated files from this cookbook.')
-        modified_files = Sambot::Domain::Cookbooks::AssistantChef.new.clean_cookbook(GENERATED_FILES - ['.gitignore'])
-        modified_files.each {|file| debug("./#{file} has been removed.")}
-        info('The cookbook has been successfully cleaned.')
-      rescue Domain::Common::ApplicationException => e
+        Runtime.ensure_latest
+        Domain::Cookbook.clean(GENERATED_FILES - ['.gitignore'])
+      rescue ApplicationError => e
         error(e.message)
       end
 
-      desc 'build', 'Builds a cookbook from its configuration file'
-      long_desc <<-LONGDESC
-        `sambot cookbook build` will generate all the files required for the functioning
-        of a Chef cookbook from a configuration file. The motivation behind this setup is to
-        standardize and simplify the Chef cookbook creation workflow. The configuration file should be
-        called .config.yml and stored in the root of the Chef cookbook.
-      LONGDESC
+      desc 'build', GUIDE[:clean][:SHORT_DESC]
+      long_desc GUIDE[:clean][:LONG_DESC]
       def build
-        ensure_latest
-        modified_files = Domain::Cookbooks::AssistantChef.new.build_cookbook(ESSENTIAL_FILES, GENERATED_FILES)
-        modified_files.each {|file| debug("./#{file} has been added to the cookbook.")}
-        info('The cookbook has been successfully built.')
-      rescue Domain::Common::ApplicationException => e
+        Runtime.ensure_latest
+        Domain::Cookbook.build(ESSENTIAL_FILES, GENERATED_FILES)
+      rescue ApplicationError => e
         error(e.message)
       end
 
-      desc 'generate', 'Creates a new cookbook'
-      long_desc <<-LONGDESC
-        `sambot cookbook generate` will create a new cookbook. This can be either a
-        wrapper cookbook or an instance role cookbook.
-      LONGDESC
+      desc 'generate', GUIDE[:generate][:SHORT_DESC]
+      long_desc GUIDE[:generate][:LONG_DESC]
       def generate()
-        ensure_latest
+        Runtime.ensure_latest
         name = ask(' What is the name of this cookbook?')
         description = ask(' What does this cookbook do?')
-        platform = ask(' What operating system will this cookbook run on?', :limited_to => ['windows', 'linux'])
+        platforms = ask(' What operating system will this cookbook run on?', :limited_to => ['windows', 'centos', 'both'])
         type = ask(' What type of cookbook will this be?', :limited_to => ['wrapper', 'role'])
-        Sambot::Domain::Cookbooks::AssistantChef.new.generate_cookbook(name, platform, type, description, ESSENTIAL_FILES, GENERATED_FILES)
-        info('The cookbook has been successfully generated.')
-      rescue Domain::Common::ApplicationException => e
+        platforms = platforms == 'both' ? ['centos', 'windows'] : [platforms]
+        Domain::Cookbook.generate(name, platforms, type, description, ESSENTIAL_FILES, GENERATED_FILES)
+      rescue ApplicationError => e
         error(e.message)
       end
 
-      desc 'version', 'Gives the cookbook version as a TeamCity service message'
+      desc 'version', GUIDE[:version][:SHORT_DESC]
+      long_desc GUIDE[:version][:LONG_DESC]
       def version()
-        result = Domain::Common::Config.new.read
-        puts result.inspect
+        Runtime.ensure_latest
+        result = Domain::Common::Config.read
         puts "##teamcity[buildNumber '#{result['version'].to_s}']"
+      rescue ApplicationError => e
+        error(e.message)
       end
 
     end

data/lib/sambot/commands/packer.rb

@@ -0,0 +1,21 @@
+module Sambot
+  module Commands
+
+    class Packer < Thor
+
+      ApplicationError = Sambot::Domain::Common::ApplicationError
+      Runtime = Sambot::Domain::Common::Runtime
+
+      namespace 'packer'
+
+      desc "prepare", "Sets up a Packer configuration"
+      def prepare
+        Runtime.ensure_latest
+        Domain::Packer.prepare
+      rescue ApplicationError => e
+        error(e.message)
+      end
+
+    end
+  end
+end

data/lib/sambot/commands/session.rb

@@ -3,18 +3,28 @@ module Sambot
 
     class Session < Thor
 
+      ApplicationError = Sambot::Domain::Common::ApplicationError
+      Runtime = Sambot::Domain::Common::Runtime
+
       namespace 'session'
 
       desc "start", "Start a new DEV/QE session"
       def start
-        username = ask('What is your DEV/QE username?')
-        password = ask('What is your DEV/QE password?')
-        puts "not implemented"
+        Runtime.ensure_latest
+        username = ask(' What is your DEV/QE username i.e. jsmith? ')
+        password = ask(' What is your DEV/QE password? ', :echo => false)
+        say('')
+        Domain::Session.start(username, password)
+      rescue ApplicationError => e
+        error(e.message)
       end
 
       desc "stop", "Stop the DEV/QE session"
-      def start
-        puts "not implemented"
+      def stop
+        Runtime.ensure_latest
+        Domain::Session.stop()
+      rescue ApplicationError => e
+        error(e.message)
       end
 
     end

data/lib/sambot/commands/workstation.rb

@@ -3,19 +3,17 @@ module Sambot
 
     class Workstation < Thor
 
+      Runtime = Sambot::Domain::Common::Runtime
+
       namespace 'workstation'
 
-      desc "cnfigure", "Sets up an engineering workstation"
+      desc "configure", "Sets up an engineering workstation"
       def configure
-        username = ask("What is your DEV/QE Active Directory username i.e. john.smith?")
-        debug("Updating your SSH configuration.")
-        config = Domain::Workstations::SshParser.new.update('DEV\\' + username)
-        config.save
-        debug("Updating your environment variables.")
-        Domain::Workstations::Env.new.update
-        debug("Generating the datasource for Free Remote Desktop Manager, your RDP client.")
-        filename = Domain::Workstations::Hosts.new.generate
-        info("Your workstation is now ready for use. The RDM datasource is available here: #{filename}")
+        Runtime.ensure_latest
+        username = ask(" What is your DEV/QE Active Directory username i.e. john.smith? ")
+        Domain::Workstation.configure(username)
+      rescue ApplicationError => e
+        error(e.message)
       end
 
     end

data/lib/sambot/domain/bastion_host.rb

@@ -0,0 +1,59 @@
+require 'awesome_print'
+require 'process_exists'
+
+module Sambot
+  module Domain
+    class BastionHost
+
+      ApplicationError = Sambot::Domain::Common::ApplicationError
+      Parser = Sambot::Domain::Ssh::Parser
+
+      def self.connect(username, password)
+        disconnect
+        cmd = "sshpass -p #{password} ssh -N -f -l DEV\\\\#{username} bastion "
+        success = system(cmd)
+        sleep(3)
+        unless success
+          raise ApplicationError.new('Unable to open SSH tunnels to the bastion host')
+        end
+        self
+      end
+
+      def self.forwards(config_file = nil)
+        config = ConfigFile.new(config_file)
+        []
+      end
+
+      def self.disconnect()
+        close_tunnels(list_tunnels)
+      end
+
+      def self.close_tunnels(tunnels)
+        if tunnels
+          tunnels.each do |tunnel|
+            components = tunnel.split(' ')
+            pid = components[1].to_i
+            parse_forwards.each do |forward|
+              if components[8] == forward && components[9] == '(LISTEN)' && Process.exists?(pid)
+                Process.kill('INT', pid)
+                UI.debug("The process #{pid}, parent of the tunnel #{forward}, has been killed.")
+              end
+            end
+          end
+        end
+      end
+
+      def self.parse_forwards
+        Parser::ENTRIES[:bastion][:LocalForward].map do |entry|
+          "127.0.0.1:#{entry.split(' ')[0]}"
+        end
+      end
+
+      def self.list_tunnels
+        result = `lsof -i -n -P | grep -E '^ssh'`
+        result.split(/\n/)
+      end
+
+    end
+  end
+end

data/lib/sambot/domain/chef/kitchen.rb

@@ -0,0 +1,39 @@
+module Sambot
+  module Domain
+    module Chef
+      class Kitchen
+
+        KITCHEN_LOCAL_YML = ".kitchen.yml"
+        KITCHEN_GCP_YML = ".kitchen.gcp.yml"
+        KITCHEN_RACKSPACE_YML = ".kitchen.rackspace.yml"
+
+
+        def self.generate_yml(cookbook_name, platforms, suites = nil)
+          raise ApplicationError, 'Missing platforms when trying to generate Test-Kitchen YAML.' unless platforms
+          raise ApplicationError, 'Missing cookbook name when trying to generate Test-Kitchen YAML.' unless cookbook_name
+          test_kitchen_configs = {
+            "#{KITCHEN_LOCAL_YML}": read_template(KITCHEN_LOCAL_YML, cookbook_name, platforms),
+            "#{KITCHEN_GCP_YML}": read_template(KITCHEN_GCP_YML, cookbook_name, platforms),
+            "#{KITCHEN_RACKSPACE_YML}": read_template(KITCHEN_RACKSPACE_YML, cookbook_name, platforms)
+          }
+          test_kitchen_configs.each do |key, value|
+            value['suites'] = suites if suites
+            test_kitchen_configs[key] = value.to_yaml
+          end
+          test_kitchen_configs
+        end
+
+        private
+
+        def self.read_template(template, cookbook_name, platforms)
+          filename = File.join(TemplateProvider.get_path("#{template}.erb"))
+          contents = File.read(filename).gsub(/@@cookbook_name@@/, cookbook_name)
+          eruby = Erubis::Eruby.new(contents)
+          yaml = eruby.evaluate({platforms: platforms}).gsub(/\_@/, "<%=").gsub(/@\_/, "%>")
+          YAML.load(yaml)
+        end
+
+      end
+    end
+  end
+end

data/lib/sambot/domain/{cookbooks → chef}/metadata.rb

@@ -2,23 +2,24 @@ require 'erubis'
 
 module Sambot
   module Domain
-    module Cookbooks
+    module Chef
       class Metadata
 
-        def generate(name, platform, version, description, dependencies = nil)
+        def self.generate(name, platforms, version, description, dependencies = nil, gems = nil)
           context = {
             'cookbook_name' => name,
-            'cookbook_platform' => platform,
+            'cookbook_platforms' => platforms,
             'cookbook_version' => version,
             'cookbook_description' => description,
-            'cookbook_dependencies' => dependencies
+            'cookbook_dependencies' => dependencies,
+            'cookbook_gems' => gems,
           }
           generate_metadata(context)
         end
 
         private
 
-        def generate_metadata(context)
+        def self.generate_metadata(context)
           filename = File.join(File.dirname(__FILE__), '../../templates', 'metadata.rb.erb')
           input = File.read(filename)
           eruby = Erubis::Eruby.new(input)

data/lib/sambot/domain/common/{application_exception.rb → application_error.rb}

@@ -1,7 +1,7 @@
 module Sambot
   module Domain
     module Common
-      class ApplicationException < RuntimeError
+      class ApplicationError < RuntimeError
 
       end
     end

data/lib/sambot/domain/common/config.rb

@@ -9,13 +9,20 @@ module Sambot
 
         def read(path = nil)
           path ||= File.join(Dir.getwd, CONFIGURATION_FILENAME)
-          raise ApplicationException, "The configuration file was not found at #{path}." unless File.exist?(path)
+          raise ApplicationError, "The configuration file was not found at #{path}." unless File.exist?(path)
           config = YAML.load_file(path)
-          raise ApplicationException, 'Missing cookbook name in the .config.yml configuration file' unless config['name']
-          raise ApplicationException, 'Missing platform in the .config.yml configuration file' unless config['platform']
-          raise ApplicationException, 'Missing version in the .config.yml configuration file' unless config['version']
-          raise ApplicationException, 'Missing list of suites in the .config.yml configuration file' unless config['suites']
-          raise ApplicationException, 'Missing description in the .config.yml configuration file' unless config['description']
+          raise ApplicationError, 'Missing cookbook name in the .config.yml configuration file' unless config['name']
+          raise ApplicationError, 'Missing platforms in the .config.yml configuration file' unless config['platform'] || config['platforms']
+          raise ApplicationError, 'Missing version in the .config.yml configuration file' unless config['version']
+          raise ApplicationError, 'Missing list of suites in the .config.yml configuration file' unless config['suites']
+          raise ApplicationError, 'Missing description in the .config.yml configuration file' unless config['description']
+          # Dealing with legacy tech debt of allowing multiple platforms rather than a single platform
+          unless config['platforms']
+            unless config['platform'].kind_of?(Array)
+              config['platform'] = [config['platform']]
+            end
+            config['platforms'] = config['platform']
+          end
           config
         end
 

data/lib/sambot/domain/common/file_checker.rb

@@ -5,7 +5,7 @@ module Sambot
 
         def verify(path)
           return if File.exist?(path) || Dir.exist?(path)
-          raise ApplicationException, "The file or directory #{path} was not found in the current directory."
+          raise ApplicationError, "The file or directory #{path} was not found in the current directory."
         end
 
         def update(files)
@@ -19,7 +19,7 @@ module Sambot
 
         def update_template(filename)
           working_path = filename.end_with?(".erb") ? filename.gsub(/\.erb/, '') : filename
-          template_path = TemplateProvider.new.get_path(filename)
+          template_path = TemplateProvider.get_path(filename)
           File.delete(working_path) if File.exist?(working_path)
           if template_path.end_with?(".erb")
             input = File.read(template_path)
@@ -34,6 +34,7 @@ module Sambot
           else
             FileUtils.cp(template_path, working_path)
           end
+          UI.debug("#{working_path} has been added to the cookbook.")
         end
 
       end