Global ebusiness Interoperability Test Beds (GITB) Test Registry and Repository User Guide

Transcription

1 Global ebusiness Interoperability Test Beds (GITB) Test Registry and Repository User Guide CEN Workshop GITB Phase 3 October 2015

2 Global ebusiness Interoperability Test Beds (GITB) 2 Table of Contents Table of Contents... 2 Table of Figures... 3 Revision History Introduction Purpose About GITB and the TRR About Joinup References User Guide Definitions and concepts Creating a Test Resource Searching for a Test Resource Updating and Deleting a Test Resource Subscribing to a Test Resource changes Highlighting a Test Resource in a project FAQ How to add a ebusiness specification or standard so I can reference it within my Test Resource How to structure the URI field? How to manage file versions of a Test Resource and its distributions?... 20

3 Global ebusiness Interoperability Test Beds (GITB) 3 Table of Figures Figure 1: Catalogue architecture of Joinup... 7 Figure 2: Main page of the GITB TRR... 7 Figure 3: Data schema of the Test Resource... 9 Figure 4: Extract of the data model of Test Resource Figure 5: Organizing Test Resources so they can be reused Figure 6: Adding a Test Resource to the TRR (1) Figure 7: Adding a Test Resource to the TRR (2) Figure 8: The creation form of a Test Resource Figure 9: Link Explore this repository Figure 10: Search page of Joinup Figure 11: Editing a Test Resource Figure 12: Saving an edited Test Resource Figure 13: Subscribing to a Test Resource Figure 14: Files organization in Joinup...20 Figure 15: Distribution field Figure 16: Distribution's creation form... 21

4 Global ebusiness Interoperability Test Beds (GITB) 4 Revision History Name Date Reason For Changes Version Roch Bertucat 21/10/2015 Initial release 0.1

5 Global ebusiness Interoperability Test Beds (GITB) 5 1 Introduction 1.1 Purpose The Test Registry and Repository (TRR) is a component of the GITB infrastructure. The TRR is aimed at supporting the GITB infrastructure for managing, archiving and sharing distributed Testing Resources. This document purpose is to describe how to use the GITB TRR in Joinup. 1.2 About GITB and the TRR The GITB vision is to establish a shared and Global ebusiness Interoperability Test Bed (GITB) infrastructure to support conformance and interoperability testing of ebusiness Specifications and their implementation by software vendors and end-users. The GITB project aims at: developing the required global Testing Framework, architecture and methodologies for state-of-the-art ebusiness Specifications and profiles covering all layers of the interoperability stack (business processes, business documents, transport and communication); supporting the realization of GITB as a network of multiple Test Beds, thereby leveraging existing and future testing capabilities from different stakeholders (for example standards development organizations and industry consortia, Test Bed Providers, and accreditation / certification authorities); establishing under EU support and guidance, a setup of a comprehensive and global ebusiness interoperability Test Bed infrastructure in a global collaboration of European, North American and Asian partners. In the GITB infrastructure, the Test Registry and Repository (TRR) is aimed at supporting the Test Bed for managing, archiving and sharing distributed Testing Resources. The need for a TRR is justified because: Test artefacts are everywhere, in different systems, so there is no federated (one-stop-shop) place for users to find Test artefacts and references to existing Test Beds, Test Beds needs a system to store relevant Test artefacts. 1.3 About Joinup Joinup is a collaborative platform created by the European Commission with the following capabilities: Sharing of information like news, case studies and events about a project, Cataloguing interoperability solutions software and searching on the catalogue. Joinup is open source and uses the Asset Description Metadata Schema 1 for content description. The main reasons of using Joinup to host the GITB TRR are: existing features of Joinup covers the GITB TRR required features, sustainability of the GITB TRR is assured after the GITB project ends, the mission of the ISA, the organization behind Joinup, is aligned with the mission of the TRR, Joinup is released as an open source project which is actively maintained. 1

6 Global ebusiness Interoperability Test Beds (GITB) 6 In the document, it is assumed that the user is familiar with the basic concepts of Joinup. If not, it is recommended to consult the Help page on the Joinup website: References CWA 16093:2010 Feasibility Study for a Global ebusiness Interoperability Test Bed (GITB) CWA 16408:2012 Testing Framework for Global ebusiness Interoperability Test Beds (GITB) CEN WS GITB3 document to be released at the end of 2015 Joinup Help on

