cheflow 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2898d4933067abfd83277a8f5ba628af3e6c1671
-  data.tar.gz: 1570eefa27ab411e2929a9350f6dae56de9267a8
+  metadata.gz: 2cad60057a95b60c4ca9da1c46c06cc495c8bbf8
+  data.tar.gz: d9649b15a0084e3bfaa4e22daf979a09e114dbe7
 SHA512:
-  metadata.gz: 0fa772f45a569263c28e71d3cbddc88861c6d294f088449700e8216272d1bc6e2e17fea926488a06c9aeb5fe1ede7d7bb09a57684be4bc3eb6d75ef192815a0f
-  data.tar.gz: 986cce94c7a062bbc643a61573a7509c9042be705ec54d64499070a0adc6c6e0784125f7da1b1be395cab2c207ce00dc501e1486109762dbfd2fee4769c83466
+  metadata.gz: b36da2d89b9150759ef417a2766f11139911c24cd0e263703ec6c0d493f58dc90431009bc976229663cb62deabfb7aacfd665932bc1f716d824706276742efb3
+  data.tar.gz: 1aa106c0d68610f1e638f80238257113a1d04d3cfc8006c063f8ca77a507bf4f07f6f800d024e308dbbba604d8936396bb1c0a70c6fc92d524421a95b97f85c0

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.3.0 (UNRELEASED)
+
+- [Improvement] Don't return an environment that has no versions of the cookbook in it.
+- [Feature] Added `bump` command which will bump the version of the current cookbook.
+- [Feature] Added `upload` command which will upload the current cookbook.
+- [Feature] Added straight up copies of the `outdated` and `update` Berkshelf commands.
+- [Feature] Added `apply` command to apply locked versions to the given environment.
+
 ## 0.2.0
 
 - [Improvement] Only showing the 15 most recent version in the info command.

data/COOKBOOKS.md

@@ -1,63 +1,8 @@
 ## Cookbooks
 
-Each cookbook has a pattern applied to it, which is one of Library, Application, or Node, and every
-cookbook should reside in its own Git repository.
-
-
-### Library Cookbooks
-
-This is the most basic building block of Cookbooks. These types of cookbooks are reusable and are
-mixed into other cookbooks to enhance them by:
-
-  - Adding LWRPs that abstract common functionality
-  - Including Libraries that add Ruby modules/classes for any depending cookbooks
-
-The goal of these cookbooks is to abstract common things into re-usable building blocks. They often
-do not include a single recipe because their job is to solely enhance the Chef primitives. It is
-also very common for these cookbooks to not include attributes since there's nothing to configure.
-
-Library cookbooks may depend on other library cookbooks or application cookbooks. They never depend
-on a Node Cookbook and they never depend on a Wrapper cookbook.
-
-Since the name of an LWRP is derived from the cookbook it is defined in, these cookbooks are named
-with that in mind. Pick names that make sense for the way you want LWRPs to appear in recipes.
-
-Library cookbooks are usually public, and you are strongly encouraged to open source your Library
-cookbooks.
-
-
-### Application Cookbooks
-
-These describe a single application or a single piece of software, that share the same name as the
-cookbook itself. If the application the cookbook manages contains multiple components then each one
-is broken up into it's own recipe and the recipe is named after the component it will install.
-Things are broken up in this way so you could install various components spread across a number of
-nodes within an environment.
-
-These cookbooks almost always contain a set of attributes which act as the runtime configuration for
-the cookbook. These attributes can do something like setting a port number or even describing the
-desired state of a service.
-
-Application cookbooks may depend on Library Cookbooks and other Application Cookbooks. They never
-depend on Node Cookbooks. They never depend on a Wrapper or Base Cookbook unless they are intended
-to be internal to your organization and will never be distributed to the Chef Community Site.
-
-These cookbooks are always named after the application they manage, and are usually name-spaced
-with your organization name as a prefix `{organization}_{application_cookbook}`.
-
-
-### Wrapper Cookbooks
-
-This is the lightest Cookbook out of all the known Cookbook patterns. It does a very simple job of
-depending on an Application Cookbook and then exposing a recipe for each recipe found in the
-Application Cookbook that it is wrapping.
-
-Wrapper cookbooks depend on Application Cookbooks only. They do not depend on other Wrapper
-Cookbooks, Library Cookbooks, or Environment Cookbooks.
-
-These cookbooks follow the naming convention `{organization}_{wrapped_cookbook}` or even sometimes
-`{application}_{wrapped_cookbook}`. So the RabbitMQ cookbook for Codio would be called
-`codio_rabbitmq`.
+Each and every cookbook is either a Node or a Non-Node cookbook, and every cookbook should reside in
+its very own Git repository. Additionally, there is a Base cookbook that must be the very first
+dependency of each Node cookbook.
 
 
 ### Node Cookbooks
