ctf-cli 1.0.2

features/

将任何特定于您容器的功能和场景放在此目录中。您的场景可以使用 tests/steps 目录中实现的任何步骤，或来自 tests.conf 文件中列出的任何远程测试中的步骤。CTF CLI 工具将把这些步骤组合起来，以便 Behave 在运行时能够找到它们。

steps/

将任何特定于您功能的步骤放在此目录中。为了确保步骤可以在远程机器或本地执行，始终使用 context.run() 来运行任何命令。在后台，命令将根据 CLI 配置在本地或远程机器上运行。

CLI 工具在执行 Behave 时将一些运行时参数传递给它。这些值可以通过作为对象存在于 context.config.userdata 字典中的上下文来获取。有关更多信息，请参阅 Behave 文档。以下值被传递

tests.conf

tests.conf 文件包含配置信息，告诉 CTF 在使用 Behave 测试容器时包括哪些额外的远程测试（步骤和功能）。它是一个简单的 INI 文件。每个远程测试都需要有它自己的部分，并在部分内部指定 Steps 和 Features 选项。这些选项必须指向包含适当的步骤和功能的远程 Git 仓库。示例 tests.conf

[common-tests]
Steps=https://github.com/Containers-Testing-Framework/common-steps.git
Features=https://github.com/Containers-Testing-Framework/common-features.git

environment.py

您可以在该文件中实现 Behave 通常使用的任何方法。它们将与 CTF 的通用 environment.py 文件结合。您的函数将在 CTF 钩子之前被调用。

要求

• git

• behave >= 1.2.5

• ansible

安装

1. 克隆仓库

   git clone https://github.com/Containers-Testing-Framework/ctf-cli.git

2. 可选：克隆一个示例仓库

   git clone https://github.com/Containers-Testing-Framework/example-project-postgresql.git

3. 切换到 ctf-cli 目录

   cd ctf-cli

4. 安装 Python 依赖项

   [sudo] pip install -r requirements.txt

5. 复制示例配置文件并按需编辑

   cp ctf.conf.sample ctf.conf
   cp tests.conf.sample tests.conf

6. 切换到项目目录并获取通用功能

   cd example-project-postgresql
   ../ctf-cli/ctf-cli.py remote add features https://github.com/Containers-Testing-Framework/common-features.git

7. 运行测试

   ../ctf-cli/ctf-cli.py run

配置文件

您可以使用 -c 或 --cli-config 选项在命令行上传递配置文件的路径。如果没有提供，则工具会按照以下顺序尝试找到配置

1. 当前目录中的 ctf.conf

2. 用户主目录 ~/ctf.conf 中的 ctf.conf

3. 用户主目录 ~/ctf/ctf.conf 中的 ctf.conf

4. 系统配置目录中的 ctf.conf （位于 /etc/ctf.conf）

配置必须包含 Ansible 的配置。在使用主机之前，您需要手动设置主机环境，然后才能运行 ctf-cli（例如，设置 SSH 密钥等）。以下是在 ctf.conf 中配置 Ansible 的示例：

[ansible]
Host=127.0.0.1
User=root
Method=ssh

用法

应在包含 Dockerfile 的项目目录下执行 ctf-cli。您可以将一些选项传递给 CLI 工具：

• -h，--help - 打印帮助信息并退出

• -v，--verbose - 使输出更加详细（推荐）

• -c CLI_CONFIG_PATH，--cli-config CLI_CONFIG_PATH - CLI 配置文件的路径（默认：'/etc/ctf-cli.conf'）

• -t TESTS_CONFIG_PATH，--tests-config TESTS_CONFIG_PATH - 测试配置文件的路径。默认情况下，将在 tests/ 目录中搜索

• -f DOCKERFILE，--dockerfile DOCKERFILE - 要使用的 Dockerfile 的路径。如果不传递，将在当前目录中搜索

• -i IMAGE，--image IMAGE - 用于测试的镜像。如果不传递，将从 Dockerfile 构建镜像

它是如何工作的？

当在 my_proj_dir 项目目录中执行 ctf-cli 时，会发生以下情况：

1. 读取 CLI 工具配置。

2. 在目录中搜索 tests/ 目录。

3. 在 tests/ 目录中搜索 tests.conf 配置。

4. 在当前目录内创建一个工作目录 my_proj_dir-behave-working-dir。

5. 在工作目录内创建 features 和 steps 目录。

6. 将项目特定的功能复制到工作目录中的 features/my_proj_dir_features。

7. 将项目特定的步骤复制到工作目录中的 steps/my_proj_dir_steps。

8. 如果 tests/ 中存在 environment.py，则将其复制到工作目录中，作为 my_proj_dir_environment.py。

9. 如果 tests.conf 中包含一些远程测试，它们的特征和步骤将以与（6）和（7）中本地文件类似的方式克隆到工作目录中。

10. 确保工作目录中 steps/ 内的所有子目录都包含 __init__.py。

11. 在工作目录的 steps/ 中创建 steps.py，它从所有步骤文件中导入一切。

12. 在工作目录中创建 environment.py，它包含 CTF 公共方法，并在存在的情况下包含项目特定的 environment.py 文件。

13. 在当前目录内使用所有必要的运行时参数运行 Behave。