7 Global ebusiness Interoperability Test Beds (GITB) 7 2 User Guide 2.1 Definitions and concepts Container In the catalogue architecture of Joinup, a container is the highest level. It can be a community, a project, a news entry or a federated repository, as shown on Figure 1. Figure 1: Catalogue architecture of Joinup The TRR is a federated repository and is at: Figure 2: Main page of the GITB TRR

8 Global ebusiness Interoperability Test Beds (GITB) Test Resource In Joinup, a Test Resource is a specific Interoperability Solution. The TRR contains Test Resources that are: Actual Test artefacts References to Test artefacts contained in other systems (for example in instances of Test Bed, or in instances of other TRR) References to Test Beds and Test Tools The table below lists the types of Test Resource that can be created in the TRR. Type of Test Resource Short description Test Case an executable unit of verification and/or of interaction with an SUT, corresponding to a particular testing requirement, as identified in an ebusiness Specification Test Suite defines a workflow of Test Case executions and/or Document Validator executions Test Assertion a testable or measurable expression - usually in plain text or with a semi-formal representation - for evaluating the adherence of an implementation (or part of it) to a normative statement in a specification Document Assertion Set a package of artefacts used to validate a Business Document, typically including one or more of the following: a schema (XML), consistency rules, codelists, etc. These artefacts are generally machineprocessable Messaging Adapter specialized for messaging protocol stacks such as ebxml Messaging, Web Services with SOAP or REST, AS2, and the underlying transports: SMTP, HTTP, etc. Document Validator responsible for validating the content of the documents retrieved from the Messaging Adapters in terms of both structure and semantic such as EDI: ANSI, EDIFACT, XML Test Bed consists of a test execution environment for Test Suites and the functionalities required for conformance and/or interoperability testing A Test Resource is described through a set of fields, which are listed in the next section.

9 Global ebusiness Interoperability Test Beds (GITB) Test Resource's fields details Most of the Test Resource's fields are inherited fields of Interoperability Solution. There precise definition is summarized in the document called "ADMS Application Profile for Joinup" 2. The fields that are specific of Test Resources are derived from the "ADMS Application Profile for TRR" 3. The Figure 3 gives an overview of the fields' name of the Test Resource. Figure 3: Data schema of the Test Resource Field Name Description URI An URI is an unique identifier. The only requirement is that the URI shall be unique in the Joinup platform. See 3.2 for further details. Name CEN WS GITB3 document to be released at the end of 2015

10 Global ebusiness Interoperability Test Beds (GITB) 10 A name given to the Test Resource. Description A description of the Test Resource. As Test Resources go through Joinup moderation, it is recommended to provide a description focusing on the following points: General description: overview, golden paragraph of your solution? Needs that the solution addresses: what needs does your solution address? Features that the solution implements: what are the main features that your solution addresses. In other words, how does your solution address the needs? Typical intended audience: what is the target audience(s) of your solutions. Who are the end users? How to reuse the solution: how can the intended audience re-use your solutions? What are the steps to follow? How to begin? Is there any other solutions strongly related and that can be used together? Standards used in the solution (if any): what international, national standard or specification are used within your solution? Contribution of the solution to a policy (if any): does your solution contribute, is endorsed, or was developed in the context of a public policy? Source: Test resource type Allows the user to categorize the Test Resource selecting one of the following values: Test Bed, Test Suite, Test Case, Document Assertion Set, Messaging Adapter, Document Validator, Test Assertion. See for details. Actor A comma-separated list of actors or business process roles associated to the Test Resource. This is specific to a particular standard / ebusiness specification. Example for HL7: PatientIdentitySource, PatientDemographicConsumer. It is an evolving text based on a vocabulary, i.e. once an user enters a text that was not previously in the vocabulary, it is added to the vocabulary and becomes available for other users.

