6035840d8a
* Upgrade Scala 2.12 to v2.12.13. This is being pulled in anyway because of Maven/Gradle/etc's fun "favor the most recent" resolution mechanism. The version of Akka we depend upon transitively depends on Scala 2.12.13, so any downstream consumers will see that as the Scala version required. Bringing the Daml repo in line means no more confusion. CHANGELOG_BEGIN - [Scala Bindings] If you are using Daml on Scala 2.12, it now depends on Scala v2.12.13 (from v2.12.12). CHANGELOG_END * Scala 2.12.13 is the default version in our pinned version of nixpkgs. * Upgrade Scala 2.13's Wartremover version. * Rename `scala_version_rule` to `scala_version_configure`. * Add a test case to ensure the Scala versions are the same everywhere. * Add tests for the Scala JAR versions in maven_install_*.json * gatling-utils: Change the sort order of the expected CSV in tests. I don't know why this changed, but it seems to be stable. * compatibility: `scala_version` -> `scala_version_configure`. * Bazel: Disable the Scala version tests on Windows. * compatibility: Upgrade Wartremover to Scala 2.12.13. |
||
|---|---|---|
| .. | ||
| assistant | ||
| bazel_tools | ||
| head_sdk | ||
| sandbox-migration | ||
| versions | ||
| .bazelignore | ||
| .bazelrc | ||
| bazel-haskell-deps.bzl | ||
| BUILD | ||
| build-release-artifacts-windows.ps1 | ||
| build-release-artifacts.sh | ||
| build-ts-libs.sh | ||
| deps.bzl | ||
| maven_install.json | ||
| README.md | ||
| stack-snapshot.yaml | ||
| stackage_snapshot_windows.json | ||
| stackage_snapshot.json | ||
| test-windows.ps1 | ||
| test.sh | ||
| update-versions.sh | ||
| versions.bzl | ||
| WORKSPACE | ||
| workspace_status.sh | ||
This directory contains the infrastructure and test setup for cross-version compatibility testing. We make this a separate Bazel workspace to make it easier to enforce that we only depend on release artifacts.
How to
Before using this, make sure to always run the scripts that build the
SDK, namely ./build-release-artifacts.sh and ./build-ts-libs.sh.
These should be run every time there is a relevant change you want
to be there for this workspace to use.
Any Bazel command can then be used afterwards. ./test.sh are the
tests run on CI.
What is currently being tested?
We include the following SDK versions in our tests:
- All stable SDK versions.
- All snapshots
x.y.z-snapshot-*for which there is no stable releasex.y.z - HEAD.
Since running all tests can be rather slow, we run them in a daily cron job. On each PR we only include HEAD and the latest stable release.
Cross-version compatibility between ledger-api-test-tool
We test that the ledger-api-test-tool of a given version passes
against Sandbox next and classic of another version. We test all
possible version combinations here to ensure forwards and backwards
compatibility. The ledger-api-test-tool includes a DAR built using a
compiler from the same SDK version so this also ensures that sandbox
can load a DAR from a different SDK version. We test both in-memory
backends and postgresql backends.
Since all our JVM ledger clients use the same client libraries we
consider the ledger-api-test-tool to be a good proxy and if things
are not covered it should be extended.
Data-continuity for Sandbox classic
We have migration tests that work as follows:
-
Start the oldest Sandbox version and upload a DAR.
-
Iterate over SDK versions in order. For each version:
-
Start sandbox of that SDK version.
-
Run a custom Scala binary that interacts with the ledger to create contracts, exercise choices and query the ACS and the transaction service.
-
Validates the results. This includes verifying that the transaction streams are the same after the migration and that the ACS is the same + additional test-specific checks.
-
We have two tests here: One that includes snapshot versions and one that only iterates through stable versions up to HEAD. This ensures that both individual migrations are correct as well as the migrations from one stable version to the next work as a whole.
Backwards-compatibility for Daml Script
We test that the Daml Script runner from a given SDK version can load DARs built against the Daml Script library from an older SDK. We only guarantee backwards compatibility here.
Backwards-compatibility for Daml Triggers
We test that the Daml Trigger runner from a given SDK version can load DARs built against the Daml Script library from an older SDK. We only guarantee backwards compatibility here.
Backwards-compatibility for data-dependencies
We test that we can import DARs built in older SDK versions via
data-dependencies. We only test backwards compatibility here.
Cross-version compatibility for create-daml-app
We test that we can run the create-daml-app tests with JS client
libraries and codegen from one version against the JSON API and
Sandbox from another version. We test all version combinations
here. Currently we do not test different versions of the JSON API and
Sandbox. This should be covered by the ledger-api-test-tool tests
since the JSON API uses the same client libraries.