isaitb/asic-validator repository overview

⁠Introduction

A web application implementing the GITB validation service API⁠ to allow GITB TDL test cases⁠ to validate ASiC containers⁠. This service is meant to be used as the service handler⁠ for GITB TDL verify⁠ steps.

This image is maintained by the European Commission's DIGIT and specifically the Interoperability Test Bed, a conformance testing service for projects involved in the delivery of cross-border public services. Find out more here⁠.

⁠Capabilities

This component allows the validation of an ASiC container considering an optional profile. The supported profiles are:

• base: The base ASiC container definition (considered as the default).
• etendering: The rules relevant to the PEPPOL Business Interoperability Specifications (BIS)⁠.

⁠Configuration and deployment

To deploy this service the simplest approach is to use it via Docker Compose⁠. The following is a sample docker-compose.yml file to use for its deployment that represents the minimum configuration needed:

version: '2'

services:
   asic-validator:
      image: isaitb/asic-validator:latest
      restart: unless-stopped
      ports:
       - "8080:8080"

Regarding the configuration of the service, the key points to take into account are the following:

• The internal port on which the service is listening on is 8080. This needs to be mapped to your host or accessed directly if within the same Docker network.
• The web application context used by the service is /asic.

In addition, is it interesting to note that the service is implemented using Spring Boot⁠ and as such any standard Spring Boot configuration properties⁠ can also be similarly set via environment variables. Properties you may consider to override are relevant to logging, the server.servlet.context-path (set by default to /asic) and the server.port (set by default to 8080).

Once your docker-compose.yml file has been prepared to match your environment you may start the service using docker compose up -d. Assuming a deployment using the default configuration on your localhost's port 8080, the service will be available at http://localhost:8080/asic/api/validation. This means that when used in the Test Bed as a messaging handler (which requires the WSDL address), this would be provided as http://localhost:8080/asic/api/validation?wsdl.

⁠Use within GITB TDL test cases

The following code sample illustrates how to use the service from GITB TDL test cases.

<steps>
   <verify id="asicValidation" desc="Validate ASiC container" handler="http://localhost:8080/asic/api/validation?wsdl">
      <!-- The binary container to validate -->
      <input name="file">$container</name>
      <!-- An optional profile to apply. -->
      <input name="profile">"base"</name>
   </verify>
</steps>

⁠Licence

This tool is shared using the European Union Public Licence (EUPL) version 1.2⁠.

⁠Legal notice

The authors of this tool waive any and all liability linked to its usage. In terms of data, the tool does not harvest, collect or process in any way data nor does it maintain any state based on its received inputs.

⁠Contact

To get in touch for feedback or questions please send an email to [email protected]⁠.