11 Global ebusiness Interoperability Test Beds (GITB) 11 Business process The type of process providing a way to unambiguously identify the business activity to which the Test Resource is associated. Based on the existing taxonomy available on Publisher An organization responsible for making the Test Resource available. The field is a Text field with suggestions, that are the set of Publisher available in Joinup. A new publisher can be added to Joinup and referenced here if needed. Compatible with the GITB reference implementati on Test Bed? Used to specify if the Test Resource works with the GITB Test Bed reference implementation. Check that box only if the Test Resource is built following the GITB Test Description Language (TDL) and can be processed by the Test Bed reference implementation. Can be used as a search criteria as the keyword GITBReferenceImplementationCompliant. Is Generic? Used to make the distinction between Test Resources that are domain specific and the ones that are domain agnostic, e.g. a generic Test suite for the messaging protocol AS2. If clicked, the user cannot input the standard/ebusiness specification field (below). Can be used as a search criteria as the keyword generictestresource. Standard / ebusiness Specification The type of specification the Test Bed or the Test Resource refers to. Ex: HL7, WS-I-BP2.0, Autogration, MOSS, eprior, esens, PEPPOL v2, etc. The field is a Text field with suggestions, it shall point to an existing Interoperability Solution of type Framework available in Joinup. A new Interoperability Solution of type Framework can be added to Joinup and referenced here if needed.

12 Global ebusiness Interoperability Test Beds (GITB) 12 Translation Allows the user to specify translations of the name and the description of the Test Resource. Version management Allows the user to specify information about the version of the Test Resource in various language. Release Language The language of the Test Resource if it contains textual information, e.g. the language of the terms in a controlled vocabulary or the language in which a specification is written. Distribution Set of physical embodiments or representations of the Test Resource. A Distribution is typically a downloadable computer file that implements the intellectual content of the Test Resource. e.g. for a specific Test Resource, a PDF documentation, a XML file describing a Test Case, a README file are Distributions. This field shall point to an existing Distribution available in Joinup. A new Distribution can be added to Joinup and referenced here if needed. Contact point

13 Global ebusiness Interoperability Test Beds (GITB) 13 A contact point for further information about the Test Resource. This field shall point to an existing Contact point available in Joinup. A new Contact point can be added to Joinup and referenced here if needed. Reference to another test resource A set of relationships between Test Resource. Versioning between Test Resources is supported through the 2 relationship type: Next Version and Previous Version. Included Asset can be used to specify for example that: a TestSuite is composed by a set of TestCase and DocumentAssertionSet, a TestCase is composed by a set of DocumentAssertionSet, a TestCase uses a MessagingAdapter or/and a DocumentValidator. Related Asset can be used to specify for example that: a TestBed references some Test Resources like TestCase or DocumentValidator, etc. Related web page A web page that can be navigated to in a Web browser to gain access to the Test Resource, its distributions and/or additional information. Can be used to reference a Test Resource that is stored in a remote repository, when the Joinup TRR is used as a registry only. This field shall point to an existing Documentation available in Joinup. A new Documentation can be added to Joinup and referenced here if needed.

14 Global ebusiness Interoperability Test Beds (GITB) 14 Main documentatio n Links to documentation that contains information related to the Test Resource. This field shall point to an existing Documentation available in Joinup. A new Documentation can be added to Joinup and referenced here if needed. Geographic coverage The geographic region to which the Test Resource applies. Status The status of the Test Resource in the context of a particular workflow process. Completed, Under development, Deprecated, Withdrawn 2.2 Creating a Test Resource Recommendation To assure quality and reusability of the Test Resources, it is recommended to break down Test Resources as much as possible by using the Reference to another Test Resource field. For example, a Test Suite shouldn't have a distribution in which its document assertions and its test cases are enclosed in an unique archive. Instead, a Test Suite should link to Test Resources of type Document Assertion Set, and to Test Resources of type Test Case and each of these Test Resources should have their own distribution. It is advised to use the field Reference to another Test Resource, as shown on the Figure 4 to describe the complete structure of the Test Resource. More details about that field Reference to another test resource are given in section

15 Global ebusiness Interoperability Test Beds (GITB) 15 Figure 4: Extract of the data model of Test Resource Figure 5: Organizing Test Resources so they can be reused Figure 5 shows how a DocumentAssertionSet called MyDocumentAssertionSet1 can be referenced by two separate Test Resources, something that wouldn't be possible if the DocumentAssertionSet were packaged directly under an archive linked to the MyTestSuite Test Resource Creation process The user shall be in the GITB TRR repository page for creating Test Resource. It then clicks on Add... and Interoperability Solution, as shown on Figure 6. Figure 6: Adding a Test Resource to the TRR (1) The user then clicks on Continue on the modal form that is displayed on Figure 7.

