sambot 0.1.115 → 0.1.117

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5742c77c94b4e5245f39774393981f03f2aad332
-  data.tar.gz: 11a5ecc8000f096f24c2068c3d3f872c85de457a
+  metadata.gz: 5410b3c608857a6491424bf29399106cf7023930
+  data.tar.gz: 529645ac3268d9f87102f4e0311f1368d368d4c0
 SHA512:
-  metadata.gz: 3ee54c2067a11ba0ef302fc21f599b7ce8d5630789ac437a854956a710670b344a0906b11cd95b74625f4cd721e5f2ec3f37a667fdb209f042ebb34617108935
-  data.tar.gz: 8e766dbb6b0f1ea7988c273ff7d9ec7f2468aa0e46dbec6ad46ed07d893eba45c4e0423eae5299750ade13dcbeefca56c872581bb295b3cfd730449cb4039952
+  metadata.gz: 1903dee501f46a5658f80a318e957ef75919d1799e65874b1fa99037c106825a4def5f509c38afcefaca9e03669dddb9b088ba29bb78747a2531c4d13f17a7b2
+  data.tar.gz: f1960f6ebcb4b8b699f344da6314cb6ba10446d3357f80f1bb2b2e41f224124a440d82461996b0cba451934b7f744715f81a7836057b508f28840ddbfc65277d

data/lib/sambot/chef/cookbook.rb

@@ -7,100 +7,65 @@ module Sambot
   module Chef
     class Cookbook
 
-        def self.register(config)
-          name = config['name']
-          identifier = config['identifier']
-          
-        end
+      ESSENTIAL_FILES = [
+        '.config.yml',
+        'recipes',
+        'README.md'
+      ].freeze
+
+      GENERATED_FILES = {
+        'teamcity.sh.erb': {eruby: true, dest: 'teamcity.sh', platform: [:windows, :centos]},
+        'chefignore': {eruby: false, dest: 'chefignore', platform: [:windows, :centos]},
+        'Berksfile': {eruby: false, dest: 'Berksfile', platform: [:windows, :centos]},
+        '.rubocop.yml': {eruby: false, dest: '.rubocop.yml', platform: [:windows, :centos]},
+        '.gitignore.sample': {eruby: false, dest: '.gitignore', platform: [:windows, :centos]},
+        'bootstrap.sh': {eruby: false, dest: 'bootstrap.sh', platform: [:centos]},
+        'bootstrap.ps1': {eruby: false, dest: 'bootstrap.ps1', platform: [:windows]},
+        'Vagrantfile.erb': {eruby: false, dest: 'Vagrantfile.erb', platform: [:windows, :centos]},
+        'winrm_config': {eruby: false, dest: 'winrm_config', platform: [:windows]}
+      }
+
+      CHEF_ARTEFACTS = ['Berksfile.lock']
+
+      KITCHEN_FILES_PATTERN = '\.kitchen*\.yml'
+
+      class << self
 
-        def self.build(config, essential_files, generated_files)
-          validate_cookbook_structure(config['platforms'], essential_files, generated_files)
-          setup_test_kitchen(config)
-          build_metadata(config)
-          copy_git_hooks()
+        def build(config)
+          Generator.from_templates(config['platforms'], ESSENTIAL_FILES, GENERATED_FILES)
+          Kitchen.setup(config)
+          Metadata.generate(config)
+          Hooks.copy()
           UI.info('The cookbook has been successfully built.')
         end
 
-        def self.clean(generated_files)
+        def clean()
           UI.info('Removing all generated files from this cookbook.')
-          targets = ['metadata.rb', 'winrm_config', 'Berksfile.lock'] + generated_files + Dir.glob('\.kitchen*\.yml')
-          targets.each do |file|
-            delete_file(file)
-          end
+          targets = ['metadata.rb', 'Berksfile.lock'] + GENERATED_FILES.map{ |key, val| val[:dest]} + Dir.glob(KITCHEN_FILES_PATTERN) - ['.gitignore']
+          targets.each { |file| delete(file) }
           UI.info('The cookbook has been successfully cleaned.')
         end
 
-        def self.generate(config, name, platforms, type, description, essential_files, generated_files)
-          Git.init(name)
-          Dir.chdir(name) do
-            ['test', 'spec', 'recipes'].each {|target|  FileUtils.mkdir(target) }
+        def generate(config)
+          Git.init(config[:name])
+          Dir.chdir(config[:name]) do
+            ['test', 'spec', 'recipes'].each {|target| FileUtils.mkdir(target) }
             FileUtils.touch('README.md')
