Skip to content

Add run in docker instructions #102

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.

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
node_modules/
docker/implemenation.yml
33 changes: 33 additions & 0 deletions docker/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<!--
Copyright 2025 Digital Bazaar, Inc.

SPDX-License-Identifier: BSD-3-Clause
-->

# Testing in docker

To run your implementation against all test suites from one location, you can use this docker-compose project.

## Pre requisites
- [Docker](https://docs.docker.com/compose/install/)

## Setup

Make sure you are in the `docker` directory, then copy the `implementation` example file:
```bash
cd ./docker
cp implementation.example.yml implementation.yml
```
Edit the local config details to match your implementation.

Once you are done, you can run the test-suites with:
```bash
docker compose up --build
```

When the tests are completed, you will be able to access the reports in your browser:
- [vc-data-model-v2](http://vc-data-model.docker.localhost/)
- [vc-bitstring-status-list](http://vc-bitstring-status-list.docker.localhost/)
- [vc-di-eddsa](http://vc-di-eddsa.docker.localhost/)
- [vc-di-ecdsa](http://vc-di-ecdsa.docker.localhost/)
- [vc-di-bbs](http://vc-di-bbs.docker.localhost/)
47 changes: 47 additions & 0 deletions docker/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
include:
- implementation.yml
services:
vc-data-model-v2:
build: https://github.com/w3c/vc-data-model-2.0-test-suite.git#allure-in-docker
command:
- /bin/bash
- -c
- |
npm t
serve -p 8000 reports/
configs:
- source: localConfig.cjs
target: /test-suite/localConfig.cjs
- source: implementation.json
target: /test-suite/implementation.json
labels:
- traefik.enable=true
- traefik.http.routers.vc-data-model.rule=Host(`vc-data-model.docker.localhost`)
- traefik.http.routers.vc-data-model.entrypoints=web
- traefik.http.services.vc-data-model.loadbalancer.server.port=8000

traefik:
image: traefik:v3.1
command:
- --api.insecure=true
- --providers.docker=true
- --providers.docker.exposedbydefault=false
- --entryPoints.web.address=:80
ports:
- 80:80
volumes:
- /var/run/docker.sock:/var/run/docker.sock:ro


configs:
localConfig.cjs:
content: |
module.exports = {
settings: {
enableInteropTests: true
},
implementations: [
require('/test-suite/implementation.json')
]
};
38 changes: 38 additions & 0 deletions docker/implementation.example.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
configs:
implementation.json:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given how you're doing the localConfig.cjs above, is this file still needed?

Guess I'm getting lost among all the nesting dolls...

content: |
{
"name": "My Company",
"implementation": "My Implementation Name",
"issuers": [
{
"id": "",
"endpoint": "",
"options": {},
"tags": [
"vc2.0"
]
}
],
"verifiers": [
{
"id": "",
"endpoint": "",
"options": {},
"tags": [
"vc2.0"
]
}
],
"vpVerifiers": [
{
"id": "",
"endpoint": "",
"options": {},
"tags": [
"vc2.0"
]
}
]
}