mutate 0.0.1.dev13

在提交信息中添加 Depends-On

很多时候，尤其是在添加新模块时，对 scribe 的更改并不能确保 CI 正确工作，直到 stockpile 的相应更改合并。在这种情况下，为了确保 CI 不与 stockpile 的 master 分支而是与您提交给 stockpile 的补丁集一起工作，您可以使用 depends-on 功能。

要添加 Depends-On 功能，请复制您提交给 stockpile 的补丁集的 Change-Id，并将其添加到提交信息的末尾，如下所示。

注意：请将其添加到提交信息中的 Change-Id 之后。

提交信息应如下所示

Your commit message

Change-Id: I9bc121f076b8625da88705c9d96bd00117f94c22

Depends-On: {Change-Id of the review submitted to stockpile}

例如，如果您正在添加一个处理卫星数据的模块，CI 将无法测试它，因为 stockpile 尚未拥有卫星集合。然而，因为您有一个尚未合并的提交，例如 https://review.gerrithub.io/#/c/redhat-performance/stockpile/+/425015/

您仍然可以通过在 scribe 的提交信息中添加 Depends-On 来确保和验证 stockpile-scribe 工作流程，因此提交信息将如下所示

Adding satellite Module to work with stockpile.

Change-Id: some_random_change_id_generated_after_git_review

Depends-On: I66329511b38a558ce61efb7edb4c3be18625b252

请注意，Depends-On 中的更改 ID 与 https://review.gerrithub.io/#/c/redhat-performance/stockpile/+/425015/ 中的相同

另一个示例请参阅： https://review.gerrithub.io/#/c/redhat-performance/scribe/+/425969/

添加新的 scribes

扩展 scribe 以支持新的输入类型 'example1' 的步骤包括

1. 在 'mutate/scribes/' 目录中创建 'example1.py'。示例代码如下所示

from . import ScribeBaseClass


class Example1(ScribeBaseClass):

    def example1_build_initial_dict(self):
        output_dict = {}
        Example1_data = load_file(self._path)
        # .... some sort of data manipulation
        # .... to build the output_dict
        return output_dict

    def __init__(self, path=None, source_type=None):
        ScribeBaseClass.__init__(self, source_type=source_type, path=path)
        self._dict = self.example1_build_initial_dict()

    def emit_scribe_dict(self):
        return self._dict

注意以下事项

1. from . import ScribeBaseClass 需要存在，因为我们是从 ScribeBaseClass 继承的

2. class Example1(ScribeBaseClass) 是继承发生的地方，确保在编写类定义时包含 '(ScribeBaseClass)'

3. 类名中第一个字母必须大写，这是工厂方法定义的方式。

4. __init__ 函数首先调用父类的 __init__ 函数，并传递默认参数，这些参数是路径和 source_type，但是可以添加更多参数。这些参数不需要传递给父类的 __init__ 函数。

5. emit_scribe_dict 是一个抽象方法，因此任何其他被编写的类都必须定义它。然而，方法本身可以更改，但它应该返回上述描述的字典对象。

2. 在 scribe.py 的第 14 行将模块添加到 choices 列表中，当前看起来像这样：choices=['stockpile']，因为创建此文档时，只能使用 scribe 转写 stockpile 数据。

添加新的 scribe_modules

将 scribe_modules 扩展到支持新模块 'scribe_module_1' 的步骤包括

1. 在 'mutate/scribe_modules' 目录中添加一个新的类 'scribe_module_1.py'。它可能看起来像这样：```python

from . import ScribeModuleBaseClass

class Scribe_module_1(ScribeModuleBaseClass)

def __init__(self, input_dict=None, module_name=None, host_name=None,
             input_type=None, scribe_uuid=None):
    ScribeModuleBaseClass.__init__(self, module_name=module_name,
                                   input_dict=input_dict,
                                   host_name=host_name,
                                   input_type=input_type,
                                   scribe_uuid=scribe_uuid)
    if input_dict:
        new_dict = {}
        # ... this is where transformation occurs
        # ... can call other member functions of class
        # ... can set the entities of the class object like
        self.entity_1 = input_dict

# This isn't needed here, as it's how the __iter__ function is defined
# in the parent class and it's not an abstractmethod, so only if you'd
# like to change how __iter__ method should work for your class, you
# should add the following next lines.
# Not recommended, unless you know what you're doing
def __iter__(self):
      # ... your definition of how to make it iterable

```

注意以下重要事项

1. 需要存在 from . import ScribeModuleBaseClass，因为我们正在从 ScribeModuleBaseClass 继承

2. class Example1(ScribeModuleBaseClass) 是继承发生的地方，确保在编写类时存在 '(ScribeModuleBaseClass)'。

3. 类名中第一个字母必须大写，这是工厂方法定义的方式。

4. __init__ 函数首先调用父类的 __init__ 函数，并传递默认参数，这些参数是 module_name、input_dict、host_name、input_type 和 scribe_uuid。请注意，不能再传递其他参数。

5. 新实体应仅在 __init__ 函数内部设置，但用户可以从同一类或从 lib/util.py 调用其他方法来执行转换，具有灵活性。

2. 将新类 'example1.yml' 的模式添加到 'mutate/schema' 目录。Scribe 当前使用 cerberus 验证 scribe_modules 子类生成的可迭代对象。请参阅 http://docs.python-cerberus.org/en/stable/validation-rules.html 了解有关如何为您的类输出编写模式的更多信息。

注意：yml 文件名应与为 scribe_modules 类创建的文件名匹配。因此，对于 'example1' 类，文件应命名为 'example1.yml'。