@@ -76,16 +21,37 @@ achieved using Chef Environments, where a Node cookbook directly corresponds to
 of the same name. The Berkshelf lock file is converted into the environment's `cookbook_versions`
 using the Berkshelf `apply` command.
 
+Node cookbooks should never be a dependency for any other cookbook.
+
 Node cookbook names are prefixed with `node_`. For example `node_webserver`
 
 
+### Non-Node Cookbook
+
+Anything that is not specific to a node, and is required to be reusable, should appear in a Non-Node
+cookbook.
+
+Non-Node cookbooks should be consumed and depended on by one or more Node cookbooks, and should
+never be used directly. Easy peasy!
+
+
 ### Base Cookbook
 
-All Node Cookbooks require at least one dependency, and that is the Base cookbook. The Base Cookbook
-is very similar in nature to a Library Cookbook. It contains several recipes that are common to all
-nodes. Examples include configuring NTP and creating system users and SSH access.
+All Node Cookbooks require at least one dependency, and that is the Base cookbook.
+
+This is the most basic building block of Cookbooks. These types of cookbooks are reusable and are
+mixed into other Node cookbooks to enhance them by:
+
+  - Adding LWRPs that abstract common functionality
+  - Including Libraries that add Ruby modules/classes for any depending cookbooks
+
+The goal of these cookbooks is to abstract common things into re-usable building blocks. It contains
+several recipes that are common to all nodes. Examples include configuring NTP, creating system
+users and SSH access.
+
+The default recipe of your Node cookbooks should usually begin with your Base cookbook being
+included first.
 
-The default recipe of your Node cookbooks would be the best place to include your Base cookbook.
 
 
 ## Cookbook Development
