Implement ability to specify temporarily-allowed dependencies in DEPS

tools/checkdeps/rules.py

+#!/usr/bin/env python
+# Copyright (c) 2012 The Chromium Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+"""Base classes to represent dependency rules, used by checkdeps.py"""
+
+# Specifies a single rule for an include, which can be either allow or disallow.

[M-A Ruel, 2012/07/26 13:06:03]

Why not a class docstring?

[Jói, 2012/07/26 13:32:13]

Done.

+class Rule(object):
+
+  # These are the prefixes used to indicate each type of rule. These
+  # are also used as values for self.allow to indicate which type of
+  # rule this is.
+  ALLOW = "+"
+  DISALLOW = "-"
+  TEMP_ALLOW = "!"
+
+  def __init__(self, allow, directory, source):
+    self.allow = allow
+    self._dir = directory
+    self._source = source
+
+  def __str__(self):
+    return '"%s%s" from %s.' % (self.allow, self._dir, self._source)
+
+  def ParentOrMatch(self, other):
+    """Returns true if the input string is an exact match or is a parent
+    of the current rule. For example, the input "foo" would match "foo/bar"."""
+    return self._dir == other or self._dir.startswith(other + "/")
+
+  def ChildOrMatch(self, other):
+    """Returns true if the input string would be covered by this rule. For
+    example, the input "foo/bar" would match the rule "foo"."""
+    return self._dir == other or other.startswith(self._dir + "/")
+
+
+def ParseRuleString(rule_string, source):
+  """Returns a tuple of a boolean indicating whether the directory is an allow
+  rule, and a string holding the directory name.
+  """
+  if len(rule_string) < 1:

[M-A Ruel, 2012/07/26 13:06:03]

if not rule_string:  ?

[Jói, 2012/07/26 13:32:13]

Done.

+    raise Exception('The rule string "%s" is too short\nin %s' %

[M-A Ruel, 2012/07/26 13:06:03]

is empty

[Jói, 2012/07/26 13:32:13]

Done.

+                    (rule_string, source))
+
+  if not rule_string[0] in [Rule.ALLOW, Rule.DISALLOW, Rule.TEMP_ALLOW]:
+    raise Exception(
+      'The rule string "%s" does not begin with a "+", "-" or "!".' %
+      rule_string)
+
+  return (rule_string[0], rule_string[1:])
+
+
+class Rules:

[M-A Ruel, 2012/07/26 13:06:03]

class Rules(object):

[Jói, 2012/07/26 13:32:13]

Done.

+  def __init__(self):
+    """Initializes the current rules with an empty rule list."""
+    self._rules = []
+
+  def __str__(self):
+    ret = "Rules = [\n"

[M-A Ruel, 2012/07/26 13:06:03]

return 'Rules = [\n%s]' % ''.join(' %s\n' % x for x in self._rules)
would generate a better formatting.

[Jói, 2012/07/26 13:32:13]

Done.

+    ret += "\n".join([" %s" % x for x in self._rules])
+    ret += "]\n"
+    return ret
+
+  def AddRule(self, rule_string, source):
+    """Adds a rule for the given rule string.
+
+    Args:
+      rule_string: The include_rule string read from the DEPS file to apply.
+      source: A string representing the location of that string (filename, etc.)
+              so that we can give meaningful errors.
+    """
+    (add_rule, rule_dir) = ParseRuleString(rule_string, source)
+    # Remove any existing rules or sub-rules that apply. For example, if we're
+    # passed "foo", we should remove "foo", "foo/bar", but not "foobar".
+    self._rules = [x for x in self._rules if not x.ParentOrMatch(rule_dir)]
+    self._rules.insert(0, Rule(add_rule, rule_dir, source))
+
+  def DirAllowed(self, allowed_dir):
+    """Returns a tuple (success, message), where success indicates if the given
+    directory is allowed given the current set of rules, and the message tells
+    why if the comparison failed."""
+    for rule in self._rules:
+      if rule.ChildOrMatch(allowed_dir):
+        # This rule applies.
+        why_failed = ""
+        if rule.allow != Rule.ALLOW:
+          why_failed = rule.__str__()
+        return (rule.allow, why_failed)
+    # No rules apply, fail.
+    return (Rule.DISALLOW, "no rule applying")