sambot 0.1.182 → 0.1.183

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94aae9e6ddf2c5f9ce0bc76ef1ed8c92dc258f39
-  data.tar.gz: 2e1a33dbb5ebbfe5925dbbd6080a85690bcec339
+  metadata.gz: ca69087e447dc0a85bdaae031310f343dcd3312d
+  data.tar.gz: 79762870407593affaa76306276a77c0c69c9534
 SHA512:
-  metadata.gz: 2e50b30a736c1ef80acb2c3d622086009822acc263a9d1315d9819667446d1a393864776533bf864e743a51d5ba4ef45cda3ebcf0288caaab6a9f8751a5bda16
-  data.tar.gz: 06bc1bccb1fcc9963d180edbebe39977762920d70fa0040ff16def8e51219d35d34e9a86aa1eeb226625d47ebcbac899575485c5d8f4984d91e0650bf4a484a1
+  metadata.gz: e1d32393bcf6a9ee217cce5026e4dffd73591a43ef78aee4b4775049f69450a5aeca4bdb88421b971702210094fa886b756abbcf074faef92b4912f0edf1bd1b
+  data.tar.gz: 7807e06b48c2dbe195289b1918d87ba18edfd465677bf7a61404b18ce9ae430bb14701da83ca2d365ac5800e09512bea91dafff4ce41c074bdf894e9f896cfaa

data/lib/sambot/docs/build.txt

@@ -1,3 +1,7 @@
+#################################################################################
+# <SAMBOT> BUILD COMMAND                                                        #
+#################################################################################
+
 This command will generate all the files required for the functioning of a Chef
 cookbook from aconfiguration file. The motivation behind this setup is to
 standardize and simplify the Chef cookbook creation workflow.
@@ -6,19 +10,10 @@ The configuration file should be called .config.yml and stored in the root of
 the Chef cookbook. After the command is run, all the files required to author
 a cookbook will be placed in the same directory as the .config.yml file.
 
-The .config.yml has the following structure:
-
-* name - the name of the cookbook
-
-* version - the version of the cookbook
-
-* platforms - the different platforms the cookbook can run on, centos and/or windows
-
-* description - a description for the cookbook
-
-* suites - the suites attribute that would go into the .kitchen.yml files and should follow exactly that structure
-
 Furthermore, a pre-push Git hook will be generated which will check the cookbook
 files before allowing the origin repository to be updated.
 
-The build command will fail if the file is not present or isn't properly formatted.
+The build command will fail if the .config.yml file is not present or isn't
+properly formatted. To understand the structure of a .config.yml file,
+simply create a new cookbook or take a look at the comments in the
+template file templates/.config.yml.

data/lib/sambot/docs/bump.txt

@@ -1 +1,3 @@
-Nothing yet - please add to this!
+#################################################################################
+# <SAMBOT> BUMP COMMAND                                                         #
+#################################################################################

data/lib/sambot/docs/clean.txt

@@ -1,2 +1,6 @@
+#################################################################################
+# <SAMBOT> CLEAN COMMAND                                                        #
+#################################################################################
+
 This command will remove all files generated by `sambot cookbook build`.
 This is required to ensure the generated files are not stored in source control.

data/lib/sambot/docs/populate.txt

@@ -0,0 +1,7 @@
+#################################################################################
+# <SAMBOT> VERSION COMMAND                                                      #
+#################################################################################
+
+This command will output the version of the cookbook in the current directory.
+
+It is mostly used for CI in order to give TeamCity builds their correct version number.

data/lib/sambot/docs/version.txt

@@ -1,3 +1,3 @@
-This command will output the version of the cookbook in the current directory.
-
-It is mostly used for CI in order to give TeamCity builds their correct version number. 
+#################################################################################
+# <SAMBOT> POPULATE COMMAND                                                     #
+#################################################################################

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

@@ -1,23 +1,50 @@
-# The name of the role or wrapper cookbook. Should be of the form as-role-xxx if a role cookbook
-# and as-xxx if a wrapper cookbook.
+#################################################################################
+# COOKBOOK CONFIGURATION                                                        #
+#################################################################################
+---
+#################################################################################
+# The name of the role or wrapper cookbook. Should be of the form               #
+# as-role-name if a role cookbook and as-name if a wrapper cookbook.            #
+#################################################################################
 name: <%= @config.name %>
-# The cookbook version. It will be added to the metadata.rb and needs to be incremented whenenver
-# a new cookbook version needs to be pushed to the Chef Server.
+#################################################################################
+# The cookbook version. It will be added to the metadata.rb and needs to be     #
+# incremented whenever a new cookbook version needs to be pushed to the Chef    #
+# Server.                                                                       #
+#################################################################################
 version: 0.0.1
