Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 5.27 KB

README.md

File metadata and controls

70 lines (48 loc) · 5.27 KB

Integration tests

The integration tests contain more test scenarios:

  • resource CRUD related scenarios;
  • authentication & authorization scenarios;
  • application metadata request scenarios.

All scenarios are detailed in the Integration test scenarios Turtle file.

These scenarios can be run against different Solid servers.

Running the integration tests locally

The default setup (which comes with the project) uses an internal Mock Solid Server. One can simply run the tests locally, and they will run on the internal Mock Solid Server. The tests need some dummy values for:

  • the owner client-id
  • the owner client-secret
  • the requester.client-id used in Access Grants scenarios
  • and the requester.client-secret

They can be found in the ./base/src/main/resources/META-INF/microprofile-config.properties file. Navigate to one of the concrete openid or uma tests found in this module and hit run.

Note: the application metadata request scenarios are not setup to run on the Mock Solid Server.

Running the tests on a live Solid server

To set up a server, you needs to add more configurations to the ./base/src/main/resources/META-INF/microprofile-config.properties file.

Let's take a look at the possible configuration values in the properties file. All the possible value are listed next:

  • inrupt.test.client-id // mandatory
  • inrupt.test.client-secret // mandatory
  • inrupt.test.auth-method // default is client_secret_basic
  • inrupt.test.webid
  • inrupt.test.access-grant.provider
  • inrupt.test.requester.webid
  • inrupt.test.requester.client-id // mandatory for running the AccessGrant scenarios
  • inrupt.test.requester.client-secret // mandatory for running the AccessGrant scenarios
  • inrupt.test.feature.request-metadata
  • inrupt.test.request-metadata-headers-that-propagate

Mandatory fields are:

  • inrupt.test.client-id & inrupt.test.client-secret are used to signal the server that this is a registered client acting as the owner of resources.
  • inrupt.test.requester.client-id & inrupt.test.requester.client-secret are used in the Access Grant scenarios tests and act as the second client, the requestor. The requestor wants to access resources which are owned by the client representing the owner (the first pair of id and secret).

Optional fields are:

  • inrupt.test.webid is needed only if we want to run the integration tests on a live service. Otherwise, this property needs to be left out because it will be populated by the Mocked services with a mock username called someuser.
  • inrupt.test.requester.webid is only needed in the access grants test scenarios and can be also left empty because the Mocked services will create a username called requester.
  • inrupt.test.auth-method refers to the client authentication method and has a default value of client_secret_basic. This value is used when this property is not provided.
  • inrupt.test.feature.request-metadata is a true or false config that signals if the feature is available on the server and only then runs the according scenarios. By default, this is set on false.
  • inrupt.test.request-metadata-headers-that-propagate if the above is true, the test scenarios need to know which headers the servers can propagate. This is a string comma separated list.

The embedded Mock Solid Server

The Mock Solid Server is actually a collection of services which try to mock, as true as possible, a live setup of a Solid Server (which also complies to specifications). For these purpose we list the following services involved in the mocking of a Solid Server:

  • MockWebIdService - mocks the basics of a WebId provider service which returns a WebId Profile Document. In our tests, the WebId Profile Document is presented as a Turtle file which contains a bare minimum information about the storage location linked to this WebID and the location of the Solid-OIDC issuer.

  • MockOpenIDProvider - mocks the Identity Provider (IdP) service which is linked in the WebId Profile Document (solid:oidcissuer). The basic features of the mocked IdP are:

    • to provide information on its discovery endpoint (found under /.well-known/openid-configuration);
    • provide a token on its token endpoint (found under oauth/oauth20/token);
    • provide a jwks on its jwks endpoint (found under oauth/jwks).

  • MockSolidServer - mocks the storage service of a Pod provider. It mocks the behavior of private and public resources by looking if the resource path contains the State.PRIVATE_RESOURCE_PATH which is set to private. And it mocks, according to Solid Protocol methods like GET, PUT, POST, HEAD and PATCH.

  • MockUMAAuthorizationServer - mocks the authorization service, in our case a UMA service. UMA authorization is the default, hard-coded, in the Mocked services. This can be seen in any request on a private resource in the MockSolidServer. When not authorized, the Solid Server will respond with a WWW-Authenticate header which contains a UMA ticket.

  • MockAccessGrantServer - mocks the access grant service, which is a VC service here. A couple of hardcoded assumptions are embedded in the Mock to make it work. Especially regarding the status of grants: active or revoked.