-            write_config(name, description, platforms, type)
-            build(config, essential_files, generated_files)
+            Template.new('.config.yml.erb').write(config, '.config.yml')
+            UI.debug("./.config.yml has been added to the cookbook.")
           end
           UI.info('The cookbook has been successfully generated.')
         end
 
         private
 
-        def self.write_config(name, description, platforms, type)
-          contents = {
-            'name' => name,
-            'version' => '0.0.1',
-            'platforms' => platforms,
-            'identifier' => '',
-            'suites' => [{
-              'name' => 'default',
-              'run_list' => [
-                "recipe[#{name}]"
-              ],
-              'verifier' => {
-                'inspec_tests' => ['./test']
-              }
-            }],
-            'description' => description,
-          }.to_yaml
-          File.write('.config.yml', contents)
-          UI.debug("./.config.yml has been added to the cookbook.")
-        end
-
-        def self.copy_git_hooks
-          working_path = '.git/hooks/pre-push'
-          template_path = FileManagement::TemplateProvider.get_path('pre-push')
-          File.delete(working_path) if File.exist?(working_path)
-          FileUtils.cp(template_path, working_path)
-          UI.debug("The pre-push Git hook has been added to the cookbook.")
-        end
-
-        def self.delete_file(filename)
-          filename = filename.gsub(/\.erb/, '') if filename.end_with?(".erb")
+        def delete(filename)
           return unless File.exist?(filename)
           File.delete(filename)
           UI.debug("./#{filename} has been removed.")
         end
 
-        def self.validate_cookbook_structure(platform, essential_files, generated_files)
-          essential_files.each { |path| FileManagement::FileChecker.new.verify(path) }
-          if platform.include?('windows')
-            FileManagement::FileChecker.new.update(['winrm_config'])
-          end
-          FileManagement::FileChecker.new.update(generated_files)
-        end
-
-        def self.setup_test_kitchen(config)
-          files = Chef::Kitchen.generate_yml(config['name'], config['platforms'], config['suites'])
-          files.each do |filename, contents|
-            File.write(filename.to_s, contents)
-            UI.debug("#{filename.to_s} has been added to the cookbook.")
-          end
-        end
-
-        def self.build_metadata(config)
-          result = Chef::Metadata.generate(config['name'], config['platforms'], config['version'], config['description'], config['dependencies'], config['gems'])
-          File.write('metadata.rb', result)
-          UI.debug("A new metadata.rb file has been generated.")
-        end
-
       end
+    end
   end
 end

data/lib/sambot/chef/generator.rb

@@ -0,0 +1,53 @@
+#frozen_string_literal: true
+
+module Sambot
+    module Chef
+      class Generator
+
+        def self.from_templates(platforms, cookbook_essentials, cookbook_generated_files)
+          cookbook_essentials.each { |path| exists!(path) } if cookbook_essentials
+          cookbook_generated_files.each do |template_name, opts|
+            generate_from_template(template_name.to_s, opts, platforms)
+          end
+        end
+
+        private
+
+        def self.exists!(path)
+          return if File.exist?(path) || Dir.exist?(path)
+          raise ApplicationError, "The file or directory #{path} was not found in the current directory."
+        end
+
+        def self.generate_from_template(template_file, opts, platforms)
+          UI.debug("Processing #{template_file} with opts #{opts.inspect} on platform #{platforms}")
+          template = Template.new(template_file)
+          if valid_platform?(opts, platforms)
+            File.delete(opts[:dest]) if File.exist?(opts[:dest])
+            if opts[:eruby]
+              UI.debug("Parsing #{template.path} using Erubis")
+              template.write({}, opts[:dest])
+            else
+              FileUtils.cp(template.path, opts[:dest].to_s)
+            end
+            if File.executable?(template.path)
+              UI.debug("Making #{opts[:dest]} executable")
+              make_executable(template.path, opts[:dest])
+            end
+            UI.debug("#{opts[:dest]} has been added to the cookbook.")
+          end
+        end
+
+        def self.valid_platform?(opts, platforms)
+          targets = opts[:platform].map { |x| x.to_s}
+          result = targets & platforms
+          result.size > 0
+        end
+
+        def self.make_executable(file, working_path)
+          current_mask = File.stat(file).mode
+          new_mask = current_mask | '0000000000000001'.to_i(2)
+          File.chmod(new_mask, working_path)
+        end
+      end
+  end
+end

data/lib/sambot/chef/hooks.rb

