knife-depsolver 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d898d03bc79de23335e1ce6f1d81ca9cc68527d9
-  data.tar.gz: 9fc64f30535ff4441cacd2316dceeacb1ce66345
+  metadata.gz: 4dd5a344b9fcfc7c4e08e5199122981852f396f1
+  data.tar.gz: 7973c0cd7d13687bc3fe81575e6f6b9bff430f04
 SHA512:
-  metadata.gz: 5eae154d12a6d07c72fa13a8a3b89b96849bf7b5ca6d3b42f614573c239a432d2f550164810b2cdbbb4ff7fc95b94f00256ed01745f183edb31b71730cc61b38
-  data.tar.gz: 60cd833bbe8e5f321e453fe41cba4ab78652e96bdb99d63b8a83709526634454c8564c72abb05178868cf6081a8c42a55c314a0352f8369c5028736561a6cc5a
+  metadata.gz: 733d5a061fc6bbaa400af405f8fd1419fef2f0fe2b313360dc91d5adf4e99b2b55c4293d2fea475a452f8260f12ef37e144dc098cbc58432db171121fc9f3a35
+  data.tar.gz: dca4c199d6ba80069efd8ca2db97d2c94af28580fd8f7ecbcac146d865345d920e12b422739e9153584ffe5608fbb63465ec24dd7726cf1c8c2dcedea7a99838

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 2.0.2 (2017-05-11)
+
+* Set DepSelector log level to INFO
+* Add --print-constrained-cookbook-set option
+
 ## 2.0.1 (2017-05-02)
 
 * Minor change to file name timestamp format

data/README.md

@@ -65,9 +65,15 @@ knife depsolver -E production 'role[base],cookbook-B,cookbook-A::foo@3.1.4,cookb
 
 ### Using knife-depsolver with Chef DK's embedded depsolver
 
-It can be difficult to identify the source of the problem if we hit a depsolver issue in the Chef Server.
+Mikael Lagerkvist is one of the authors of gecode, the constraint solver used by Chef's depsolver, and he says in the following mail list posts that "Debugging failures in constraint programs is unfortunately a very hard problem."
 
-knife-depsolver can provide many more troubleshooting options by using the depsolver embedded in your workstation's Chef DK to make an identical calculation as the Chef Server.
+http://www.mail-archive.com/users@gecode.org/msg00110.html
+
+https://www.mail-archive.com/users@gecode.org/msg00076.html
+
+In the first post he goes on to talk about the importance of troubleshooting the whole problem set. With regards to the cookbook depsolver this translates to the importance of troubleshooting the whole run list. When troubleshooting a depsolver issue it is best to keep the run list the same and make changes to the environment cookbook version constraints or possibly to the cookbook universe.
+
+knife-depsolver can provide many troubleshooting options by using the depsolver embedded in your workstation's Chef DK to make an identical calculation as the Chef Server.
 
 First, you need to make sure that your version of Chef DK is using the same version of the dep_selector gem as your version of Chef Server. If your Chef DK is using a different version of the dep_selector gem then knife-depsolver's calculations will not be identical to the Chef Server's calculations which will confuse troubleshooting efforts.
 
@@ -100,7 +106,9 @@ For example:
 knife depsolver --env-constraints rehearsal-environment-2017-05-01-18.52.40-5f5843d819ecb0b174f308d76d4336bb7bbfacbf.txt --universe automate-universe-2017-05-01-18.52.40-1c8e59e23530b1e1a8e0b3b3cc5236a29c84e469.txt --expanded-run-list expanded-run-list-2017-05-01-18.52.40-387d90499514747792a805213c30be13d830d31f.txt
 ```
 
-Now it is easy to modify any combination of the expanded run list, the environment cookbook version constraints or the cookbook universe in those files and see the impact on the depsolver in an effort to isolate the problem.
+Now it is easy to modify the environment cookbook version constraints or the cookbook universe input files to see the impact on the depsolver.
+
+#### --timeout
 
 Sometimes it can help to give the depsolver more than the default five seconds to perform its calculations. This can be done by using the "--timeout <seconds>" option to change the depsolver timeout.
 
@@ -108,7 +116,19 @@ Sometimes it can help to give the depsolver more than the default five seconds t
 knife depsolver --env-constraints production-environment-2017-05-01-18.52.40-5f5843d819ecb0b174f308d76d4336bb7bbfacbf.txt --universe my-org-universe-2017-05-01-18.52.40-1c8e59e23530b1e1a8e0b3b3cc5236a29c84e469.txt --expanded-run-list expanded-run-list-2017-05-01-18.52.40-387d90499514747792a805213c30be13d830d31f.txt --timeout 120
 ```
 
-### Chef Server <= 12.4.0
+#### --print-constrained-cookbook-set
+
+Sometimes you want to only see the list of cookbooks, and their cookbook dependency version constraints, that ultimately would be sent to the depsolver without actually triggering the depsolver calculation. This is especially helpful when the depsolver isn't returning any results because it can't calculate a solution in a reasonable amount of time. This can be done by using the `--print-constrained-cookbook-set` option.
+
+```
+knife depsolver --env-constraints rehearsal-environment-2017-05-01-18.52.40-5f5843d819ecb0b174f308d76d4336bb7bbfacbf.txt --universe automate-universe-2017-05-01-18.52.40-1c8e59e23530b1e1a8e0b3b3cc5236a29c84e469.txt --expanded-run-list expanded-run-list-2017-05-01-18.52.40-387d90499514747792a805213c30be13d830d31f.txt --print-constrained-cookbook-set
+```
+
+Now you can review the output to see if you can find anything that could be causing problems for the depsolver. You can make changes to the input files to see the impact on the list of cookbooks that would be sent to the depsolver.
+
+If necessary you could also use the list of cookbooks as a starting point for setting version constraints in the environment input file. Then you can modify that set of version constraints and run the depsolver in an effort to get a solution in a reasonable amount of time or to isolate the problem.
+
+### Chef Server < 12.4.0
 
 knife-depsolver requires cookbook universe data in order to use Chef DK's embedded depsolver. The "/universe" API endpoint was added in the Chef Server 12.4.0 release.
 

