Skip to content

Latest commit

 

History

History
 
 

integration-test

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

Integration Test For the New MPP Cluster

Integration test for the new mpp cluster are in this module.

Now integration testing supports three modes the Cluster mode, the Local Standalone mode and the Remote mode.

Integration Testing with Cluster Mode

You can run the integration test in cluster mode. At present, we have implemented a pseudo cluster with 3 config nodes and 3 data nodes. (As the test cases and the test environment are decoupled, we can easily implement other pseudo cluster or even a docker-based cluster later.)

The maven command is:

mvn clean verify \
-Dsession.test.skip=true \
-Diotdb.test.skip=true \
-Dcluster.test.skip=true \
-Dtsfile.test.skip=true \
-Dcommons.test.skip=true \
-Dconfignode.test.skip=true \
-Dconsensus.test.skip=true \
-Djdbc.test.skip=true \
-Dmetrics.test.skip=true \
-pl integration-test \
-am -PClusterIT

Notice that, this above maven command only run IT.


Run in IntelliJ in cluster mode is so easy,

  • Step 0. Optionally, when you run the test for the first time, or when you change the code of the module that the integration test module depends on, you may need to use the following command to generate integration-test/target/template-node for nodes of the pseudo cluster.
mvn clean package -pl integration-test -am -DskipTests -PClusterIT
  • Step 1. Run(Menu) -> Edit Configurations...
    Run(Menu)

  • Step 2. Add New Configuration -> JUnit
    Add New Configuration

  • Step 3. Input some fields as the following picture
    ClusterIT Category

Integration Testing with Local Standalone Mode

Integration testing with local standalone mode can be run with both maven and IDEs like IntelliJ.

The maven command is:

mvn clean verify \
-Dsession.test.skip=true \
-Diotdb.test.skip=true \
-Dcluster.test.skip=true \
-Dtsfile.test.skip=true \
-Dcommons.test.skip=true \
-Dconfignode.test.skip=true \
-Dconsensus.test.skip=true \
-Djdbc.test.skip=true \
-Dmetrics.test.skip=true \
 -pl integration-test -am

And if you want to run IT in the IDE like IntelliJ, you need to achieve the effect as the LocalStandalone profile in maven. Follow Steps 1-4 to achieve it.

  • Step 1. Run(Menu) -> Edit Configurations...
    Run(Menu)

  • Step 2. Add New Configuration -> JUnit
    Add New Configuration

  • Step 3. Input some fields as the following picture
    StandaloneIT Category

  • Step 4. Pay attention to the Fork mode in Modify options: you need to change None to class in Fork mode
    Fork mode

Integration Testing with Remote Mode

You can also run the integration test in remote mode. The remote server can be a standalone server or a server of a cluster.

The maven command is:

mvn clean verify -pl integration-test -am -PRemoteIT -DRemoteIp=127.0.0.1 -DRemotePort=6667

Writing a New Test

What should we cover in integration tests

For every end-user functionality provided by IoTDB, we should have an integration test verifying the correctness.

Rules to be followed while writing a new integration test

Every Integration Test must follow these rules:

  1. The name of the test file must end with a suffix "IT"
  2. Tests are to be written in Junit style
  3. Put appropriate annotation @Category on the class or the test level
  4. It's highly recommend that, use statement.execute() to do manipulate action with SQL like CREATE/INSERT/DELETE, and use statement.executeQuery() to do query action with SQL like SELECT

About the annotation:

You can put the annotation @Category({LocalStandaloneTest.class, ClusterTest.class, RemoteTest.class}) on the class or the test level. And you can use these annotations individually or in combination.

LocalStandaloneTest.class stands for you want your test run in the local standalone mode.

ClusterTest.class stands for you want your test run in the cluster mode.

RemoteTest.class stands for you want your test run in the remote mode.