@@ -0,0 +1,17 @@
+#frozen_string_literal: true
+
+module Sambot
+    module Chef
+      class Hooks
+
+        def self.copy
+          working_path = '.git/hooks/pre-push'
+          template_path = Template.new('pre-push').path
+          File.delete(working_path) if File.exist?(working_path)
+          FileUtils.cp(template_path, working_path)
+          UI.debug("The pre-push Git hook has been added to the cookbook.")
+        end
+
+      end
+  end
+end

data/lib/sambot/chef/kitchen.rb

@@ -4,49 +4,62 @@ module Sambot
     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|
-            if suites
-              value['suites'] = Marshal.load(Marshal.dump(suites))
-              case key.to_s
-              when KITCHEN_GCP_YML
-                value['suites'].each do |config|
-                  config['attributes'] = config['attributes'] || {}
-                  config['attributes']['cloud_platform'] = 'GCP'
-                end
-              when KITCHEN_RACKSPACE_YML
-                value['suites'].each do |config|
-                  config['attributes'] = config['attributes'] || {}
-                  config['attributes']['cloud_platform'] = 'RACKSPACE'
+        LOCAL = '.kitchen.yml'
+        GCP = '.kitchen.gcp.yml'
+        RACKSPACE = '.kitchen.rackspace.yml'
+
+        class << self
+
+          def setup(config)
+            files = generate_yml(config['name'], config['platforms'], config['suites'])
+            files.each do |filename, contents|
+              File.write(filename.to_s, contents)
+              UI.debug("#{filename.to_s} has been added to the cookbook.")
+            end
+          end
+
+          def 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 = {
+              "#{LOCAL}": read_template(LOCAL, cookbook_name, platforms),
+              "#{GCP}": read_template(GCP, cookbook_name, platforms),
+              "#{RACKSPACE}": read_template(RACKSPACE, cookbook_name, platforms)
+            }
+            test_kitchen_configs.each do |key, value|
+              if suites
+                value['suites'] = Marshal.load(Marshal.dump(suites))
+                case key.to_s
+                when LOCAL
+                  add_platform_identifier(value, 'LOCAL')
+                when GCP
+                  add_platform_identifier(value, 'GCP')
+                when RACKSPACE
+                  add_platform_identifier(value, 'RACKSPACE')
                 end
               end
+              test_kitchen_configs[key] = value.to_yaml
             end
-            test_kitchen_configs[key] = value.to_yaml
+            test_kitchen_configs
           end
-          test_kitchen_configs
-        end
 
-        private
+          private
 