data/lib/chef/knife/depsolver.rb

@@ -31,9 +31,9 @@ class Chef
              long: '--universe FILENAME',
              description: 'Use the cookbook universe from FILENAME. REQUIRED when using the local depsolver.'
 
-       option :expanded_run_list,
-              long: '--expanded-run-list FILENAME',
-              description: 'Use the expanded run list from FILENAME. REQUIRED when using the local depsolver.'
+      option :expanded_run_list,
+             long: '--expanded-run-list FILENAME',
+             description: 'Use the expanded run list from FILENAME. REQUIRED when using the local depsolver.'
 
       option :csv_universe_to_json,
              long: '--csv-universe-to-json FILENAME',
@@ -43,8 +43,13 @@ class Chef
            long: '--env-constraints-filter-universe',
            description: 'Filter the cookbook universe using the environment cookbook version constraints.'
 
+      option :print_constrained_cookbook_set,
+           long: '--print-constrained-cookbook-set',
+           description: 'Only print the constrained cookbook set that would be sent to the depsolver.'
+
       def run
         begin
+          DepSelector::Debug.log.level = Logger::INFO
           use_local_depsolver = false
           if config[:env_constraints_filter_universe]
             if config[:node] || config[:environment] || config[:timeout] || config[:capture] || config[:expanded_run_list] || config[:csv_universe_to_json]
@@ -84,6 +89,10 @@ class Chef
             msg("ERROR: The --timeout option requires the --env-constraints, --universe and --expanded-run-list options to be set")
             exit!
           end
+          if config[:print_constrained_cookbook_set] && !use_local_depsolver
+            msg("ERROR: The --print-constrained-cookbook-set option requires the --env-constraints, --universe and --expanded-run-list options to be set")
+            exit!
+          end
 
           timeout = (config[:timeout].to_f * 1000).to_i if config[:timeout]
           timeout ||= 5 * 1000
@@ -240,6 +249,11 @@ class Chef
 
             data = {environment_constraints: env_ckbk_constraints, all_versions: all_versions, run_list: expanded_run_list_with_split_versions, timeout_ms: timeout}
 
+            if config[:print_constrained_cookbook_set]
+              print_constrained_cookbook_set(data)
+              exit!
+            end
+
             depsolver_start_time = Time.now
 
             solution = solve(data)
@@ -317,6 +331,61 @@ class Chef
           end
         end
       end
+
+      def print_constrained_cookbook_set(data)
+        begin
+          # create dependency graph from cookbooks
+          graph = DepSelector::DependencyGraph.new
+
+          env_constraints = data[:environment_constraints].inject({}) do |acc, env_constraint|
+            name, version, constraint = env_constraint
+            acc[name] = DepSelector::VersionConstraint.new(constraint_to_str(constraint, version))
+            acc
+          end
+
+          all_versions = []
+
+          data[:all_versions].each do | vsn|
+            name, version_constraints = vsn
+            version_constraints.each do |version_constraint| # todo: constraints become an array in ruby
+              # due to the erlectricity conversion from
+              # tuples
+              version, constraints = version_constraint
+
+              # filter versions based on environment constraints
+              env_constraint = env_constraints[name]
+              if (!env_constraint || env_constraint.include?(DepSelector::Version.new(version)))
+                package_version = graph.package(name).add_version(DepSelector::Version.new(version))
+                constraints.each do |package_constraint|
+                  constraint_name, constraint_version, constraint = package_constraint
+                  version_constraint = DepSelector::VersionConstraint.new(constraint_to_str(constraint, constraint_version))
+                  dependency = DepSelector::Dependency.new(graph.package(constraint_name), version_constraint)
+                  package_version.dependencies << dependency
+                end
+              end
+            end
+
+            # regardless of filter, add package reference to all_packages
+            all_versions << graph.package(name)
+          end
+
+          run_list = data[:run_list].map do |run_list_item|
+            item_name, item_constraint_version, item_constraint = run_list_item
+            version_constraint = DepSelector::VersionConstraint.new(constraint_to_str(item_constraint,
+            item_constraint_version))
+            DepSelector::SolutionConstraint.new(graph.package(item_name), version_constraint)
+          end
+
+          timeout_ms = data[:timeout_ms]
+          selector = DepSelector::Selector.new(graph, (timeout_ms / 1000.0))
+
+          constrained_cookbook_set = selector.send(:trim_unreachable_packages, selector.dep_graph, run_list)
+          constrained_cookbook_set.sort {|x,y| x.name <=> y.name}.each {|c| puts c.to_s.gsub(/Package/, 'Cookbook')}
+
+        rescue => e
+          puts = [:error, :exception, e.message, [e.backtrace]]
+        end
+      end
     end
   end
 end

data/lib/knife-depsolver/version.rb

@@ -1,3 +1,3 @@
 module KnifeDepsolver
-  VERSION = "2.0.1"
+  VERSION = "2.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-depsolver
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Jeremiah Snapp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-02 00:00:00.000000000 Z
+date: 2017-05-11 00:00:00.000000000 Z
 dependencies: []
 description: Knife plugin that uses Chef Server to calculate cookbook dependencies
   for a given run_list.