config: build_configs implement frequency parameter

kernelci/legacy/config/build.py

@@ -1,4 +1,4 @@
 # Copyright (C) 2018, 2019 Collabora Limited
 # Author: Guillaume Tucker <guillaume.tucker@collabora.com>
 #
 # This module is free software; you can redistribute it and/or modify it under
@@ -23,7 +23,7 @@
 class Tree(YAMLConfigObject):
     """Kernel git tree model."""
 
     yaml_tag = u'!Tree'
 
     def __init__(self, name, url):
         """A kernel git tree is essentially a repository with kernel branches.
@@ -35,11 +35,11 @@
         self._url = url
 
     @property
     def name(self):
         return self._name
 
     @property
     def url(self):
         return self._url
 
     @classmethod
@@ -52,7 +52,7 @@
 class Reference(YAMLConfigObject):
     """Kernel reference tree and branch model."""
 
     yaml_tag = u'!Reference'
 
     def __init__(self, tree, branch):
         """Reference is a tree and branch used for bisections
@@ -64,23 +64,23 @@
         self._branch = branch
 
     @classmethod
     def load_from_yaml(cls, reference, trees):
         kw = cls._kw_from_yaml(reference, ['tree', 'branch'])
         kw['tree'] = trees[kw['tree']]
         return cls(**kw)
 
     @property
     def tree(self):
         return self._tree
 
     @property
     def branch(self):
         return self._branch
 
     @classmethod
     def to_yaml(cls, dumper, data):
         return dumper.represent_mapping(
             u'tag:yaml.org,2002:map', {
                 'tree': data.tree.name,
                 'branch': data.branch,
             }
@@ -359,7 +359,8 @@
 
     yaml_tag = u'!BuildConfig'
 
-    def __init__(self, name, tree, branch, variants, reference=None, architectures=None):
+    def __init__(self, name, tree, branch, variants, reference=None,
+                 architectures=None, frequency=None):
         """A build configuration defines the actual kernels to be built.
 
         *name* is the name of the build configuration.  It is arbitrary and
@@ -378,13 +379,18 @@
                     bisections when no base commit is found for the good and
                     bad revisions.  It can also be None if no reference branch
                     can be used with this build configuration.
+
+        *frequency* is an optional string that limits how often a checkout node
+                    can be created for this tree/branch. Format: [Nd][Nh][Nm]
+                    e.g. "1d" for once per day, "12h" for twice per day.
         """
         self._name = name
         self._tree = tree
         self._branch = branch
         self._variants = variants
         self._reference = reference
         self._architectures = architectures
+        self._frequency = frequency
 
     @classmethod
     def load_from_yaml(cls, config, name, trees, fragments, b_envs, defaults):
@@ -406,6 +412,7 @@
         if reference:
             kw['reference'] = Reference.load_from_yaml(reference, trees)
         kw['architectures'] = config.get('architectures', None)
+        kw['frequency'] = config.get('frequency', None)
         return cls(**kw)
 
     @property
@@ -435,16 +442,21 @@
     def reference(self):
         return self._reference
 
+    @property
+    def frequency(self):
+        return self._frequency
+
     @classmethod
     def to_yaml(cls, dumper, data):
-        return dumper.represent_mapping(
-            u'tag:yaml.org,2002:map', {
-                'tree': data.tree.name,
-                'branch': data.branch,
-                'variants': {var.name: var for var in data.variants},
-                'reference': data.reference,
-            }
-        )
+        result = {
+            'tree': data.tree.name,
+            'branch': data.branch,
+            'variants': {var.name: var for var in data.variants},
+            'reference': data.reference,
+        }
+        if data.frequency:
+            result['frequency'] = data.frequency
+        return dumper.represent_mapping(u'tag:yaml.org,2002:map', result)
 
 
 def from_yaml(data, filters):