Wykonywanie profilu

W tym scenariuszu używasz interfejsów Talend API do wykonywania profilu w celu poprawy jakości projektu.

Method: POST
endpoint: api/v1/projects/quality/profiles/{id}/executions
payload:
    {
  "repository": "string",
  "authentication": {
    "username": "string",
    "passcode": "string"
  },
  "branch": "string",
  "workspace": "string",
  "client": "UI"
    }

1. Wywołaj punkt końcowy GET api/v1/projects/quality/profiles, aby uzyskać identyfikator profilu, który chcesz wykonać.
2. Zanotuj identyfikator profilu, który chcesz wykonać.
3. Wywołaj punkt końcowy POST api/v1/projects/quality/profiles/{id}/executions, aby wykonać profil. Dodaj identyfikator profilu, który chcesz wykonać jako parametr.
4. W obszarze Treść wprowadź następujące informacje:

   Nazwa parametru	Wartość
   repozytorium	Wprowadź nazwę repozytorium.
   nazwa użytkownika	Wprowadź swoją nazwę użytkownika.
   kod dostępu	Wprowadź swój kod dostępu.
   gałąź	Wprowadź nazwę gałęzi.
   obszar roboczy	Wprowadź nazwę obszaru roboczego.
   klient	Wprowadź nazwę klienta.

   Przykład:

    {
     "repository": "GIT",
     "authentication": {
       "username": "******",
       "passcode": "*************"
     },
     "branch": "master",
     "workspace": "PROJECT_73",
     "client": "UI"
   }

5. Kliknij Wykonaj, aby wykonać wywołanie.

Wyniki

Oto przykład odpowiedzi:

{
  "id": "67",
  "status": "FAILED",
  "startTimestamp": "2023-10-13 17:36",
  "duration": "2s",
  "specifications": [
    {
      "id": "69",
      "specification": {
        "id": "2",
        "name": "best-practice",
        "description": "This specification contains rules related to best practices",
        "operator": "is_Equal_to",
        "threshold": 100,
        "thresholdType": "PERCENTAGE",
        "createdBy": "system"
      },
      "status": "FAILED",
      "rules": [
        {
          "id": "77",
          "rule": {
            "id": "4",
            "name": "Active-tLogRow",
            "description": "Identify jobs with tLogRow components",
            "category": "COMPONENT",
            "severity": "MINOR",
            "operator": "is_less_than_or_Equal",
            "threshold": "5",
            "thresholdType": "PERCENTAGE",
            "createdBy": "system"
          },
          "result": "30",
          "status": "FAILED"
        },
        {
          "id": "78",
          "rule": {
            "id": "5",
            "name": "JavaLogs",
            "description": "Identify jobs that contain java logs.",
            "category": "COMPONENT",
            "severity": "INFO",
            "operator": "is_less_than_or_Equal",
            "threshold": "50",
            "thresholdType": "PERCENTAGE",
            "createdBy": "system"
          },
          "result": "4.56",
          "status": "PASSED"
        }
      ],
      "duration": "1s"
    }
  ],
  "sourceProvider": {
    "providerType": "LOCAL",
    "workspace": "D:\\Talend_Studio\\studio\\workspaces\\qtcmt_test",
    "project": "PROJECT_73"
  },
  "info": {
    "version": "7.3.1",
    "label": "PROJECT_73",
    "description": "Project imported from TalendPS organization",
    "productVersion": "Talend Real-time Big Data Platform-7.3.1.20221115_1012-patch",
    "type": "DQ",
    "bigData": false,
    "local": false
  },
  "inventory": {
    "total_artifact_assets": 258,
    "context_group": 11,
    "standard_job": 210,
    "standard_job_versions": 211,
    "standard_joblet": 24,
    "standard_joblet_versions": 24,
    "resource": 2,
    "resource_versions": 24,
    "bd_batch": 1,
    "bd_batch_versions": 1,
    "bd_batch_joblet": 0,
    "bd_batch_joblet_versions": 0,
    "bd_streaming": 1,
    "bd_streaming_versions": 1,
    "bd_streaming_joblet": 0,
    "bd_streaming_joblet_versions": 0,
    "route": 46,
    "route_versions": 46,
    "routelet": 1,
    "routelet_versions": 1
  },
  "commits": [
    {
      "id": "24b228d45561e0a741a0409195ef492437bf3",
      "date": "Tue Feb 21 01:29:11 2023 +0000",
      "author": "talend <talend@3bed803c5b79>",
      "message": "\tCreate Project: PRJ_731\n"
    }
  ]
}

W tym przykładzie reguła Active-tLogRow wyszukuje zadań z tLogRow komponentami. Zgodnie z warunkiem, całkowita liczba zidentyfikowanych zasobów powinna być mniejsza niż maksymalna wartość progu, która wynosi tutaj 5.

Wynik w tym przykładzie to 30. Sprawdzenie jakości reguły nie powiodło się. Status reguły to Niepowodzenie. Status każdej reguły jest oceniany na podstawie porównania między wynikiem a progiem.

Ogólna jakość projektu jest określana przez status specyfikacji. Status specyfikacji jest walidowany przez skumulowany wynik lub status wszystkich reguł. W tym przykładzie, próg jest ustawiony na 100%. W tym przypadku, nawet jeśli pojedynczy warunek lub reguła nie powiedzie się, specyfikacja nie powiedzie się, a status zostanie ustawiony na Niepowodzenie.

Próg, typ progu i operator mogą zostać zaktualizowane na podstawie wpływu reguł i specyfikacji na jakość Twojego Talend projektu.

Po wykonaniu wszystkich specyfikacji status wykonania jest ustawiany na podstawie następującego warunku:

• Zakończono pomyślnie: Status, jeśli wszystkie specyfikacje zostały zakończone pomyślnie.
• Niepowodzenie: Status, jeśli jakakolwiek specyfikacja zakończyła się niepowodzeniem.
• Anulowano: Status, jeśli wykonanie zostało anulowane.
• W toku: Status, jeśli wykonanie jest w toku.

Dostęp do wykonań można uzyskać za pomocą punktu końcowego GET /api/v1/projects/quality/profiles/executions. Wykonania można filtrować według kilku kryteriów: statusu wykonania od określonego czasu rozpoczęcia lub nazwy projektu.

Wykonania mogą być również usunięte na podstawie identyfikatorów wykonania, statusu, czasu rozpoczęcia lub nazwy projektu.