Skip to content

TESTING.md

Latest commit

 

History

History
127 lines (98 loc) · 5.26 KB

TESTING.md

File metadata and controls

127 lines (98 loc) · 5.26 KB

Requirements

In order to run the full test suite users will need access to a running Manta endpoint. Some tests rely on additional configuration which must occur outside of this project and will be skipped if it is determined that the test cannot be run. Keep an eye on the count of skipped tests and review the relevant sections in this document if you find that any tests are skipped.

Client Configuration

The following properties should be set using either environment variables or system properties:

  • manta.url or MANTA_URL
  • manta.user or MANTA_USER
  • manta.key_id or MANTA_KEY_ID
  • manta.key_path or MANTA_KEY_PATH

Multipart Upload (Server-side support)

Tests specific to server-side MPU functionality will be automatically skipped if the server con does not support that capability.

Roles

Tests which rely on Triton roles will require the creation of roles through the Triton customer portal. The names of the roles used in the tests will be retrieved in the same fashion as standard configuration, first checking environment variables followed by system properties and finally expecting defaults to be defined. These tests will be skipped if it is determined that the roles do not exist.

Default System Property Environment Variable
primary manta.it.role_primary MANTA_IT_ROLE_PRIMARY
secondary manta.it.role_secondary MANTA_IT_ROLE_SECONDARY

Integration Test Path

Integration tests only touch paths under the integration test root path which is configurable using the manta.it.path system property or the MANTA_IT_PATH environment variable. The default behavior is to compute the base path based on the user's private folder, e.g. /my.account/stor/java-manta-integration-tests.

This is useful if you want to run a single test case using -Dit.test=${TESTNAME} and want the data created by that test to live in a specific directory. This also makes it possible to isolate entire runs of the test suite, e.g.

mvn verify -Dmanta.it.path="$MANTA_USER/stor/$(git rev-parse HEAD)"

By default integration tests cleanup after completion and delete the objects they created. This can be disabled with the manta.it.no_cleanup system property or MANTA_IT_NO_CLEANUP environment variable.

Running Tests

Run mvn verify from the project root to run all tests. Some Maven goals will not work.

While the Java Cryptography Extensions are expected to be installed, it is possible to run a subset of the test suite by adding -DexcludedGroups=unlimited-crypto or -Dgroups=headers,error, e.g.

mvn test -DexcludedGroups=unlimited-crypto
mvn verify -Dgroups=headers,error

Also, if we are running a defined TestNG group, invoke -Dgroups=headers, e.g:

mvn clean verify -Dgroups=headers

Note: Since we have transitioned from wildcard to explicit test definition (i.e package-level to class-level hierarchy), engineers are required to add integration-tests in testng-it.xml file complying with the nature of their corresponding TestNG groups. For instance, if we create a new integration-test ExampleHttpHeadersIT.java for headers, that test will be defined under:

    <test name="Manta Client Http Headers Tests">
        <groups>
            <define name="headers" />
        </groups>
        <classes>
            <class name="com.joyent.manta.http.MantaHttpHeadersIT" />
            <class name="com.joyent.manta.http.ExampleHttpHeadersIT" />
        </classes>
    </test>

Dry run

The following invocation will print a list of which integration tests would run and their relevant parameters::

mvn verify -Dit.dryRun=true

Note: This feature is invalid for unit tests.

Writing Tests

The java-manta-client module contains unit tests. Integration tests generally belong in the java-manta-it folder. In case an integration test needs to mock or interact with classes which are shaded you may find that the test runs in your IDE but not through mvn verify, failing with an error similar to the following:

  required: org.apache.http.impl.client.CloseableHttpClient
  found: com.joyent.manta.org.apache.http.impl.client.CloseableHttpClient
  reason: argument mismatch; com.joyent.manta.org.apache.http.impl.client.CloseableHttpClient cannot be converted to org.apache.http.impl.client.CloseableHttpClient

There is still work being done to provide a workaround for this situation.

Surefire and Failsafe plugins are configured to look for TestNG configuration in their module's resource folders.

Java Manta Test Harness

java-manta-test-harness is a community-maintained Java testing app used for verifying Java 11 support by java-manta client SDK for manta. It is a tool to efficiently leverage and verify java sdk compatibilities with different java versions whenever required. Instructions on how to use this application is available here.