Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

test: add k6 credential definition performance scenario #787

Closed
wants to merge 2 commits into from
Closed

test: add k6 credential definition performance scenario #787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd1a518
test: add k6 credential definition performance scenario
Nov 15, 2023
ef023f5
test: fix credential offer test
Nov 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions tests/performance-tests/atala-performance-tests-k6/src/actors/Issuer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,14 @@ export class Issuer extends Actor {
this.didService.waitForDidState(this.longFormDid!, "PUBLISHED");
}

createCredentialSchema() {
this.schema = this.credentialsService.createCredentialSchema(this.did!);
createCredentialSchema(schemaType: string = "json") {
this.schema = this.credentialsService.createCredentialSchema(this.did!, schemaType);
}


createCredentialDefinition() {
this.credentialsService.createCredentialDefinition(this.did!, this.schema!);
}

/**
* Creates a credential offer for the holder.
*/
Expand Down
6 changes: 3 additions & 3 deletions tests/performance-tests/atala-performance-tests-k6/src/common/Config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ export const ISSUER_AGENT_URL = __ENV.ISSUER_AGENT_URL || "http://localhost:8080
* API key for the Issuer agent.
* If not provided, the default value is an empty string.
*/
export const ISSUER_AGENT_API_KEY = __ENV.ISSUER_AGENT_API_KEY || "";
export const ISSUER_AGENT_API_KEY = __ENV.ISSUER_AGENT_API_KEY || "default";

/**
* URL for the Holder agent.
Expand All @@ -32,7 +32,7 @@ export const HOLDER_AGENT_URL = __ENV.HOLDER_AGENT_URL || "http://localhost:8090
* API key for the Holder agent.
* If not provided, the default value is an empty string.
*/
export const HOLDER_AGENT_API_KEY = __ENV.HOLDER_AGENT_API_KEY || "";
export const HOLDER_AGENT_API_KEY = __ENV.HOLDER_AGENT_API_KEY || "default";

/**
* URL for the Verifier agent.
Expand All @@ -44,4 +44,4 @@ export const VERIFIER_AGENT_URL = __ENV.VERIFIER_AGENT_URL || "http://localhost:
* API key for the Verifier agent.
* If not provided, the default value is an empty string.
*/
export const VERIFIER_AGENT_API_KEY = __ENV.VERIFIER_AGENT_API_KEY || "";
export const VERIFIER_AGENT_API_KEY = __ENV.VERIFIER_AGENT_API_KEY || "default";
323 changes: 182 additions & 141 deletions tests/performance-tests/atala-performance-tests-k6/src/common/CredentialsService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { sleep } from "k6";
import { HttpService } from "./HttpService";
import { ISSUER_AGENT_URL, WAITING_LOOP_MAX_ITERATIONS, WAITING_LOOP_PAUSE_INTERVAL } from "./Config";
import { IssueCredentialRecord, Connection, CredentialSchemaResponse } from "@input-output-hk/prism-typescript-client";
import { crypto } from "k6/experimental/webcrypto";
import {sleep} from "k6";
import {HttpService} from "./HttpService";
import {ISSUER_AGENT_URL, WAITING_LOOP_MAX_ITERATIONS, WAITING_LOOP_PAUSE_INTERVAL} from "./Config";
import {IssueCredentialRecord, Connection, CredentialSchemaResponse} from "@input-output-hk/prism-typescript-client";
import {crypto} from "k6/experimental/webcrypto";


/**
Expand All @@ -11,14 +11,14 @@ import { crypto } from "k6/experimental/webcrypto";
*/
export class CredentialsService extends HttpService {

/**
* Creates a credential offer for a specific issuing DID and connection.
* @param {string} issuingDid - The issuing DID.
* @param {Connection} connection - The connection object.
* @returns {IssueCredentialRecord} The created credential offer record.
*/
createCredentialOffer(issuingDid: string, connection: Connection, schema: CredentialSchemaResponse): IssueCredentialRecord {
const payload = `{
/**
* Creates a credential offer for a specific issuing DID and connection.
* @param {string} issuingDid - The issuing DID.
* @param {Connection} connection - The connection object.
* @returns {IssueCredentialRecord} The created credential offer record.
*/
createCredentialOffer(issuingDid: string, connection: Connection, schema: CredentialSchemaResponse): IssueCredentialRecord {
const payload = `{
"claims": {
"emailAddress": "${crypto.randomUUID()}[email protected]",
"familyName": "Test",
Expand All @@ -31,145 +31,186 @@ export class CredentialsService extends HttpService {
"connectionId": "${connection.connectionId}",
"automaticIssuance": false
}`;
const res = this.post("issue-credentials/credential-offers", payload);
return this.toJson(res) as unknown as IssueCredentialRecord;
}
const res = this.post("issue-credentials/credential-offers", payload);
return this.toJson(res) as unknown as IssueCredentialRecord;
}

createCredentialSchema(issuingDid: string): CredentialSchemaResponse {
const payload = `
createCredentialDefinition(issuingDid: string, schema: CredentialSchemaResponse) {
const payload = `
{
"name": "${crypto.randomUUID()}}",
"description": "Birth certificate Anoncred Credential Definition",
"version": "1.0.0",
"description": "Simple credential schema for the driving licence verifiable credential.",
"type": "https://w3c-ccg.github.io/vc-json-schemas/schema/2.0/schema.json",
"schema": {
"$id": "https://example.com/driving-license-1.0",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Driving License",
"type": "object",
"properties": {
"emailAddress": {
"type": "string",
"format": "email"
},
"givenName": {
"type": "string"
},
"familyName": {
"type": "string"
},
"dateOfIssuance": {
"type": "string"
},
"drivingLicenseID": {
"type": "string"
},
"drivingClass": {
"type": "integer"
}
},
"required": [
"emailAddress",
"familyName",
"dateOfIssuance",
"drivingLicenseID",
"drivingClass"
],
"additionalProperties": false
},
"tags": [
"driving",
"licence",
"id"
],
"author": "${issuingDid}"
"tag": "Licence",
"author": "${issuingDid}",
"schemaId": "${ISSUER_AGENT_URL.replace("localhost", "host.docker.internal")}/schema-registry/schemas/${schema.guid}",
"signatureType": "CL",
"supportRevocation": false
}
`;
this.post("credential-definition-registry/definitions", payload);
}

createCredentialSchema(issuingDid: string, schemaType: string = "json") {
const payload = (function () {
switch (schemaType) {
case "json":
return `{
"name": "${crypto.randomUUID()}}",
"version": "1.0.0",
"description": "Simple credential schema for the driving licence verifiable credential.",
"type": "https://w3c-ccg.github.io/vc-json-schemas/schema/2.0/schema.json",
"schema": {
"$id": "https://example.com/driving-license-1.0",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Driving License",
"type": "object",
"properties": {
"emailAddress": {
"type": "string",
"format": "email"
},
"givenName": {
"type": "string"
},
"familyName": {
"type": "string"
},
"dateOfIssuance": {
"type": "string"
},
"drivingLicenseID": {
"type": "string"
},
"drivingClass": {
"type": "integer"
}
},
"required": [
"emailAddress",
"familyName",
"dateOfIssuance",
"drivingLicenseID",
"drivingClass"
],
"additionalProperties": false
},
"tags": [
"driving",
"licence",
"id"
],
"author": "${issuingDid}"
}`;
case "anoncred":
return `{
"name": "${crypto.randomUUID()}",
"version": "1.0.0",
"description": "Simple credential schema for the driving licence verifiable credential.",
"type": "AnoncredSchemaV1",
"schema": {
"name": "${crypto.randomUUID()}",
"version": "1.0.0",
"attrNames": [
"emailAddress",
"familyName"
],
"issuerId": "${issuingDid}"
},
"author": "${issuingDid}",
"tags": [
"Licence"
]
}`;
default:
throw new Error(`Schema type ${schemaType} is not supported`);
}
})();
const res = this.post("schema-registry/schemas", payload);
return this.toJson(res) as unknown as CredentialSchemaResponse;
}
`
const res = this.post("schema-registry/schemas", payload);
return this.toJson(res) as unknown as CredentialSchemaResponse;
}

/**
* Retrieves a specific credential record by ID.
* @param {IssueCredentialRecord} record - The credential record.
* @returns {IssueCredentialRecord} The credential record.
*/
getCredentialRecord(record: IssueCredentialRecord): IssueCredentialRecord {
const res = this.get(`issue-credentials/records/${record.recordId}`);
return this.toJson(res) as unknown as IssueCredentialRecord;
}
/**
* Retrieves a specific credential record by ID.
* @param {IssueCredentialRecord} record - The credential record.
* @returns {IssueCredentialRecord} The credential record.
*/
getCredentialRecord(record: IssueCredentialRecord): IssueCredentialRecord {
const res = this.get(`issue-credentials/records/${record.recordId}`);
return this.toJson(res) as unknown as IssueCredentialRecord;
}

/**
* Retrieves all credential records.
* @returns {IssueCredentialRecord[]} An array of credential records.
*/
getCredentialRecords(thid: string): IssueCredentialRecord[] {
const res = this.get(`issue-credentials/records?thid=${thid}`);
return this.toJson(res).contents as unknown as IssueCredentialRecord[];
}
/**
* Retrieves all credential records.
* @returns {IssueCredentialRecord[]} An array of credential records.
*/
getCredentialRecords(thid: string): IssueCredentialRecord[] {
const res = this.get(`issue-credentials/records?thid=${thid}`);
return this.toJson(res).contents as unknown as IssueCredentialRecord[];
}

/**
* Accepts a credential offer and associates it with a subject DID.
* @param {IssueCredentialRecord} record - The credential record.
* @param {string} subjectDid - The subject DID.
* @returns {IssueCredentialRecord} The updated credential record.
*/
acceptCredentialOffer(record: IssueCredentialRecord, subjectDid: string): IssueCredentialRecord {
const payload = { subjectId: subjectDid };
const res = this.post(`issue-credentials/records/${record.recordId}/accept-offer`, payload, 200);
return this.toJson(res) as unknown as IssueCredentialRecord;
}
/**
* Accepts a credential offer and associates it with a subject DID.
* @param {IssueCredentialRecord} record - The credential record.
* @param {string} subjectDid - The subject DID.
* @returns {IssueCredentialRecord} The updated credential record.
*/
acceptCredentialOffer(record: IssueCredentialRecord, subjectDid: string): IssueCredentialRecord {
const payload = {subjectId: subjectDid};
const res = this.post(`issue-credentials/records/${record.recordId}/accept-offer`, payload, 200);
return this.toJson(res) as unknown as IssueCredentialRecord;
}

/**
* Issues a credential for a specific credential record.
* @param {IssueCredentialRecord} record - The credential record.
* @returns {IssueCredentialRecord} The updated credential record.
*/
issueCredential(record: IssueCredentialRecord): IssueCredentialRecord {
const res = this.post(`issue-credentials/records/${record.recordId}/issue-credential`, null, 200);
return this.toJson(res) as unknown as IssueCredentialRecord;
}
/**
* Issues a credential for a specific credential record.
* @param {IssueCredentialRecord} record - The credential record.
* @returns {IssueCredentialRecord} The updated credential record.
*/
issueCredential(record: IssueCredentialRecord): IssueCredentialRecord {
const res = this.post(`issue-credentials/records/${record.recordId}/issue-credential`, null, 200);
return this.toJson(res) as unknown as IssueCredentialRecord;
}

/**
* Waits for a credential offer to be received.
* @returns {IssueCredentialRecord} The received credential offer record.
* @throws {Error} If the credential offer is not received within the maximum iterations.
*/
waitForCredentialOffer(thid: string): IssueCredentialRecord {
let iterations = 0;
let record: IssueCredentialRecord | undefined;
do {
// console.log(`Waiting for credential offer with thid=${thid}`)
record = this.getCredentialRecords(thid).find(
r => r.thid === thid && r.protocolState === "OfferReceived"
);
if (record) {
return record;
}
sleep(WAITING_LOOP_PAUSE_INTERVAL);
iterations++;
} while (iterations < WAITING_LOOP_MAX_ITERATIONS);
throw new Error(`Record with thid=${thid} not achieved during the waiting loop`);
}
/**
* Waits for a credential offer to be received.
* @returns {IssueCredentialRecord} The received credential offer record.
* @throws {Error} If the credential offer is not received within the maximum iterations.
*/
waitForCredentialOffer(thid: string): IssueCredentialRecord {
let iterations = 0;
let record: IssueCredentialRecord | undefined;
do {
// console.log(`Waiting for credential offer with thid=${thid}`)
record = this.getCredentialRecords(thid).find(
r => r.thid === thid && r.protocolState === "OfferReceived"
);
if (record) {
return record;
}
sleep(WAITING_LOOP_PAUSE_INTERVAL);
iterations++;
} while (iterations < WAITING_LOOP_MAX_ITERATIONS);
throw new Error(`Record with thid=${thid} not achieved during the waiting loop`);
}

/**
* Waits for a credential to reach a specific state.
* @param {IssueCredentialRecord} credentialRecord - The credential record.
* @param {string} state - The required state.
* @throws {Error} If the credential state does not reach the required state within the maximum iterations.
*/
waitForCredentialState(credentialRecord: IssueCredentialRecord, state: string) {
let iterations = 0;
let currentState;
do {
const response = this.getCredentialRecord(credentialRecord);
currentState = response.protocolState;
sleep(WAITING_LOOP_PAUSE_INTERVAL);
iterations++;
} while (currentState !== state && iterations < WAITING_LOOP_MAX_ITERATIONS);
if (currentState !== state) {
throw new Error(`Credential is not ${state} after the waiting loop`);
/**
* Waits for a credential to reach a specific state.
* @param {IssueCredentialRecord} credentialRecord - The credential record.
* @param {string} state - The required state.
* @throws {Error} If the credential state does not reach the required state within the maximum iterations.
*/
waitForCredentialState(credentialRecord: IssueCredentialRecord, state: string) {
let iterations = 0;
let currentState;
do {
const response = this.getCredentialRecord(credentialRecord);
currentState = response.protocolState;
sleep(WAITING_LOOP_PAUSE_INTERVAL);
iterations++;
} while (currentState !== state && iterations < WAITING_LOOP_MAX_ITERATIONS);
if (currentState !== state) {
throw new Error(`Credential is not ${state} after the waiting loop`);
}
}
}

}
Loading
Loading