hmcts/ccd-definition-processor

ccd-definition-processor

概述

支持CCD配置协作开发的工具，通过基于文本的CCD定义表示，支持文本比较、变更控制以及在开发过程中将配置视为源代码进行处理。

核心功能和特性

变量替换

json2xlsx处理器能够将JSON定义文件中定义的变量占位符替换为从环境变量读取的值，只要变量名以CCD_DEF前缀开头。

例如，环境变量CCD_DEF_BASE_URL=http://localhost会注入到以下CCD定义片段中：

json
[
  {
    "LiveFrom": "2017-01-01",
    "CaseTypeID": "DRAFT",
    "ID": "initiateCase",
    "CallBackURLSubmittedEvent": "${CCD_DEF_BASE_URL}/callback"
  }
]

替换后变为：

json
[
  {
    "LiveFrom": "2017-01-01",
    "CaseTypeID": "DRAFT",
    "ID": "initiateCase",
    "CallBackURLSubmittedEvent": "http://localhost/callback"
  }
]

JSON片段

json2xlsx处理器能够读取较小的CCD定义JSON片段，有助于将大型定义文件拆分为更小的块。这些片段可以从任意嵌套层级的目录中读取，只要顶层目录对应有效的工作表名称。

例如，以下大型AuthorisationCaseField.json文件：

json
[
  {
    "LiveFrom": "01/01/2017",
    "CaseTypeID": "DRAFT",
    "CaseFieldID": "caseTitle",
    "UserRole": "caseworker",
    "CRUD": "CRU"
  },
  {
    "LiveFrom": "01/01/2017",
    "CaseTypeID": "DRAFT",
    "CaseFieldID": "caseTitle",
    "UserRole": "solicitor",
    "CRUD": "CRU"
  }
]

可以拆分为caseworker.json：

json
[
  {
    "LiveFrom": "01/01/2017",
    "CaseTypeID": "DRAFT",
    "CaseFieldID": "caseTitle",
    "UserRole": "caseworker",
    "CRUD": "CRU"
  }
]

和solicitor.json：

json
[
  {
    "LiveFrom": "01/01/2017",
    "CaseTypeID": "DRAFT",
    "CaseFieldID": "caseTitle",
    "UserRole": "solicitor",
    "CRUD": "CRU"
  }
]

并将这两个文件放在与XLS工作表名对应的AuthorisationCaseField目录中。

访问控制快捷方式

UserRoles和AccessControl标签具有特殊含义，可减少访问控制相关定义的冗余。

json
[
  {
    "LiveFrom": "01/01/2017",
    "CaseTypeID": "DRAFT",
    "CaseFieldID": "caseTitle",
    "UserRoles": ["caseworker1","caseworker2"],
    "CRUD": "CRU"
  }
]

会转换为：

json
[
  {
    "LiveFrom": "01/01/2017",
    "CaseTypeID": "DRAFT",
    "CaseFieldID": "caseTitle",
    "UserRole": "caseworker1",
    "CRUD": "CRU"
  },
  {
    "LiveFrom": "01/01/2017",
    "CaseTypeID": "DRAFT",
    "CaseFieldID": "caseTitle",
    "UserRole": "caseworker2",
    "CRUD": "CRU"
  }
]

而：

json
[
  {
    "LiveFrom": "01/01/2017",
    "CaseTypeID": "DRAFT",
    "CaseFieldID": "caseTitle",
    "AccessControl": [
      {
        "UserRoles": ["caseworker1", "caseworker2"],
        "CRUD": "CR"
      },
      {
        "UserRoles": ["caseworker3"],
        "CRUD": "D"
      }
    ]
  }
]

会转换为：

