Skip to content
Snippets Groups Projects
Unverified Commit d58833ac authored by Niklas Schulte's avatar Niklas Schulte Committed by GitHub
Browse files

feat: extract response ids in postman collection (#352) 

* feat: add script to catch and reuse the policy id

adding a postman post-request script to add the policy-id of "asset-1" as a postman environment variable of request "Get Cached Catalogs" and reusing it in "Initiate Negotiation".

* feat: update script to use .find() instead of RegExp

* feat: carry over contractAgreementId to initiate transfer

* feat: finalize carrying over variables to the next request

* feat: add check for correct asset: "asset-1" and make sure return code for scripts is <=200 and <300

* feat: add newman tests

* feat: add header and Control Plane Management Folder in newman test

* feat: update newman command

* feat: update newman command

* feat: update path

* feat: add postman tests to check for a 200 OK response status code

* feat: add delay between postman tests

* feat: extend delay between postman tests

* feat: add check for a non-empty body in Get cached EDRs

* feat: enable verbose output and update checks for empty response body

* empty commit to restart tests

* feat: add terraform setup

* feat: update tests for collection

* feat: add missing file

* feat: update terraform setup in actions
parent 96197ceb
No related branches found
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
.github/workflows/run-e2e-tests.yml
+ 3
− 0
View file @ d58833ac
......@@ -48,6 +48,9 @@ jobs:
- name: "Setup Kubectl"
uses: azure/setup-kubectl@v4
- name: "Setup Terraform"
uses: hashicorp/setup-terraform@v3
- uses: actions/checkout@v4
- uses: eclipse-edc/.github/.github/actions/setup-build@main
......
.github/workflows/test_controlplane_management.yml 0 → 100644
+ 104
− 0
View file @ d58833ac
#
# Copyright (c) 2024 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License, Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
# SPDX-License-Identifier: Apache-2.0
#
name: Run Newman Test for the Control Plane Management
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
newman_test:
runs-on: ubuntu-latest
steps:
- name: "Setup Helm"
uses: azure/setup-helm@v4
with:
version: v3.8.1
- name: "Setup Kubectl"
uses: azure/setup-kubectl@v4
- uses: actions/checkout@v4
- uses: eclipse-edc/.github/.github/actions/setup-build@main
- name: "Setup Terraform"
uses: hashicorp/setup-terraform@v3
- name: "Build runtime images"
working-directory: ./
run: |
./gradlew -Ppersistence=true dockerize
- name: "Create k8s Kind Cluster"
uses: helm/kind-action@v1.10.0
with:
config: deployment/kind.config.yaml
cluster_name: dcp-demo
- name: "Load runtime images into KinD"
run: kind load docker-image controlplane:latest dataplane:latest identity-hub:latest catalog-server:latest sts:latest -n dcp-demo
- name: "Install nginx ingress controller"
run: |-
echo "::notice title=nginx ingress on KinD::For details how to run nginx ingress on KinD check https://kind.sigs.k8s.io/docs/user/ingress/#ingress-nginx"
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/main/deploy/static/provider/kind/deploy.yaml
kubectl wait --namespace ingress-nginx \
--for=condition=ready pod \
--selector=app.kubernetes.io/component=controller \
--timeout=90s
- name: "Terraform init"
working-directory: ./deployment
run: |-
terraform init -reconfigure
- name: "Terraform plan"
working-directory: ./deployment
run: |-
terraform plan -out=$GITHUB_SHA.out
- name: "Terraform apply"
working-directory: ./deployment
run: |-
terraform apply "$GITHUB_SHA.out"
- name: "Seed dataspace"
run: |-
chmod +x seed-k8s.sh
./seed-k8s.sh
- name: "Install npm"
uses: actions/setup-node@v4
with:
node-version: 18
- name: "Install Newman"
run: npm install -g newman
- name: "Run Newman"
working-directory: ./deployment/postman
run: |-
newman run "MVD.postman_collection.json" -e "MVD K8S.postman_environment.json" --folder "ControlPlane Management" --delay-request 5000 --verbose
.github/workflows/verify.yaml
+ 2
− 0
View file @ d58833ac
......@@ -52,6 +52,7 @@ jobs:
checkstyle:
runs-on: ubuntu-latest
steps:
- uses: hashicorp/setup-terraform@v3
- uses: actions/checkout@v4
- uses: eclipse-edc/.github/.github/actions/setup-build@main
- name: Run Checkstyle
......@@ -65,6 +66,7 @@ jobs:
validate-terraform:
runs-on: ubuntu-latest
steps:
- uses: hashicorp/setup-terraform@v3
- uses: actions/checkout@v4
- name: Check Terraform files are properly formatted (run "terraform fmt -recursive" to fix)
run: |
......
deployment/postman/MVD.postman_collection.json
+ 268
− 7
View file @ d58833ac
{
"info": {
"_postman_id": "7921ef6e-cb34-4f23-b401-f00bf74a12ec",
"_postman_id": "1d81d8db-ffb2-417b-83ca-50da1b42a5df",
"name": "MVD+IATP",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "27652630"
"_exporter_id": "23917208"
},
"item": [
{
......@@ -363,6 +363,20 @@
"item": [
{
"name": "Get Assets",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is >=200 and <300\", function () {",
" pm.expect(pm.response.code < 300 && pm.response.code >= 200).to.be.true",
"});"
],
"type": "text/javascript",
"packages": {}
}
}
],
"request": {
"method": "POST",
"header": [],
......@@ -388,6 +402,20 @@
},
{
"name": "Request Catalog",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is >=200 and <300\", function () {",
" pm.expect(pm.response.code < 300 && pm.response.code >= 200).to.be.true",
"});"
],
"type": "text/javascript",
"packages": {}
}
}
],
"request": {
"method": "POST",
"header": [],
......@@ -413,6 +441,42 @@
},
{
"name": "Get Cached Catalogs",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// get the policy id of \"asset-1\" and save it as an environment variable",
"if(pm.response.code < 300 && pm.response.code >= 200){",
" if(pm.response.json().length > 0){",
" const dcat_datasets = pm.response.json()[0][\"dcat:dataset\"][1][\"dcat:dataset\"]",
" const asset_1 = dcat_datasets.find((asset) => asset[\"@id\"] == \"asset-1\")",
" pm.environment.set(\"POLICY_ID_ASSET_1\", asset_1[\"odrl:hasPolicy\"][\"@id\"]);",
" }",
"}",
"",
"pm.test(\"Status code is >=200 and <300\", function () {",
" pm.expect(pm.response.code < 300 && pm.response.code >= 200).to.be.true",
"});",
"pm.test(\"Policy id for asset 1 is set\", function(){",
" pm.expect(pm.environment.get(\"POLICY_ID_ASSET_1\")).not.to.be.undefined",
"})"
],
"type": "text/javascript",
"packages": {}
}
},
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript",
"packages": {}
}
}
],
"request": {
"method": "POST",
"header": [],
......@@ -443,12 +507,43 @@
},
{
"name": "Initiate negotiation",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
"if(!pm.environment.has(\"POLICY_ID_ASSET_1\")){",
" throw new Error('Policy-ID of Asset-1 is not yet available, please execute request \"Get Cached Catalog\" first!');",
"}"
],
"type": "text/javascript",
"packages": {}
}
},
{
"listen": "test",
"script": {
"exec": [
"pm.environment.set(\"CONTRACT_NEGOTIATION_ID\", pm.response.json()[\"@id\"])",
"",
"pm.test(\"Status code is >=200 and <300\", function () {",
" pm.expect(pm.response.code < 300 && pm.response.code >= 200).to.be.true",
"});",
"pm.test(\"Contract negotiation id is set\", function(){",
" pm.expect(pm.environment.get(\"CONTRACT_NEGOTIATION_ID\")).not.to.be.undefined",
"})"
],
"type": "text/javascript",
"packages": {}
}
}
],
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"@context\": [\n \"https://w3id.org/edc/connector/management/v0.0.1\"\n ],\n \"@type\": \"ContractRequest\",\n \"counterPartyAddress\": \"{{PROVIDER_DSP_URL}}/api/dsp\",\n \"counterPartyId\": \"{{PROVIDER_ID}}\",\n \"protocol\": \"dataspace-protocol-http\",\n \"policy\": {\n \"@type\": \"Offer\",\n \"@id\": \"bWVtYmVyLWFuZC1kYXRhcHJvY2Vzc29yLWRlZg==:YXNzZXQtMQ==:MmQ0ZWZjZTYtYzJjNy00NTM5LTk5ODAtZDAwOTlkZDNkOWQy\",\n \"assigner\": \"{{PROVIDER_ID}}\",\n \"permission\": [],\n \"prohibition\": [],\n \"obligation\": {\n \"action\": \"use\",\n \"constraint\": {\n \"leftOperand\": \"DataAccess.level\",\n \"operator\": \"eq\",\n \"rightOperand\": \"processing\"\n }\n },\n \"target\": \"asset-1\"\n },\n \"callbackAddresses\": []\n}",
"raw": "{\n \"@context\": [\n \"https://w3id.org/edc/connector/management/v0.0.1\"\n ],\n \"@type\": \"ContractRequest\",\n \"counterPartyAddress\": \"{{PROVIDER_DSP_URL}}/api/dsp\",\n \"counterPartyId\": \"{{PROVIDER_ID}}\",\n \"protocol\": \"dataspace-protocol-http\",\n \"policy\": {\n \"@type\": \"Offer\",\n \"@id\": \"{{POLICY_ID_ASSET_1}}\",\n \"assigner\": \"{{PROVIDER_ID}}\",\n \"permission\": [],\n \"prohibition\": [],\n \"obligation\": {\n \"action\": \"use\",\n \"constraint\": {\n \"leftOperand\": \"DataAccess.level\",\n \"operator\": \"eq\",\n \"rightOperand\": \"processing\"\n }\n },\n \"target\": \"asset-1\"\n },\n \"callbackAddresses\": []\n}",
"options": {
"raw": {
"language": "json"
......@@ -472,6 +567,37 @@
},
{
"name": "Get Contract Negotiations",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// get the contact agreement id and save it as an environment variable",
"if(pm.response.code < 300 && pm.response.code >= 200 && pm.response.json().length > 0){",
" var find_negotiation;",
" if (pm.environment.has(\"CONTRACT_NEGOTIATION_ID\")){",
" find_negotiation = pm.response.json().find((el) => el[\"@id\"] == pm.environment.get(\"CONTRACT_NEGOTIATION_ID\"))",
" }",
"",
" if(find_negotiation){",
" const contractAgreementId = find_negotiation[\"contractAgreementId\"];",
" pm.environment.set(\"CONTRACT_AGREEMENT_ID\", contractAgreementId);",
" }",
"}",
"",
"pm.test(\"Status code is >=200 and <300\", function () {",
" pm.expect(pm.response.code < 300 && pm.response.code >= 200).to.be.true",
"});",
"pm.test(\"Contract Agreement ID is set\", function(){",
" pm.expect(pm.environment.get(\"CONTRACT_AGREEMENT_ID\")).not.to.be.undefined",
"})",
""
],
"type": "text/javascript",
"packages": {}
}
}
],
"request": {
"method": "POST",
"header": [],
......@@ -497,12 +623,39 @@
},
{
"name": "Initiate Transfer",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
"if(!pm.environment.has(\"CONTRACT_AGREEMENT_ID\")){",
" throw new Error('Contract Agreement ID is not yet available, please execute requests \"Initiate Negotiation and Get Contract Negotiation\" first!');",
"}"
],
"type": "text/javascript",
"packages": {}
}
},
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is >=200 and <300\", function () {",
" pm.expect(pm.response.code < 300 && pm.response.code >= 200).to.be.true",
"});",
""
],
"type": "text/javascript",
"packages": {}
}
}
],
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"@context\": [\n \"https://w3id.org/edc/connector/management/v0.0.1\"\n ],\n \"assetId\": \"asset-1\",\n \"counterPartyAddress\": \"{{PROVIDER_DSP_URL}}/api/dsp\",\n \"connectorId\": \"{{PROVIDER_ID}}\",\n \"contractId\": \"47e43627-d9b0-4e35-b534-cef450d7de88\",\n \"dataDestination\": {\n \"type\": \"HttpProxy\"\n },\n \"protocol\": \"dataspace-protocol-http\",\n \"transferType\": \"HttpData-PULL\"\n}",
"raw": "{\n \"@context\": [\n \"https://w3id.org/edc/connector/management/v0.0.1\"\n ],\n \"assetId\": \"asset-1\",\n \"counterPartyAddress\": \"{{PROVIDER_DSP_URL}}/api/dsp\",\n \"connectorId\": \"{{PROVIDER_ID}}\",\n \"contractId\": \"{{CONTRACT_AGREEMENT_ID}}\",\n \"dataDestination\": {\n \"type\": \"HttpProxy\"\n },\n \"protocol\": \"dataspace-protocol-http\",\n \"transferType\": \"HttpData-PULL\"\n}",
"options": {
"raw": {
"language": "json"
......@@ -526,6 +679,21 @@
},
{
"name": "Get transfer processes",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is >=200 and <300\", function () {",
" pm.expect(pm.response.code < 300 && pm.response.code >= 200).to.be.true",
"});",
""
],
"type": "text/javascript",
"packages": {}
}
}
],
"request": {
"method": "POST",
"header": [],
......@@ -556,6 +724,30 @@
},
{
"name": "Get cached EDRs",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// get the transfer process id of \"asset-1\" and save it as an environment variable if the response body is not empty",
"if(pm.response.code < 300 && pm.response.code >= 200 && pm.response.json().length > 0){",
" const transferProcessId = pm.response.json()[0][\"transferProcessId\"];",
" pm.environment.set(\"TRANSFER_PROCESS_ID\", transferProcessId);",
"}",
"",
"pm.test(\"Status code is >=200 and <300\", function () {",
" pm.expect(pm.response.code < 300 && pm.response.code >= 200).to.be.true",
"});",
"pm.test(\"Transfer process id is set\", function(){",
" pm.expect(pm.environment.get(\"TRANSFER_PROCESS_ID\")).not.to.be.undefined",
"})",
""
],
"type": "text/javascript",
"packages": {}
}
}
],
"request": {
"method": "POST",
"header": [],
......@@ -581,11 +773,54 @@
},
{
"name": "Get EDR DataAddress for TransferId",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
"if(!pm.environment.has(\"TRANSFER_PROCESS_ID\")){",
" throw new Error('Transfer Process ID is not yet available, please execute request \"Get Transfer Processes\" first!');",
"}"
],
"type": "text/javascript",
"packages": {}
}
},
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is >=200 and <300\", function () {",
" pm.expect(pm.response.code < 300 && pm.response.code >= 200).to.be.true",
"});"
],
"type": "text/javascript",
"packages": {}
}
},
{
"listen": "test",
"script": {
"exec": [
"// get the authorization token and save it as an environment variable",
"if(pm.response.code < 300 && pm.response.code >= 200){",
" //using the first authorization token found",
" const authorization = pm.response.json()[\"authorization\"];",
" pm.environment.set(\"AUTHORIZATION\", authorization);",
"}",
"",
""
],
"type": "text/javascript",
"packages": {}
}
}
],
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{HOST}}/api/management/v3/edrs/713dfab7-c70a-4c7b-9756-d372647276b5/dataaddress",
"raw": "{{HOST}}/api/management/v3/edrs/{{TRANSFER_PROCESS_ID}}/dataaddress",
"host": [
"{{HOST}}"
],
......@@ -594,7 +829,7 @@
"management",
"v3",
"edrs",
"713dfab7-c70a-4c7b-9756-d372647276b5",
"{{TRANSFER_PROCESS_ID}}",
"dataaddress"
]
}
......@@ -603,6 +838,32 @@
},
{
"name": "Download Data from Public API",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
"if(!pm.environment.has(\"AUTHORIZATION\")){",
" throw new Error(' The authorization token is not yet available, please execute request \"Get EDR DataAddress for TransferId\" first!');",
"}"
],
"type": "text/javascript",
"packages": {}
}
},
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is >=200 and <300\", function () {",
" pm.expect(pm.response.code < 300 && pm.response.code >= 200).to.be.true",
"});"
],
"type": "text/javascript",
"packages": {}
}
}
],
"request": {
"auth": {
"type": "noauth"
......@@ -611,7 +872,7 @@
"header": [
{
"key": "Authorization",
"value": "eyJraWQiOiJkaWQ6d2ViOmxvY2FsaG9zdCUzQTcwOTMja2V5LTEiLCJhbGciOiJFUzI1NiJ9.eyJpc3MiOiJkaWQ6d2ViOmxvY2FsaG9zdCUzQTcwOTMiLCJhdWQiOiJkaWQ6d2ViOmxvY2FsaG9zdCUzQTcwODMiLCJzdWIiOiJkaWQ6d2ViOmxvY2FsaG9zdCUzQTcwOTMiLCJpYXQiOjE3MjEzOTMxNjU5ODgsImp0aSI6ImFmOWI2YWIyLTMwNjYtNDNlNi1hNjg1LWIyMDVjNTFkZmJhMyJ9.ute0sLuMgc0bzG_ZUGG9G3pliFfANf9pWDxReiRrWjGudgUa4YmR9ftB5LeZTOvKCBJshRpbZX-hnQxR8fXMWA",
"value": "{{AUTHORIZATION}}",
"type": "text"
}
],
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment