dep_selector 0.0.1

data/lib/dep_selector/dependency.rb

@@ -0,0 +1,46 @@
+#
+# Author:: Christopher Walters (<cw@opscode.com>)
+# Author:: Mark Anderson (<mark@opscode.com>)
+# Copyright:: Copyright (c) 2010-2011 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'dep_selector/version_constraint'
+
+module DepSelector
+  class Dependency
+    attr_reader :package, :constraint
+
+    def initialize(package, constraint=nil)
+      @package = package
+      @constraint = constraint || VersionConstraint.new
+    end
+
+    def to_s(incl_densely_packed_versions = false)
+      range = package.densely_packed_versions[constraint]
+      "(#{package.name} #{constraint.to_s}#{incl_densely_packed_versions ? " (#{range})" : ''})"
+    end
+
+    def ==(o)
+      o.respond_to?(:package) && package == o.package &&
+        o.respond_to?(:constraint) && constraint == o.constraint
+    end
+
+    def eql?(o)
+      self.class == o.class && self == o
+    end
+
+  end
+end

data/lib/dep_selector/dependency_graph.rb

@@ -0,0 +1,83 @@
+#
+# Author:: Christopher Walters (<cw@opscode.com>)
+# Author:: Mark Anderson (<mark@opscode.com>)
+# Copyright:: Copyright (c) 2010-2011 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'dep_selector/package'
+require 'dep_selector/gecode_wrapper'
+
+# DependencyGraphs contain Packages, which in turn contain
+# PackageVersions. Packages are created at access-time through
+# #package
+module DepSelector
+  class DependencyGraph
+
+    attr_reader :packages
+
+    def initialize
+      @packages = {}
+    end
+
+    def package(name)
+      packages.has_key?(name) ? packages[name] : (packages[name]=Package.new(self, name))
+    end
+
+    def each_package
+      packages.each do |name, pkg|
+        yield pkg
+      end
+    end
+
+    def gecode_wrapper
+      raise "Must invoke generate_gecode_wrapper_constraints before attempting to access gecode_wrapper" unless @gecode_wrapper
+      @gecode_wrapper
+    end
+
+    # Note: only invoke this method once all Packages and
+    # PackageVersions have been added.
+    def generate_gecode_wrapper_constraints(packages_to_include_in_solve=nil)
+      unless @gecode_wrapper
+        packages_in_solve =
+          if packages_to_include_in_solve
+            packages_to_include_in_solve
+          else
+            packages.map{ |name, pkg| pkg }
+          end
+
+        # In addition to all the packages that the user specified,
+        # there is a "ghost" package that contains the solution
+        # constraints. See Selector#solve for more information.
+        @gecode_wrapper = GecodeWrapper.new(packages_in_solve.size + 1)
+        packages_in_solve.each{ |pkg| pkg.generate_gecode_wrapper_constraints }
+      end
+    end
+
+    def gecode_model_vars
+      packages.inject({}){|acc, elt| acc[elt.first] = elt.last.gecode_model_var ; acc }
+    end
+
+    def to_s(incl_densely_packed_versions = false)
+      packages.keys.sort.map{|name| packages[name].to_s(incl_densely_packed_versions)}.join("\n")
+    end
+
+    # TODO [cw,2010/11/23]: this is a simple but inefficient impl. Do
+    # it for realz.
+    def clone
+      Marshal.load(Marshal.dump(self))
+    end
+  end
+end

data/lib/dep_selector/error_reporter.rb

@@ -0,0 +1,28 @@
+#
+# Author:: Christopher Walters (<cw@opscode.com>)
+# Author:: Mark Anderson (<mark@opscode.com>)
+# Copyright:: Copyright (c) 2010-2011 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module DepSelector
+  class ErrorReporter
+
+    def give_feedback(workspace, solution_constraints, unsatisfiable_constraint_idx, most_constrained_package)
+      raise "Sub-class must implement"
+    end
+
+  end
+end

data/lib/dep_selector/error_reporter/simple_tree_traverser.rb

@@ -0,0 +1,183 @@
+#
+# Author:: Christopher Walters (<cw@opscode.com>)
+# Author:: Mark Anderson (<mark@opscode.com>)
+# Copyright:: Copyright (c) 2010-2011 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'dep_selector/error_reporter'
+
+# This error reporter simply maps the versions of packages explicitly
+# included in the list of solution constraints to the restrictions
+# placed on the most constrained package.
+module DepSelector
+  class ErrorReporter
+    class SimpleTreeTraverser < ErrorReporter
+
+      def give_feedback(dep_graph, soln_constraints, unsatisfiable_constraint_idx, most_constrained_pkg)
+        unsatisfiable_soln_constraint = soln_constraints[unsatisfiable_constraint_idx]
+        feedback = "Unable to satisfy constraints on package #{most_constrained_pkg.name}"
+        feedback << ", which does not exist," unless most_constrained_pkg.valid?
+        feedback << " due to solution constraint #{unsatisfiable_soln_constraint}. "
+
+        all_paths = paths_from_soln_constraints_to_pkg_constraints(dep_graph, soln_constraints, most_constrained_pkg)
+        collapsed_paths = collapse_adjacent_paths(all_paths).map{|collapsed_path| "[#{print_path(collapsed_path).join(' -> ')}]"}
+
+        feedback << "Solution constraints that may result in a constraint on #{most_constrained_pkg.name}: #{collapsed_paths.join(', ')}"
+      end
+
+      private
+
+      def paths_from_soln_constraints_to_pkg_constraints(dep_graph, soln_constraints, most_constrained_pkg)
+        all_paths = []
+        soln_constraints.each do |soln_constraint|
+          paths_to_pkg(dep_graph,
+                       soln_constraint.package,
+                       soln_constraint.constraint,
+                       most_constrained_pkg,
+                       [],
+                       all_paths)
+        end
+
+        all_paths
+      end
+
+      def paths_to_pkg(dep_graph, curr_pkg, version_constraint, target_pkg, curr_path, all_paths)
+        if curr_pkg == target_pkg
+          # register the culminating constraint
+          all_paths.push(Array.new(curr_path).push(SolutionConstraint.new(curr_pkg, version_constraint)))
+          return
+        end
+
+        # curr_pkg has no versions, it is invalid so don't recurse
+        if curr_pkg.versions.empty?
+          # TODO [cw, 2011/2/17]: find a way to track these invalid
+          # packages and return as potential conflict-causing
+          # constraints.
+          return
+        end
+
+        if curr_path.select{|elt| elt.package == curr_pkg}.any?
+          # TODO [cw, 2011/2/18]: this indicates a circular dependency
+          # in the dependency graph. This might be useful warning
+          # information to report to the user.
+          return
+        end
+
+        # determine all versions of curr_pkg that match
+        # version_constraint and recurse into them
+        curr_pkg[version_constraint].each do |curr_pkg_ver|
+          curr_path.push(curr_pkg_ver)
+          curr_pkg_ver.dependencies.each do |dep|
+            paths_to_pkg(dep_graph, dep.package, dep.constraint, target_pkg, curr_path, all_paths)
+          end
+          curr_path.pop
+        end
+      end
+
+      # This is a simple collapsing function. For each adjacent path,
+      # if there is only one element different between the two paths
+      # and their packages are the same (meaning only the version
+      # binding is different), then the elements are considered
+      # collasable. The merged path has all the common elements and a
+      # set containing the two version bindings in place of the
+      # contentious path item.
+      def collapse_adjacent_paths(paths)
+        return paths if paths.length < 2
+
+        paths.inject([]) do |collapsed_paths, path|
+          merge_path_into_collapsed_paths(collapsed_paths, path)
+        end
+      end
+
+      def print_path(path)
+        path.map do |step|
+          if step.respond_to? :version
+            "(#{step.package.name} = #{step.version})"
+          elsif step.respond_to? :constraint
+            step.to_s
+          elsif step.kind_of?(Array)
+            # TODO [cw, 2011/2/23]: consider detecting complete
+            # ranges here instead of calling each out individually
+            "(#{step.first.package.name} = {#{step.map{|elt| "#{elt.version}"}.join(',')}})"
+          else
+            raise "don't know how to print step"
+          end
+        end
+      end
+
+      # collapses path_under_consideration onto the end of
+      # collapsed_paths or adds a new path to be used in the next
+      # round(s) of collapsing.
+      #
+      # Note: collapsed_paths is side-effected
+      def merge_path_into_collapsed_paths(collapsed_paths, path_under_consideration)
+        curr_collapsed_path = collapsed_paths.last
+
+        # if there is no curr_collapsed_path or it isn't the same
+        # length as path_under_consideration, then they cannot
+        # possibly be mergeable
+        if curr_collapsed_path.nil? || curr_collapsed_path.length != path_under_consideration.length
+          # TODO [cw.2011/2/7]: do we need this to be a new array, or
+          # can we save ourselves a little memory and work by just
+          # pushing the reference to path_under_consideration?
+          return collapsed_paths << Array.new(path_under_consideration)
+        end
+
+        # lengths are equal, so find the first path element where
+        # curr_collapsed_path and path_under_consideration diverge, if
+        # that is the only unequal element, it's for the same package,
+        # and they are both PackageVersion objects then merge;
+        # otherwise, this is a new path
+        #
+        # TODO [cw,2011/2/7]: should we merge even if they're not for
+        # the same package?
+        unequal_idx = nil
+        merged_set = nil
+        mergeable = true
+        path_under_consideration.each_with_index do |path_element, curr_idx|
+          if path_element != curr_collapsed_path[curr_idx]
+            unless unequal_idx
+              merged_set = [curr_collapsed_path[curr_idx]].flatten
+              if merged_set.first.package == path_element.package &&
+                  merged_set.first.is_a?(PackageVersion) &&
+                  path_element.is_a?(PackageVersion)
+                merged_set << path_element
+              else
+                mergeable = false
+                break
+              end
+              unequal_idx = curr_idx
+            else
+              # this is the second place they are unequal. fast-fail,
+              # because we know we can't merge the paths.
+              mergeable = false
+              break
+            end
+          end
+        end
+
+        if unequal_idx && mergeable
+          curr_collapsed_path[unequal_idx] = merged_set
+        else
+          collapsed_paths << Array.new(path_under_consideration)
+        end
+
+        collapsed_paths
+      end
+
+    end
+  end
+end

data/lib/dep_selector/exceptions.rb

@@ -0,0 +1,67 @@
+#
+# Author:: Christopher Walters (<cw@opscode.com>)
+# Author:: Mark Anderson (<mark@opscode.com>)
+# Copyright:: Copyright (c) 2010-2011 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module DepSelector
+  module Exceptions
+
+    # This exception is what the client of dep_selector should
+    # catch. It contains the solution constraint that introduces
+    # unsatisfiability, as well as the set of packages that are
+    # required to be disabled due to 
+    class NoSolutionExists < StandardError
+      attr_reader :message, :unsatisfiable_solution_constraint,
+                  :disabled_non_existent_packages,
+                  :disabled_most_constrained_packages
+      def initialize(message, unsatisfiable_solution_constraint,
+                     disabled_non_existent_packages = [],
+                     disabled_most_constrained_packages = [])
+        @message = message
+        @unsatisfiable_solution_constraint = unsatisfiable_solution_constraint
+        @disabled_non_existent_packages = disabled_non_existent_packages
+        @disabled_most_constrained_packages = disabled_most_constrained_packages
+      end
+    end
+
+    # This exception is thrown by gecode_wrapper and only used
+    # internally
+    class NoSolutionFound < StandardError
+      attr_reader :unsatisfiable_problem
+      def initialize(unsatisfiable_problem=nil)
+        @unsatisfiable_problem = unsatisfiable_problem
+      end
+    end
+
+    # This exception is thrown during Selector#find_solution if any of
+    # the solution constraints make finding solution impossible. The
+    # two cases are if a solution constraint references a package that
+    # doesn't exist or if the constraint on an extant package matches
+    # no versions.
+    class InvalidSolutionConstraints < ArgumentError
+      attr_reader :non_existent_packages, :constrained_to_no_versions
+      def initialize(non_existent_packages, constrained_to_no_versions)
+        @non_existent_packages = non_existent_packages
+        @constrained_to_no_versions = constrained_to_no_versions
+      end
+    end
+
+    class InvalidVersion < ArgumentError ; end
+    class InvalidVersionConstraint < ArgumentError; end
+
+  end
+end

data/lib/dep_selector/gecode_wrapper.rb

@@ -0,0 +1,151 @@
+#
+# Author:: Christopher Walters (<cw@opscode.com>)
+# Author:: Mark Anderson (<mark@opscode.com>)
+# Copyright:: Copyright (c) 2010-2011 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "dep_gecode"
+require 'dep_selector/exceptions'
+
+module DepSelector
+  class GecodeWrapper
+    attr_reader :gecode_problem
+    DontCareConstraint = -1
+    NoMatchConstraint = -2
+    
+    # This insures that we properly deallocate the c++ class at the heart of dep_gecode.
+    # modeled after http://www.mikeperham.com/2010/02/24/the-trouble-with-ruby-finalizers/
+    def initialize(problem_or_package_count)
+      if (problem_or_package_count.is_a?(Numeric))
+        @gecode_problem = Dep_gecode.VersionProblemCreate(problem_or_package_count)
+      else
+        @gecode_problem = problem_or_package_count
+      end
+      ObjectSpace.define_finalizer(self, self.class.finalize(@gecode_problem))
+    end
+    def self.finalize(gecode_problem)
+      proc { Dep_gecode.VersionProblemDestroy(gecode_problem) }
+    end
+
+    def check_package_id(package_id, param_name)
+      raise "Gecode #{param_name} is out of range #{package_id}" unless (package_id >= 0 && package_id < self.size()) 
+    end
+    
+    def size()
+      raise "Gecode internal failure" if gecode_problem.nil?
+      Dep_gecode.VersionProblemSize(gecode_problem)
+    end
+    def package_count()
+      raise "Gecode internal failure" if gecode_problem.nil?
+      Dep_gecode.VersionProblemPackageCount(gecode_problem)
+    end
+    def add_package(min, max, current_version)
+      raise "Gecode internal failure" if gecode_problem.nil?
+      Dep_gecode.AddPackage(gecode_problem, min, max, current_version)
+    end
+
+    def add_version_constraint(package_id, version, dependent_package_id, min_dependent_version, max_dependent_version)
+      raise "Gecode internal failure" if gecode_problem.nil?
+      check_package_id(package_id, "package_id")
+      check_package_id(dependent_package_id, "dependent_package_id")
+
+      # Valid package versions are between -1 and its max (-1 means
+      # don't care, meaning it doesn't need to be assigned). To
+      # indicate constraints that match no versions, -2 is used, since
+      # it's not a valid assignment of the variable; thus, any branch
+      # that assigns -2 will fail.
+      #
+      # This mechanism is also used when a dependent package has no
+      # versions, which only happens if the dependency's package is
+      # auto-vivified when creating the parent PackageVersion's
+      # dependency but with no corresponding set of PackageVersions
+      # (i.e. it's an invalid deendency, because it does not exist in
+      # the dependency graph). Again, we won't abort immediately, but
+      # we'll add a constraint to the package that makes exploring
+      # that portion of the solution space unsatisfiable. Thus it is
+      # impossible to find solutions dependent on non-existent
+      # packages.
+
+      min = min_dependent_version || NoMatchConstraint
+      max = max_dependent_version || NoMatchConstraint
+      Dep_gecode.AddVersionConstraint(gecode_problem, package_id, version, dependent_package_id, min, max)
+
+      # if the package was constrained to no versions, hint to the
+      # solver that in the event of failure, it should prefer to
+      # indicate constraints on dependent_package_id as the culprit
+      if min == NoMatchConstraint && max == NoMatchConstraint
+        Dep_gecode.MarkPackageSuspicious(gecode_problem, dependent_package_id)
+      end
+    end
+    def get_package_version(package_id)
+      raise "Gecode internal failure" if gecode_problem.nil?
+      check_package_id(package_id, "package_id")
+      Dep_gecode.GetPackageVersion(gecode_problem, package_id)
+    end
+    def is_package_disabled?(package_id)
+      raise "Gecode internal failure" if gecode_problem.nil?
+      check_package_id(package_id, "package_id")
+      Dep_gecode.GetPackageDisabledState(gecode_problem, package_id);
+    end
+    
+    def get_package_max(package_id) 
+      raise "Gecode internal failure" if gecode_problem.nil?
+      check_package_id(package_id, "package_id")
+      Dep_gecode.GetPackageMax(gecode_problem, package_id)
+    end
+    def get_package_min(package_id) 
+      raise "Gecode internal failure" if gecode_problem.nil?
+      check_package_id(package_id, "package_id")
+      Dep_gecode.GetPackageMin(gecode_problem, package_id)
+    end
+    def dump() 
+      raise "Gecode internal failure" if gecode_problem.nil?
+      Dep_gecode.VersionProblemDump(gecode_problem)
+    end
+    def dump_package_var(package_id)
+      raise "Gecode internal failure" if gecode_problem.nil?
+      check_package_id(package_id, "package_id")
+      Dep_gecode.VersionProblemPrintPackageVar(gecode_problem, package_id)
+    end
+
+    def package_disabled_count
+      raise "Gecode internal failure (package disabled count)" if gecode_problem.nil?
+      Dep_gecode.GetDisabledVariableCount(gecode_problem)
+    end
+
+    def mark_required(package_id)
+      raise "Gecode internal failure (mark_required)" if gecode_problem.nil?
+      check_package_id(package_id, "package_id")
+      Dep_gecode.MarkPackageRequired(gecode_problem, package_id);
+    end
+
+    def mark_preferred_to_be_at_latest(package_id, weight)
+      raise "Gecode internal failure (mark_preferred_to_be_at_latest)" if gecode_problem.nil?
+      check_package_id(package_id, "package_id")
+      Dep_gecode.MarkPackagePreferredToBeAtLatest(gecode_problem, package_id, weight);
+    end
+
+    def solve()
+      raise "Gecode internal failure (solve)" if gecode_problem.nil?
+      solution = GecodeWrapper.new(Dep_gecode.Solve(gecode_problem))
+      raise "Gecode internal failure (no solution found)" if (solution.nil?)
+
+      raise Exceptions::NoSolutionFound.new(solution) if solution.package_disabled_count > 0
+      solution
+    end
+
+  end
+end