16 Global ebusiness Interoperability Test Beds (GITB) 16 The creation form appears, as shown on Figure 8. Figure 7: Adding a Test Resource to the TRR (2) Figure 8: The creation form of a Test Resource 2.3 Searching for a Test Resource The easiest way to start searching the TRR is to click on the link Explore this repository on the main page of the TRR, as shown on Figure 9.

17 Global ebusiness Interoperability Test Beds (GITB) 17 Figure 9: Link Explore this repository It is then possible to enter some keywords in the text field to filter the search. It is also possible to filter the existing results using some of the Test Resource fields' values displayed on the left panel of the page, as shown on Figure 10. Useful filters Figure 10: Search page of Joinup Filter Filter by Test Resource type Filter by Business process Filter by domain agnostic Note On the left panel, use the filter called "Filter by Solution Type" to filter the results on the field "Test resource type" On the left panel, use the filter called "Filter by Themes" to filter the results on the field "Business process" In the text field, enter "generictestresource" to show Test Resources that have the "is

18 Global ebusiness Interoperability Test Beds (GITB) 18 Test Resource Filter by Test Resources that work with the GITB Test Bed reference implementation Generic?" field set to true. In the text field, enter "GITBReferenceImplementationCompliant" to show Test Resources that have the "Will it work with the GITB reference implementation? " field set to true. 2.4 Updating and Deleting a Test Resource A Test Resource can be updated by clicking the Edit link on a specific Test Resource, as shown on Figure 11. Figure 11: Editing a Test Resource Once changes have been made, the Test Resource can be saved clicking on the Save button at the bottom of the page, as shown on Figure 12. Figure 12: Saving an edited Test Resource The Test Resource can be deleted by clicking on the Request deletion button at the bottom of the edit page, as shown on Figure 12.

19 Global ebusiness Interoperability Test Beds (GITB) Subscribing to a Test Resource changes By default, the user that creates a Test Resource or a distribution will be subscribed automatically and will get notifications about it when it gets updated and when someone comments on it. Other users can subscribe to a Test Resource and its distributions to get notifications about it on updates and on comments by following the steps below on the page of a Test Resource and on the page of a distribution: 1. Click on the Actions dropdown button 2. Click on the Subscribe link 3. Select the subscriptions options by filling out the form, as shown on Figure Click on Save Figure 13: Subscribing to a Test Resource 2.6 Highlighting a Test Resource in a project To give visibility to a Test Resource on another page in Joinup, it is possible to reference it directly within a project or a community by following the steps below on the page of a Test Resource: 1. Click on the Actions dropdown button 2. Click on the Highlight this Interoperability Solution link 3. Select the communities and projects where to highlight the Test Resource

20 Global ebusiness Interoperability Test Beds (GITB) 20 3 FAQ 3.1 How to add a ebusiness specification or standard so I can reference it within my Test Resource Please follow the Joinup guidelines when adding new content to Joinup: How to structure the URI field? There is currently no way to generate the URI field automatically. An URI is an unique identifier. The only requirement is that the URI shall be unique in the Joinup platform. The URI can be deferenceable 4 or not. To structure the URI, it is suggested to follow the steps below: if your Test Resource is described already on another website, just put the URL of the page, if not, you can use for example: or simply uri:testresource/identifier_of_the_test_resource 3.3 How to manage file versions of a Test Resource and its distributions? Figure 14: Files organization in Joinup As described previously, the GITB TRR is a federated repository in Joinup, which is a specific container that contains Test Resources, that are specific Interoperability Solutions. On the Test Resource creation form, we can either register a distribution or select an existing one. 4 A dereferenceable URI is a resource retrieval mechanism that uses any of the internet protocols (e.g. HTTP) to obtain a copy or representation of the resource it identifies. Source:

21 Global ebusiness Interoperability Test Beds (GITB) 21 Figure 15: Distribution field Figure 16: Distribution's creation form Once the distribution has been associated with the Test Resource and the Test Resource has been created, the details of the Test Resource is shown. Let's assume that an existing Test Resource T1 is associated to a distribution D1 in the TRR. To specify that a Test Resource T2 is the next version of T1: 1. Create a new Test Resource T2 2. In its creation form, create a new distribution D2 and associate it to T2 3. In its creation form, specify that T2 is a Next Version of T1