diff --git a/docs/source/testing.rst b/docs/source/testing.rst index a6cd21b962..242e2cf26d 100644 --- a/docs/source/testing.rst +++ b/docs/source/testing.rst @@ -1,42 +1,38 @@ -Testing Corda -============= +Testing your changes +==================== -Automated Tests +Automated tests --------------- +Corda has a suite of tests that any contributing developers must maintain and extend when adding new code. -Corda has a maintained suite of tests that any contributing developers must maintain and add to if new code has been added. +There are several test suites: -There are several distinct test suites each with a different purpose; +* **Unit tests**: These are traditional unit tests that should only test a single code unit, typically a method or class. +* **Integration tests**: These tests should test the integration of small numbers of units, preferably with mocked out services. +* **Smoke tests**: These are full end to end tests which start a full set of Corda nodes and verify broader behaviour. +* **Other**: These include tests such as performance tests, stress tests, etc, and may be in an external repo. -**Unit tests**: These are traditional unit tests that should only test a single code unit, typically a method or class. +Running the automated tests +^^^^^^^^^^^^^^^^^^^^^^^^^^^ +These tests are mostly written with JUnit and can be run via ``gradle``: -**Integration tests**: These tests should test the integration of small numbers of units, preferably with mocked out services. - -**Smoke tests**: These are full end to end tests which start a full set of Corda nodes and verify broader behaviour. - -**Other**: These include tests such as performance tests, stress tests, etc, and may be in an external repo. - -These tests are mostly written with JUnit and can be run via ``gradle``. On windows run ``gradlew test integrationTest -smokeTest`` and on unix run ``./gradlw test integrationTest smokeTest`` or any combination of these three arguments. +* **Windows**: Run ``gradlew test integrationTest smokeTest`` +* **Unix/Mac OSX**: Run ``./gradlew test integrationTest smokeTest`` Before creating a pull request please make sure these pass. -Manual Testing +Manual testing -------------- +You should manually test anything that would be impacted by your changes. The areas that usually need to be manually tested and when are +as follows: -Manual testing would ideally be done for every set of changes merged into master, but practically you should manually test -anything that would be impacted by your changes. The areas that usually need to be manually tested and when are below; +* **Node startup** - changes in the ``node`` or ``node:capsule`` project in both the Kotlin or gradle or the ``cordformation`` gradle plugin. +* **Sample project** - changes in the ``samples`` project. eg; changing the IRS demo means you should manually test the IRS demo. +* **Explorer** - changes to the ``tools/explorer`` project. +* **Demobench** - changes to the ``tools/demobench`` project. -**Node startup** - changes in the ``node`` or ``node:capsule`` project in both the Kotlin or gradle or the ``cordformation`` gradle plugin. - -**Sample project** - changes in the ``samples`` project. eg; changing the IRS demo means you should manually test the IRS demo. - -**Explorer** - changes to the ``tools/explorer`` project. - -**Demobench** - changes to the ``tools/demobench`` project. - -How to manually test each of these areas differs and is currently not fully specified. For now the best thing to do is -ensure the program starts, that you can interact with it, and that no exceptions are generated in normal operation. +How to manually test each of these areas differs and is currently not fully specified. For now the best thing to do is to ensure the +program starts, that you can interact with it, and that no exceptions are generated in normal operation. TODO: Add instructions on manual testing diff --git a/node/src/main/kotlin/net/corda/node/services/schema/NodeSchemaService.kt b/node/src/main/kotlin/net/corda/node/services/schema/NodeSchemaService.kt index e835f34a35..eb12d30e38 100644 --- a/node/src/main/kotlin/net/corda/node/services/schema/NodeSchemaService.kt +++ b/node/src/main/kotlin/net/corda/node/services/schema/NodeSchemaService.kt @@ -45,7 +45,8 @@ class NodeSchemaService(private val extraSchemas: Set = emptySet() PersistentIdentityService.PersistentIdentityNames::class.java, ContractUpgradeServiceImpl.DBContractUpgrade::class.java, RunOnceService.MutualExclusion::class.java, - PersistentKeyManagementService.PublicKeyHashToExternalId::class.java)) { + PersistentKeyManagementService.PublicKeyHashToExternalId::class.java + )) { override val migrationResource = "node-core.changelog-master" } diff --git a/node/src/main/resources/migration/vault-schema.changelog-master.xml b/node/src/main/resources/migration/vault-schema.changelog-master.xml index 9a049e261c..d0e56b85aa 100644 --- a/node/src/main/resources/migration/vault-schema.changelog-master.xml +++ b/node/src/main/resources/migration/vault-schema.changelog-master.xml @@ -12,5 +12,4 @@ -