-# The different platforms on which this cookbook can run. This dictates the contents of the .kitchen files
-# and which files are generated for the cookbook. The values can be 'centos', 'windows' or both.
+#################################################################################
+# The different platforms on which this cookbook can run. This dictates the     #
+# contents of the .kitchen files and which files are generated for the          #
+# cookbook. The values can be 'centos', 'windows' or both.                      #
+#################################################################################
 platforms:
 <% @config.available_platforms.each do |platform| %>
 - <%= platform %>
 <% end %>
-# An array of gems to be added to the metadata.rb file.
+#################################################################################
+# An array of gems to be added to the metadata.rb file.                         #
+#################################################################################
 gems:
-# The identifier used when generating instance names. Not yet implemented but in future, if the
-# identifier is OCTPS for example, a typical instance name would be OCTPS03-W8.
+#################################################################################
+# The identifier used when generating instance names. Not yet implemented but   #
+# in future, if the identifier is OCTPS for example, a typical instance name    #
+# would be OCTPS03-W8.                                                          #
+#################################################################################
 identifier: <%= @config.identifier %>
-# The description o fthe cookbook that will go into the metadata.rb.
+#################################################################################
+# The cookbooks on which this cookbook depends.                                 #
+#################################################################################
+dependencies:
+#################################################################################
+# The description for the cookbook that will go into the metadata.rb.           #
+#################################################################################
 description: <%= @config.description %>
-# The test suites that will be added to the .kitchen files.
+#################################################################################
+# TEST-KITCHEN SUITES                                                           #
+# The content underneath will be added as-is to the Test-Kitchen configuration  #
+# file i.e. .kitchen.yml.                                                       #
+#################################################################################
 suites:
   - name: default
     # The runlist for a specific suite can either be the same across all environments i.e. cloud or local or can
@@ -42,3 +69,43 @@ suites:
       inspec_tests:
       - name: <%= @config.name %>-profile
         git: git@github.exacttarget.com:ads-chef-profiles/<%= @name %>-profile.git
+#################################################################################
+# LOCAL TESTING CONFIGURATION                                                   #
+#################################################################################
+local_testing:
+  ###############################################################################
+  # Provides a list of recipes which will be run before the normal run-list     #
+  # when testing locally. These recipes are not run when testing in the DEV     #
+  # environment or when deploying a real instance so should only be used for    #
+  # setting things up locally.
+  ###############################################################################
+  recipes:
+  ###############################################################################
+  # Provides a a set of attributes which will be applied when running Chef      #
+  # locally. The following attributes are automatically added to the Chef run   #
+  # when using Test-Kitchen file:                                               #
+  # node['default']['cloud_platform'] = '$PLATFORM'                             #
+  # where $PLATFORM is either LOCAL, GCP or RACKSPACE, depending on the         #
+  # environment where Test-Kitchen is running.                                  #
+  ###############################################################################
+  attributes:
+  #   some:
+  #     attribute: value
+  ###############################################################################
+  # Provides secrets to be stored in the Docker Vault instance. Make sure the   #
+  # paths you set below are congruent with any attribute overrides you've set   #
+  # above. These secrets can be added to the Docker Vault instance by running   #
+  # `sambot populate`.                                                          #
+  # To read a file and store it in Vault i.e. a SSH key, prefix the value       #
+  # with 'file::' and place the file in the 'local_testing' folder of the       #
+  # cookbook.                                                                   #
+  ###############################################################################
+  secrets:
+  # - description: A random secret example
+  #   path: dev/nightswatch/my/secret
+  #   keys:
+  #   - value: my-data
+  # - description: Another random secret example
+  #   path: dev/nightswatch/my/file_secret
+  #   keys:
+  #   - value: file::privatekey.pem

data/lib/sambot/templates/.gitignore.sample

@@ -36,3 +36,5 @@ Vagrantfile.erb
 *bootstrap.sh
 *bootstrap.ps1
 .DS_Store
+.env
+docker-compose.yml

data/lib/sambot/templates/.rubocop.yml

@@ -7,5 +7,5 @@ Style/MutableConstant:
   Exclude:
     - recipes/linux_chefdk_setup.rb
 
-Layout/EmptyLinesAroundBlockBody:
+Style/EmptyLinesAroundBlockBody:
   Enabled: false

data/lib/sambot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sambot
-  VERSION = '0.1.182'.freeze
+  VERSION = '0.1.183'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sambot
 version: !ruby/object:Gem::Version
-  version: 0.1.182
+  version: 0.1.183
 platform: ruby
 authors:
 - Olivier Kouame
@@ -400,6 +400,7 @@ files:
 - lib/sambot/docs/bump.txt
 - lib/sambot/docs/clean.txt
 - lib/sambot/docs/create.txt
+- lib/sambot/docs/populate.txt
 - lib/sambot/docs/version.txt
 - lib/sambot/fs.rb
 - lib/sambot/runtime.rb