daml/sdk/compatibility
Gary Verhaegen e40aad897f
move to subdir 3.0 (#18520)
* move most files

* update CI configuration
2024-03-22 02:27:46 +01:00
..
bazel_tools move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
head_sdk move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
versions move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
.bazelignore move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
.bazelrc move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
bazel-haskell-deps.bzl move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
BUILD move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
build-release-artifacts-windows.ps1 move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
build-release-artifacts.sh move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
build-ts-libs.sh move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
deps.bzl move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
maven_install.json move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
new_cache move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
old_cache move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
README.md move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
releases-github-api.json move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
stack-snapshot.yaml move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
stackage_snapshot_windows.json move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
stackage_snapshot.json move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
test-all-installs.sh move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
test-daml-version-and-install.sh move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
test-windows.ps1 move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
test.sh move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
update-versions.sh move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
versions.bzl move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00
WORKSPACE move to subdir 3.0 (#18520) 2024-03-22 02:27:46 +01:00

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:

  1. All stable SDK versions.
  2. All snapshots x.y.z-snapshot-* for which there is no stable release x.y.z
  3. 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.

Data-continuity for Sandbox classic

We have migration tests that work as follows:

  1. Start the oldest Sandbox version and upload a DAR.

  2. Iterate over SDK versions in order. For each version:

    1. Start sandbox of that SDK version.

    2. Run a custom Scala binary that interacts with the ledger to create contracts, exercise choices and query the ACS and the transaction service.

    3. 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 data-dependencies

We test that we can import DARs built in older SDK versions via data-dependencies. We only test backwards compatibility here.