@@ -103,12 +69,11 @@ made in that release.
 [Berkshelf](http://berkshelf.com/) is used to manage Cookbook dependencies in all Cookbooks,
 especially Node Cookbooks.
 
-Every Cookbook, no matter what type should alwsy contain a Berksfile with at least the following
+Every Cookbook, no matter what type should always containa a Berksfile with at least the following
 content:
 
 ```ruby
 source "http://berkshelf-api.int.codio.com"
-
 metadata
 ```
 

data/README.md

@@ -20,15 +20,57 @@ For the full details, read COOKBOOKS.md.
 
 ## Installation
 
-Install Cheflow into the ChefDK
+Install Cheflow into the ChefDK:
 
     $ chef gem install cheflow
 
 
+
+## Commands
+
+### Info
+
+    cheflow info|i
+
+Displays useful information about the current cookbook, including the environments this cookbook is
+being used in, and the list of versions.
+
+This is also the default command that will be executed if you run Cheflow without any command.
+
+    cheflow
+
+### Bump
+
+    cheflow bump|b
+
+Bumps the version of the current cookbook. By default, this will be the dev version (patch). To bump
+the major or minor version, just pass that as the first argument:
+
+    cheflow bump minor
+
+### Upload
+
+    cheflow upload|up
+
+Upload the current cookbook - the current cookbook being that which is in the current working
+directory. The current version of the cookbook will determine if this upload should be frozen or
+not. If it is a dev version (ie. a patch release), then the uploaded cookbook is not frozen.
+
+### Apply
+
+    cheflow apply|a
+
+Apply the current Berksfile.lock file to the current Node cookbook's environment.
+
+
+
 ## Workflow
 
 The Cheflow workflow is predominantly based on the current Cookbook version, which determines
 whether to apply version locks from Berksfile.lock to the production environment or not.
+Additionally, it will determine if the current cookbook is a node cookbook or not, and behave
+accordingly.
+
 
 ### Development Releases
 
@@ -36,6 +78,17 @@ If the version's patch number is an odd one, ie. a dev release, then the environ
 specified. If no environment is specified, then it will default to `development`. Cheflow will not
 allow you to lock a development release to production, even if you specify it.
 
+
+#### Publish a development version of a Non-Node cookbook
+
+- Bump the dev version of the non-node cookbook. (eg. 1.0.0 to 1.0.1)
+- Upload the cookbook without freezing: `berks up COOKBOOK --no-freeze`
+
+Equivalent Cheflow command:
+
+    cheflow upload
+
+
 #### Create a new development version of a Node cookbook
 
 - Bump the dev version. (eg. 1.0.0 to 1.0.1)
@@ -49,6 +102,7 @@ Equivalent Cheflow command:
 
 Default environment is `development`.
 
+
 #### Update development version of a Node cookbook
 
 - Upload new unfrozen version: `berks upload COOKBOOK --no-freeze`.
@@ -59,6 +113,7 @@ Cheflow command:
 
 Default environment is `development`.
 
+
 ### Production Releases
 
 If the version's patch number is an even one. ie. a production release, then the environment is

data/cheflow.gemspec

@@ -18,12 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "semverse",          "~> 1.1"
-  spec.add_dependency "berkshelf",         "~> 3.0"
-  spec.add_dependency "ridley",            "~> 4.0"
+  spec.add_dependency "semverse",          "~> 1.2"
+  spec.add_dependency "berkshelf",         "~> 3.3"
+  spec.add_dependency "ridley",            "~> 4.2"
   spec.add_dependency "ridley-connectors", "~> 2.3"
-  spec.add_dependency "thor",              "~> 0.18"
+  spec.add_dependency "thor",              "~> 0.19"
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake"
 end

data/lib/cheflow/cli.rb

@@ -21,20 +21,14 @@ module Cheflow
 
     namespace 'cheflow'
 
-    map 'up' => :upgrade
+    map 'up' => :upload
+    map 'ud' => :update
+    map 'a' => :apply
+    map 'o' => :outdated
     map 'i' => :info
+    map 'b' => :bump
     map ["ver", "-v", "--version"] => :version
 
-    class_option :verbose,
-      type: :boolean,
-      desc: "Output verbose information",
-      aliases: "-v",
-      default: false
-    class_option :debug,
-      type: :boolean,
-      desc: "Output debug information",
-      aliases: "-d",
-      default: false
     class_option :berksfile,
       type: :string,
       default: nil,
@@ -57,35 +51,131 @@ module Cheflow
       aliases: "-P",
       default: nil
 
-    # desc "upgrade [environment]", "Upload and apply the current cookbook version to the specified"
-    # def upgrade(env = 'development')
-    # end
+    desc 'upload', 'Upload the current cookbook'
+    long_desc <<-LONGDESC
+      Upload the current cookbook - the current cookbook being that which is in the current working
+      directory. The current version of the cookbook will determine if this upload should be frozen
+      or not. If it is a dev version (ie. a patch release), then the uploaded cookbook is not
+      frozen.
+    LONGDESC
+    def upload
+      say "Uploading #{cookbook.type} Cookbook: #{cookbook}"
+      begin
+        cookbook.upload
+      rescue Ridley::Errors::FrozenCookbook => e
+        say e, :red
+        exit(1)
+      end
+    end
+
+    desc 'update [COOKBOOKS]', 'Update the cookbooks (and dependencies) specified in the Berksfile'
+    def update(*cookbook_names)
+      cookbook.berksfile.update *cookbook_names
+    end
+
+    desc 'outdated [COOKBOOKS]', 'List dependencies that have new versions available that satisfy their constraints'
+    def outdated(*names)
+      outdated = cookbook.berksfile.outdated(*names)
+      Berkshelf.formatter.outdated(outdated)
+    end
+
+    desc 'apply ENVIRONMENT', 'Apply version locks from Berksfile.lock to a Chef environment'
+    def apply(environment_name)
+      unless cookbook.node_cookbook?
+        say "Cannot apply Non-Node Cookbooks. Run this again for a Node Cookbook", :red
+        exit(1)
+      end
+
+      lockfile = File.join(cookbook.path, Berkshelf::Lockfile::DEFAULT_FILENAME)
+      unless File.exist?(lockfile)
+        say "No lockfile found at #{lockfile}", :red
+        exit(1)
+      end
+
+      full_environment_name = "node_#{cookbook.node_name}"
+      full_environment_name += "_#{environment_name}" if environment_name != 'production'
+
+      say "Applying Node Cookbook #{cookbook} and its dependencies to #{environment_name} (#{full_environment_name})", :bold
+
+      if environment_name == 'production'
+        exit(1) unless yes?('Are you sure you wish to apply locked versions to production?', :red)
+      end
+
+      lockfile = Berkshelf::Lockfile.from_file(lockfile)
+      begin
+        unless lockfile.apply(full_environment_name)
+          error "Failed to apply locked versions"
+          exit(1)
+        end
+      rescue Berkshelf::EnvironmentNotFound => e
+        say "Unable to apply locked versions. #{e}", :red
+        exit(1)
+      end
+    end
 
     desc 'version', 'Display version information'
     def version
       say "Cheflow v#{Cheflow::VERSION}"
     end
 
+    desc 'bump', 'Bump the version, which is by default the patch version.'
+    long_desc <<-LONGDESC
+      Pass in the Semver level as the first argument to specify which level to bump.
+      Available levels are `major`, `minor` or `patch`.
+
+      Bump the patch version:
+      \x5> $ cheflow bump
+
+      Bump the major version:
+      \x5> $ cheflow bump major
+    LONGDESC
+    def bump(level='patch')
+      from = cookbook.version
+      major, minor, patch = from.major, from.minor, from.patch
+      binding.eval("#{level} = #{from.send(level)+1}")
+      to = "#{major}.#{minor}.#{patch}"
+
+      version_file = File.join(cookbook.path, 'VERSION')
+      if File.exist? version_file
+        File.open(version_file, 'w') { |file| file.puts to }
+        say "Bumped #{level} version from #{from} to #{to}", :green
+      else
+        say "The 'VERSION' file does not exist, so cannot bump the #{level} version", :red
+        exit(1)
+      end
+    end
+
     desc 'info', 'Display information about the cookbook'
     def info
-      say "#{cookbook.type.capitalize} Cookbook: #{cookbook}"
+      say "#{cookbook.type.capitalize} Cookbook: #{cookbook}", :bold
       say cookbook.path
       say
-      say "Environments: #{cookbook.node_environments.join("\n              ")}"
-      say
-
-      say 'Versions: (most recent)'
-
-      if (pv = cookbook.prod_versions).count > 15
-        say "  Production:  #{pv[0,15].join(', ')} (...)"
-      else
-        say "  Production:  #{pv.join(', ')}"
-      end
-
-      if (dv = cookbook.dev_versions).count > 15
-        say "  Development:  #{dv[0,15].join(', ')} (...)"
-      else
-        say "  Development:  #{dv.join(', ')}"
+      say "Environments: #{cookbook.node_environments(true).join("\n              ")}"
+
+      pv = cookbook.prod_versions
+      dv = cookbook.dev_versions
+
+      if dv.count > 0 || pv.count > 0
+        say
+        say 'Versions: (most recent)'
+
+        if pv.count > 0
+          if pv.count > 10
+            say "  Production:  #{pv[0,10].join(', ')} (...)"
+          else
+            say "  Production:  #{pv.join(', ')}"
+          end
+        end
+
+        if dv.count > 0
+          if dv.count > 10
+            say "  Development:  #{dv[0,10].join(', ')} (...)"
+          else
+            say "  Development:  #{dv.join(', ')}"
+          end
+        end
+
+        say
       end
     end
 

data/lib/cheflow/cookbook.rb

@@ -24,6 +24,11 @@ module Cheflow
       @name ||= metadata.name
     end
 
+    # The name of the Node cookbook without the "node_" prefix.
+    def node_name
+      @node_name ||= node_cookbook? ? name.sub(/^node_/, '') : name
+    end
+
     def path
       @path ||= File.dirname(berksfile.filepath)
     end
@@ -32,7 +37,7 @@ module Cheflow
       @type ||= if name.start_with? 'node_'
         :node
       else
-        :application
+        :non_node
       end
     end
 
@@ -40,10 +45,6 @@ module Cheflow
       type == :node
     end
 
-    def application_cookbook?
-      type == :application
-    end
-
     def node_environment_objects
       @node_environment_objects ||= begin
         if node_cookbook?
@@ -54,12 +55,14 @@ module Cheflow
       end
     end
 
-    def node_environments
+    def node_environments(with_versions=false)
       @node_environments ||= node_environment_objects.map do |e|
         env = e.name.gsub /^#{name}_/, ''
         env = env == name ? 'production' : env
-        "#{env.ljust(12)} (#{e.cookbook_versions[name]})"
-      end.sort
+        out = with_versions ? env.ljust(12) : env
+        out += " (#{e.cookbook_versions[name]})" if with_versions
+        out
+      end.compact.sort
     end
 
     def versions
@@ -82,6 +85,10 @@ module Cheflow
       ridley.cookbook.find(name, version).frozen?
     end
 
+    def upload
+      ridley.cookbook.upload path, freeze: !version.patch.odd?
+    end
+
 
     private
 

data/lib/cheflow/version.rb

@@ -1,3 +1,3 @@
 module Cheflow
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cheflow
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Joel Moss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-17 00:00:00.000000000 Z
+date: 2015-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semverse
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: berkshelf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: ridley
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: ridley-connectors
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -150,8 +150,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: A Cookbook-Centric workflow tool
 test_files: []
+has_rdoc: