Using the Distributed CloudSim Package for Integration Testing

[dario-vega]

I validated that integration tests can use the distributed CloudSim package directly.

Setup

Using the CloudSim 5.11.6 distribution package:

oracle-nosql-cloud-simulator-5.11.6/cloudsim/lib/cloudsim.jar

and referencing it from Maven:

<dependency>
    <groupId>com.oracle.nosql</groupId>
    <artifactId>cloudsim</artifactId>
    <version>5.11.6</version>
    <scope>system</scope>
    <systemPath>/mount-path/oracle-nosql-cloud-simulator-5.11.6/cloudsim/lib/cloudsim.jar</systemPath>
</dependency>

The CloudSim distribution includes the required runtime libraries in the cloudsim/lib directory, and the cloudsim.jar manifest defines the runtime classpath.

To explore the available CloudSim APIs and supported functionality, refer to the CloudSim implementation in the Oracle NoSQL open-source repository:

https://github.com/oracle/nosql/blob/main/httpproxy/cloudsim/src/main/java/oracle/nosql/cloudsim/CloudSim.java

Validation

Embedded CloudSim was successfully started from test code:

cloudSim = new CloudSim("target/cloudsim");

and used to execute integration tests against a local simulator instance.

Example test:

cloudSim = new CloudSim("target/cloudsim");

NoSQLHandleConfig config =
    new NoSQLHandleConfig("http://localhost:8080");

config.setAuthorizationProvider(
    new AuthorizationProvider() {
        @Override
        public String getAuthorizationString(Request request) {
            return "Bearer cloudsim";
        }

        @Override
        public void close() {
        }
    });

NoSQLHandle handle =
    NoSQLHandleFactory.createNoSQLHandle(config);

CI Recommendation

For CI jobs:

1. Use the distributed CloudSim 5.11.6 package.
2. Install cloudsim.jar into the local Maven repository during the build bootstrap process.
3. Use a standard Maven dependency declaration in the project.
4. Execute:

mvn clean test

to ensure previous CloudSim execution artifacts are removed before running the tests.

Result

Confirmed that the distributed CloudSim 5.11.6 package can be embedded and used successfully for automated integration testing.

[dario-vega]

A code example

import oracle.nosql.cloudsim.CloudSim;
import oracle.nosql.driver.NoSQLHandle;
import oracle.nosql.driver.NoSQLHandleConfig;
import oracle.nosql.driver.NoSQLHandleFactory;
import oracle.nosql.driver.ops.*;
import oracle.nosql.driver.AuthorizationProvider;

import org.junit.jupiter.api.*;

import static org.junit.jupiter.api.Assertions.assertTrue;

public class CloudSimIntegrationTest {

    private static CloudSim cloudSim;
    private static NoSQLHandle handle;

    @BeforeAll
    static void setup() {

        cloudSim = new CloudSim("target/cloudsim");

        NoSQLHandleConfig config = new NoSQLHandleConfig("http://localhost:8080");

        config.setAuthorizationProvider(
            new AuthorizationProvider() {
                @Override
                public String getAuthorizationString(Request request) {
                    return "Bearer cloudsim";
                }
                @Override
                public void close() {
                }
            });

        handle = NoSQLHandleFactory.createNoSQLHandle(config);
        TableRequest tableRequest =
            new TableRequest()
                .setStatement(
                    "create table if not exists test (" +
                    "id integer, name string, primary key(id))")
                .setTableLimits(new TableLimits(10, 10, 10));

        handle.doTableRequest(
            tableRequest,
            20000,  // wait up to 20 seconds
            1000);  // poll every second
    }

    @AfterAll
    static void cleanup() {

        if (handle != null) {
            handle.close();
        }

        if (cloudSim != null) {
            cloudSim.stop();
        }
    }

    @Test
    void testQuery() {

        QueryRequest request =
            new QueryRequest()
                .setStatement(
                    "select count(*) as cnt from test");

        long count = -1;

        try (QueryIterableResult results =
                 handle.queryIterable(request)) {

            for (var row : results) {
                count = row.getLong("cnt");
            }
        }

        assertTrue(count >= 0);
    }
}