-        def self.read_template(template, cookbook_name, platforms)
-          filename = File.join(FileManagement::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
+          def add_platform_identifier(value, platform)
+            value['suites'].each do |config|
+              config['attributes'] = config['attributes'] || {}
+              config['attributes']['cloud_platform'] = platform
+            end
+          end
+
+          def read_template(template, cookbook_name, platforms)
+            result = Template.new("#{template}.erb").evaluate({platforms: platforms}) do |contents|
+              contents.gsub(/@@cookbook_name@@/, cookbook_name)
+            end
+            YAML.load(result.gsub(/\_@/, '<%=').gsub(/@\_/, '%>'))
+          end
 
       end
+    end
   end
 end

data/lib/sambot/chef/metadata.rb

@@ -3,37 +3,39 @@
 require 'erubis'
 
 module Sambot
-    module Chef
-      class Metadata
-
-        TemplateProvider = FileManagement::TemplateProvider
-
-        def self.generate(name, platforms, version, description, dependencies = nil, gems = nil)
-
-          if dependencies
-            dependencies = dependencies.map { |x| x.is_a?(Hash) ? "#{x.keys.first}', '#{x.values.first}" : x }
-          end
-
-          context = {
-            'cookbook_name' => name,
-            'cookbook_platforms' => platforms,
-            'cookbook_version' => version,
-            'cookbook_description' => description,
-            'cookbook_dependencies' => dependencies,
-            'cookbook_gems' => gems,
-          }
-          generate_metadata(context)
+  module Chef
+    class Metadata
+
+      class << self
+
+        def generate(config, dest = 'metadata.rb')
+          write({
+            'cookbook_name' => config['name'],
+            'cookbook_platforms' => config['platforms'],
+            'cookbook_version' => config['version'],
+            'cookbook_description' => config['description'],
+            'cookbook_dependencies' => map_dependencies(config),
+            'cookbook_gems' => config['gems'] || [],
+          }, dest)
         end
 
         private
 
-        def self.generate_metadata(context)
-          filename = TemplateProvider.get_path('metadata.rb.erb')
-          input = File.read(filename)
-          eruby = Erubis::Eruby.new(input)
-          eruby.evaluate(context)
+        def map_dependencies(config)
+          config['dependencies'] ? config['dependencies'].map { |x| transform_hashes(x) } : []
+        end
+
+        def transform_hashes(obj)
+          obj.is_a?(Hash) ? "#{obj.keys.first}', '#{obj.values.first}" : obj
+        end
+
+        def write(ctx, dest)
+          template = Sambot::Template.new('metadata.rb.erb').write(ctx, dest)
+          UI.debug("A new metadata.rb file has been generated.")
         end
 
       end
+
+    end
   end
 end

data/lib/sambot/cli.rb

@@ -1,16 +1,20 @@
 # frozen_string_literal: true
 
+require_relative 'commands/cookbook_cmd'
+require_relative 'commands/session_cmd'
+require_relative 'commands/workstation_cmd'
+
 module Sambot
   class CLI < Thor
 
     desc 'cookbook', 'Manage Chef cookbooks'
-    subcommand 'cookbook', Sambot::Commands::Cookbook
+    subcommand 'cookbook', Sambot::Commands::CookbookCmd
 
     desc 'session', 'Manage sessions'
-    subcommand 'session', Sambot::Commands::Session
+    subcommand 'session', Sambot::Commands::SessionCmd
 
     desc 'workstation', 'Manage engineer workstations'
-    subcommand 'workstation', Sambot::Commands::Workstation
+    subcommand 'workstation', Sambot::Commands::WorkstationCmd
 
   end
 end

data/lib/sambot/commands/base_command.rb

@@ -60,15 +60,25 @@ module Sambot
 
       no_commands do
 
+        def missing_credentials(need_dev_credentials, need_sudo_password)
+          return true if need_dev_credentials && (!ENV['SAMBOT_DEV_USERNAME'] && !ENV['SAMBOT_DEV_PASSWORD'])
+          return need_sudo_password && !ENV['SAMBOT_SUDO_PASSWORD']
+        end
+
         def execute(need_dev_credentials: false, need_sudo_password: false)
+          if missing_credentials(need_dev_credentials, need_sudo_password)
+            UI.info("Sambot will need to make some secure operations on your behalf. You can provide your credentials below or set them as environment variables:")
+          end
           if need_dev_credentials && !ENV['SAMBOT_DEV_USERNAME']
-            raise ApplicationError, 'Your DEV/QE username needs to be set in the environment variable SAMBOT_DEV_USERNAME before this command can be run.'
+            ENV['SAMBOT_DEV_USERNAME'] = UI.ask("Please provide your DEV/QE AD username: ")
           end
           if need_dev_credentials && !ENV['SAMBOT_DEV_PASSWORD']
-            raise ApplicationError, 'Your DEV/QE password needs to be set in the environment variable SAMBOT_DEV_PASSWORD before this command can be run.'
+            ENV['SAMBOT_DEV_USERNAME'] = UI.ask_password("Please provide your DEV/QE AD password: ")
+            puts "\n"
           end
           if need_sudo_password && !ENV['SAMBOT_SUDO_PASSWORD']
-            raise ApplicationError, 'Your local password needs to be set in the environment variable SAMBOT_SUDO_PASSWORD before this command can be run.'
+            ENV['SAMBOT_DEV_USERNAME'] = UI.ask_password("Please provide your sudo password - this is required for operations such as setting up your local SSH tunnels: ")
+            puts "\n"
           end
           Runtime.ensure_latest
           yield

data/lib/sambot/commands/cookbook_cmd.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'base_command'
+require_relative '../chef/cookbook'
+
+module Sambot
+  module Commands
+
+    class CookbookCmd < BaseCommand
+
+      namespace 'cookbook'
+
+      desc 'clean', 'Remove all generated build files from a cookbook'
+      def clean
+        execute { Chef::Cookbook.clean() }
+      end
+
+      desc 'build', 'Builds a cookbook from its configuration file'
+      def build
+        execute { Chef::Cookbook.build(config) }
+      end
+
+      desc 'generate', 'Creates a new cookbook'
+      def generate
+        execute do
+          config = {
+            name: ask(' What is the name of this cookbook?'),
+            type: ask(' What type of cookbook will this be?', :limited_to => ['wrapper', 'role']),
+            platforms: ask(' What operating system will this cookbook run on?', :limited_to => ['windows', 'centos', 'both']),
+            description: ask(' What does this cookbook do?')
+          }
+          config[:identifier] = ask(' What will be the unique machiner identifier for this role cookbook?') if config[:type] == 'role'
+          config[:platforms] = config[:platforms] == 'both' ? ['centos', 'windows'] : [config[:platforms]]
+          Chef::Cookbook.generate(config)
+        end
+      end
+
+      desc 'version', 'Gives the cookbook version as a TeamCity service message'
+      def version
+        execute { puts "##teamcity[buildNumber '#{config['version'].to_s}']" }
+      end
+
+    end
+  end
+end

data/lib/sambot/commands/session_cmd.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'base_command'
+require_relative '../workflow/session'
+
+module Sambot
+  module Commands
+    class SessionCmd < BaseCommand
+
+      namespace 'session'
+
+      desc 'start', 'Start a new Sambot session'
+      def start
+        execute(need_dev_credentials: true, need_sudo_password: true) do
+          Workflow::Session.new.start(ENV['SAMBOT_DEV_USERNAME'], ENV['SAMBOT_DEV_PASSWORD'], ENV['SAMBOT_SUDO_PASSWORD'])
+        end
+      end
+
+      desc 'stop', 'Stop any active Sambot session'
+      def stop
+        execute(need_sudo_password: true) { Workflow::Session.new.stop }
+      end
+
+    end
+  end
+end

data/lib/sambot/commands/{workstation.rb → workstation_cmd.rb}

@@ -1,15 +1,18 @@
 # frozen_string_literal: true
 
+require_relative 'base_command'
+require_relative '../workflow/workstation'
+
 module Sambot
   module Commands
-    class Workstation < BaseCommand
+    class WorkstationCmd < BaseCommand
 
       namespace 'workstation'
 
       desc 'configure', 'Sets up an engineering workstation'
       def configure
         execute(need_dev_credentials: true, need_sudo_password: true) do
-          DeveloperWorkflow::Workstation.configure(ENV['SAMBOT_DEV_PASSWORD'])
+          Workflow::Workstation.configure(ENV['SAMBOT_DEV_PASSWORD'])
         end
       end
 

data/lib/sambot/dns/records.rb

@@ -59,9 +59,9 @@ module Sambot
             if commit_changes
               commit_msg = "DNS update for hostname #{hostname}"
               `commit -am #{commit_msg}`
+              `git push`
             end
           end
-          `git push`
         end
       end
 

data/lib/sambot/template.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Sambot
+  class Template
+
+    def initialize(filename)
+      @filename = filename
+    end
+
+    def path
+      File.expand_path(File.join(File.dirname(__FILE__), 'templates', @filename))
+    end
+
+    def evaluate(context = {})
+      input = File.read(path)
+      input = yield(input) if block_given?
+      eruby = Erubis::Eruby.new(input)
+      eruby.evaluate(context)
+    end
+
+    def write(ctx, dest)
+      contents = evaluate(ctx)
+      File.write(dest, contents)
+    end
+
+  end
+end

data/lib/sambot/templates/.config.yml.erb

@@ -0,0 +1,16 @@
+name: <%= @name %>
+version: 0.0.1
+platforms:
+<% @platforms.each do |platform| %>
+- <%= platform %>
+<% end %>
+identifier: <%= @identifier %>
+description: <%= @description %>
+suites:
+  - name: default
+    run_list:
+      - recipe[<%= @name %>::default]
+    verifier:
+      inspec_tests:
+      - name: <%= @name %>-profile
+        git: git@github.exacttarget.com:ads-chef-profiles/<%= @name %>-profile.git

data/lib/sambot/templates/.kitchen.yml.erb

@@ -1,6 +1,10 @@
 ---
 driver:
   name: "vagrant"
+  synced_folders:
+    - [".", "/vagrant"]
+  provision: true
+  vagrantfile_erb: Vagrantfile.erb
 
 provisioner:
   name: chef_zero
@@ -12,11 +16,16 @@ provisioner:
 platforms:
 <% if @platforms.include?('centos') %>
   - name: "centos-7.2"
+    driver:
+     network:
+      - ["private_network", {ip: "192.168.255.10"}]
 <% end %>
 <% if @platforms.include?('windows') %>
   - name: windows-2012R2
-    driver_config:
+    driver:
       box: salesforce/Server2012R2
+      network:
+       - ["private_network", {ip: "192.168.255.11"}]
     transport:
       name: winrm
       elevated: true