From a60bf6e7fa42cc4348bc26fab6b40f73da201c93 Mon Sep 17 00:00:00 2001 From: Ashley Harwood <60303491+ashleythedeveloper@users.noreply.github.com> Date: Wed, 14 Aug 2024 20:09:07 +1000 Subject: [PATCH] docs: add storage service test docs (#98) --- .../getting-started.md | 4 ++ .../storage/testing.md | 38 +++++++++++++++++-- 2 files changed, 39 insertions(+), 3 deletions(-) diff --git a/documentation/docs/test-suites/technical-interoperability/getting-started.md b/documentation/docs/test-suites/technical-interoperability/getting-started.md index d878185b..d68b2c31 100644 --- a/documentation/docs/test-suites/technical-interoperability/getting-started.md +++ b/documentation/docs/test-suites/technical-interoperability/getting-started.md @@ -19,6 +19,8 @@ The Getting Started section covers the following topics for technical interopera - Setting up storage service testing - Configuring transparency graph validation tests + **Note**: The preset configuration in the config file (`packages/vc-test-suite/config.ts`) has already been preconfigured to use the services set up with Docker Compose. If you're using the default Docker setup, you may not need to modify these settings. + 3. **Usage**: Learn how to run the various components of the technical interoperability test suite and interpret the results. This section will guide you through: - Running the W3C V2 VCDM tests - Executing UNTP extension tests @@ -27,3 +29,5 @@ The Getting Started section covers the following topics for technical interopera - Validating transparency graphs By the end of this section, you will have a solid foundation for installing, configuring, and using the UNTP Technical Interoperability Test Suite. You'll be able to validate your UNTP implementation's technical components against the required standards. + +If you're using the default Docker setup, most of the configuration has been done for you. However, if you need to customise any settings or are using a different setup, the configuration section of each component will guide you through the necessary steps. \ No newline at end of file diff --git a/documentation/docs/test-suites/technical-interoperability/storage/testing.md b/documentation/docs/test-suites/technical-interoperability/storage/testing.md index 3363f28a..f0397a28 100644 --- a/documentation/docs/test-suites/technical-interoperability/storage/testing.md +++ b/documentation/docs/test-suites/technical-interoperability/storage/testing.md @@ -7,8 +7,40 @@ import Disclaimer from '../../../\_disclaimer.mdx'; -The Storage component testing suite focuses on verifying the security and accessibility of stored credentials and related data. +The Storage component is a critical part of the UNTP ecosystem, responsible for [securely storing and retrieving credentials and related data](https://uncefact.github.io/spec-untp/docs/specification/DecentralisedAccessControl). This test suite verifies the functionality, security, and accessibility of your storage implementation. -Detailed testing procedures and instructions for running the test suite will be provided in future updates. These tests will ensure that your Storage implementation meets the necessary standards for the UNTP ecosystem. +## Testing Instructions -Please check back later for specific testing instructions and requirements. +To test your Storage implementation, follow these steps: + +1. **Update the Configuration**: + + - Navigate to the config file: `packages/vc-test-suite/config.ts` + - Update the `Storage` section with your implementation details. The file should look similar to this: + + ```typescript + export default { + implementationName: 'UNTP ACME', + testSuites: { + Storage: { + url: 'http://localhost:3334/v1/documents', + encryptionUrl: 'http://localhost:3334/v1/credentials', + headers: {}, + additionalParams: {}, + additionalPayload: { bucket: 'verifiable-credentials' }, + }, + }, + }; + ``` + + Adjust the `url`, `encryptionUrl`, `headers`, `additionalParams`, and `additionalPayload` as necessary for your implementation. + +2. **Run the Test**: + + - Navigate to `packages/vc-test-suite` + - In your terminal, run the command: `yarn test` + +3. **View Test Results**: + - Navigate to `packages/vc-test-suite/reports/index.html` + - Open this file in a web browser + - Look for the "Storage Service" section to view your test results \ No newline at end of file