json
[
  {
    "LiveFrom": "01/01/2017",
    "CaseTypeID": "DRAFT",
    "CaseFieldID": "caseTitle",
    "UserRole": "caseworker1",
    "CRUD": "CR"
  },
  {
    "LiveFrom": "01/01/2017",
    "CaseTypeID": "DRAFT",
    "CaseFieldID": "caseTitle",
    "UserRole": "caseworker2",
    "CRUD": "CR"
  },
  {
    "LiveFrom": "01/01/2017",
    "CaseTypeID": "DRAFT",
    "CaseFieldID": "caseTitle",
    "UserRole": "caseworker3",
    "CRUD": "D"
  }
]

依赖

首次使用前需通过以下命令安装依赖：

sh
$ yarn install

使用方法

可用命令如下：

sh
$ yarn json2xlsx options
$ yarn xlsx2json options [<sheet name> ...]

命令接受以下参数：

json2xlsx

options:

• -o 输出XLSX文件路径
• -D 输入JSON文件所在文件夹路径
• -e （可选）需要排除处理的文件通配符模式，以逗号分隔。例如：-e 'UserProfile.json, *-nonprod.json' 会排除UserProfile.json和所有以-nonprod.json结尾的文件

警告：

之前用于选择要处理的JSON文件的包含参数已被移除（替换为-e选项）。

xlsx2json

• -i 输入XLSX文件路径
• -D 输出JSON文件所在文件夹路径

[<sheet name> ...]: XLSX中要处理的工作表名称列表。数据将导入到名为.json的文件中。如果未指定工作表名称，则处理工作表文件夹路径中找到的所有JSON文件。

示例

要将./sheets文件夹中所有JSON文件导入到基于嵌入式模板CCD定义XLSX文件创建的名为CCD-Definition.xlsx的文件中，使用：

sh
$ yarn json2xlsx -D ./sheets -o CCD-Definition.xlsx

要导出CCD定义XLSX文件中的所有工作表，使用：

sh
$ yarn xlsx2json -D ./sheets -i CCD-Definition.xlsx

要仅导出CCD定义XLSX文件中的CaseType和CaseEvent工作表，使用：

sh
$ yarn xlsx2json -D ./sheets -i CCD-Definition.xlsx CaseType CaseEvent

Docker镜像

构建Docker镜像请运行：

bash
$ docker build --tag hmctspublic.azurecr.io/ccd/definition-processor:latest .

构建

Dockerhub（https://hub.docker.com/r/hmcts/ccd-definition-processor%EF%BC%89%E5%B7%B2%E5%BC%83%E7%94%A8%EF%BC%8C%E8%AF%B7%E4%BD%BF%E7%94%A8ACR%E3%80%82

任何提交或合并到master分支的操作都会自动触发Azure ACR任务。此任务已通过./bin/deploy-acr-task.sh手动创建，任务定义在acr-build-task.yaml中。

注意：运行部署脚本需要在GITHUB_TOKEN环境变量中定义GitHub个人令牌（https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line%EF%BC%89%E3%80%82%E8%AF%A5%E4%BB%A4%E7%89%8C%E7%94%A8%E4%BA%8E%E8%AE%BE%E7%BD%AEWebhook%EF%BC%8C%E4%BB%A5%E4%BE%BFAzure%E5%9C%A8%E5%8F%91%E7%94%9F%E5%90%88%E5%B9%B6%E6%88%96%E6%8F%90%E4%BA%A4%E6%97%B6%E6%94%B6%E5%88%B0%E9%80%9A%E7%9F%A5%E3%80%82%E7%A1%AE%E4%BF%9D%E6%82%A8%E6%98%AF%E4%BB%93%E5%BA%93%E7%AE%A1%E7%90%86%E5%91%98%EF%BC%8C%E5%B9%B6%E9%80%89%E6%8B%A9%E4%BB%A5%E4%B8%8B%E4%BB%A4%E7%89%8C%E4%BD%9C%E7%94%A8%E5%9F%9F%EF%BC%9A%60admin:repo_hook Full control of repository hooks`

有关ACR任务的更多信息，请参阅：[***]

许可证

本项目采用MIT许可证 - 详见LICENSE文件。