squadproject/squad-client

squad-client

镜像概述和主要用途

squad-client是一个用于通过API访问https://github.com/Linaro/squad%E5%AE%9E%E4%BE%8B%E6%95%B0%E6%8D%AE%E7%9A%84%E5%B7%A5%E5%85%B7%E3%80%82%E5%85%B6%E8%AE%BE%E8%AE%A1%E7%9B%AE%E6%A0%87%E6%98%AF%E5%B0%BD%E5%8F%AF%E8%83%BD%E6%8E%A5%E8%BF%91SQUAD%E7%9A%84%E6%95%B0%E6%8D%AE%E6%A8%A1%E5%9E%8B%EF%BC%8C%E9%80%9A%E8%BF%87%E4%BD%BF%E7%94%A8%E7%9B%B4%E8%A7%82%E7%9A%84%E7%B1%BB%E5%92%8C%E6%96%B9%E6%B3%95%EF%BC%8C%E4%BD%BF%E7%86%9F%E6%82%89SQUAD%E6%9C%AF%E8%AF%AD%E7%9A%84%E7%94%A8%E6%88%B7%E8%83%BD%E5%A4%9F%E8%BD%BB%E6%9D%BE%E4%B8%8A%E6%89%8B%E3%80%82%E8%AF%A5%E5%B7%A5%E5%85%B7%E7%9B%AE%E5%89%8D%E5%A4%84%E4%BA%8E%E6%97%A9%E6%9C%9F%E5%BC%80%E5%8F%91%E9%98%B6%E6%AE%B5%EF%BC%8C%E5%A6%82%E6%9C%89%E5%8F%91%E7%8E%B0bug%E8%AF%B7%E5%8F%8D%E9%A6%88%E3%80%82

核心功能和特性

• 贴近SQUAD数据模型：采用与SQUAD核心数据模型一致的类和方法设计，降低使用门槛
• 简化报告定制：支持基于特定需求快速生成自定义报告
• 多方式数据查询：提供YAML配置文件简化查询和Python代码实现复杂查询两种方式
• 直观的链式调用：支持通过类实例链式调用获取SQUAD中的组、项目、构建等数据

使用场景和适用范围

适用于需要从SQUAD实例获取数据并生成定制化报告的用户，尤其是熟悉SQUAD术语的开发、测试或数据分析人员。可广泛应用于自动化报告生成、测试结果分析、项目数据统计等场景。

使用方法和配置说明

报告生成（基础YAML配置方式）

1. 创建报告配置文件

创建YAML格式的报告配置文件（例如my-report.yml）：

yaml
squad_url: http://localhost:8000
reports:
    - name: 报告名称
      template: my_template.html.jinja2
      # output: generated_report.html  # 可选，省略则输出到stdout
      context:
          # 此处定义的键将在模板中可用
          projects: # 等同于代码中的 projects = Squad().projects(group__slug='lkft')
              type: Project
              filters:
                  group__slug: lkft  

2. 创建Jinja2模板文件

创建Jinja2模板文件（例如my_template.html.jinja2）：

jinja2
{% for project_id, project in projects.items() %}
  {{ project.slug }}
{% endfor %}

3. 生成报告

执行以下命令生成报告：

sh
./manage.py report --report-config my-report.yaml

输出示例：

    project: linaro-hikey-stable-rc-4.4-oe

    project: linux-developer-oe

    project: linux-mainline-oe

    project: linux-mainline-oe-sanity

    project: linux-next-oe

    project: linux-next-oe-new
    
    ...

复杂报告（Python代码方式）

对于更复杂的数据筛选和检索需求，可通过Python代码实现：

基础示例：获取特定构建

python
from squad_client.core.api import SquadApi
from squad_client.core.models import Squad

# 配置SQUAD API地址
SquadApi.configure(url='https://qa-reports.linaro.org/')

# 分步获取构建
group = Squad().group('lkft')
project = group.project('linux-stable-rc-4.14-oe-sanity')
build = project.build('v4.14.74')

# 或使用链式调用
build = Squad().group('lkft').project('linux-stable-rc-4.14-oe-sanity').build('v4.14.74')

# 带筛选条件的查询
finished_builds = Squad().group('lkft').project('linux-stable-rc-4.14-oe-sanity').builds(status__finished=True)

更多示例

可参考项目中的examples文件夹获取更多复杂查询和报告生成示例。