Skip to main content

JavaScript

在本示例中，您将创建一个 package 蓝图，该蓝图将使用 Port 的API 和webhook functionality 组合，在 package.json 文件中引用所有第三方依赖和库。然后，您将把该蓝图与 service 蓝图关联起来，这样就可以映射服务所引用的所有软件包。

为了将软件包引用到 Port，需要使用一个脚本，根据 webhook 配置发送软件包信息。

先决条件​

创建以下蓝图定义和 webhook 配置:

Service blueprint
{
  "identifier": "service",
  "title": "Service",
  "icon": "Service",
  "schema": {
    "properties": {
      "description": {
        "title": "Description",
        "type": "string"
      }
    },
    "required": []
  },
  "mirrorProperties": {},
  "calculationProperties": {},
  "relations": {}
}
Package blueprint
{
  "identifier": "packages",
  "description": "This blueprint represents a software package file in our catalog",
  "title": "Package",
  "icon": "Package",
  "schema": {
    "properties": {
      "version": {
        "type": "string",
        "title": "Depedency Version"
      }
    },
    "required": []
  },
  "mirrorProperties": {},
  "calculationProperties": {},
  "relations": {
    "service": {
      "title": "Service",
      "target": "service",
      "required": false,
      "many": true
    }
  }
}
Package webhook configuration
{
  "identifier": "packagesMapper",
  "title": "Package Mapper",
  "description": "A webhook configuration to map packages and dependencies from a file",
  "icon": "Package",
  "mappings": [
    {
      "blueprint": "packages",
      "itemsToParse": ".body.dependencies",
      "entity": {
        "identifier": ".item.id",
        "title": ".item.name",
        "properties": {
          "version": ".item.version"
        },
        "relations": {
          "service": ".body.service"
        }
      }
    }
  ],
  "enabled": true,
  "security": {}
}

使用 Port 的 API 和 Bash 脚本​

下面是一个示例片段，展示了如何使用 Python 和 Bash 将 Port 的 API 和 webhook 与现有管道集成:

在版本库中创建以下 Python 脚本，以创建或更新 Port 实体，作为管道的一部分:

Python script example 
import requests
import json

# Get environment variables using the config object or os.environ["KEY"]
WEBHOOK_URL = os.environ['WEBHOOK_URL'] ## the value of the URL you receive after creating the Port webhook
SERVICE_ID = os.environ['SERVICE_ID'] ## The identifier of your service in Port
PATH_TO_PACKAGE_JSON_FILE = os.environ['PATH_TO_PACKAGE_JSON_FILE']

def add_entity_to_port(entity_object):
    """A function to create the passed entity in Port using the webhook URL

    Params
    --------------
    entity_object: dict
        The entity to add in your Port catalog

    Returns
    --------------
    response: dict
        The response object after calling the webhook
    """
    headers = {"Accept": "application/json"}
    response = requests.post(WEBHOOK_URL, json=entity_object, headers=headers)
    return response.json()

def convert_package_json(package_json_path):
    """This function takes a package.json file path, converts the "dependencies" property into a
    JSON array using three keys (name, version, and id). It then sends the data to Port

    Params
    --------------
    package_json_path: str
        The path to the package.json file relative to the project's root folder

    Returns
    --------------
    response: dict
        The response object after calling the webhook
    """
    with open(package_json_path) as file:
        data = json.load(file)

    dependencies = data.get('dependencies', {})

    converted_dependencies = []
    for index, (name, version) in enumerate(dependencies.items(), start=1):
        pkg_id = f"pkg-{index}"
        converted_dependencies.append({
            'name': name,
            'version': version,
            'id': pkg_id
        })

    entity_object = {
        "service": SERVICE_ID,
        "dependencies": converted_dependencies
    }
    webhook_response = add_entity_to_port(entity_object)
    return webhook_response

converted_data = convert_package_json(PATH_TO_PACKAGE_JSON_FILE)
print(converted_data)

有关如何将上述脚本与现有 Gitlab CI Pipelines 集成的示例，请访问: