Plume/.drone.jsonnet

197 lines
5.4 KiB
Text
Raw Normal View History

2020-06-26 11:38:13 +00:00
// This is the CI config for Plume.
// It uses a Drone CI instance, on https://ci.joinplu.me
// First of all, we define a few useful constants
// This Docker image contains everything we need to build Plume.
// Its Dockerfile can be found at https://git.joinplu.me/plume/buildenv
local plumeEnv = "plumeorg/plume-buildenv:v0.0.9";
// A pipeline step that restores the cache.
// The cache contains all the cargo build files.
// Thus, we don't have to download and compile all of our dependencies for each
// commit.
// This cache is only "deleted" when the contents of Cargo.lock changes.
//
// We use this plugin for caching: https://github.com/meltwater/drone-cache/
//
// Potential TODO: use one cache per pipeline, as we used to do when we were
// using CircleCI.
local restoreCache = {
name: "restore-cache",
image: "meltwater/drone-cache:dev",
pull: true,
settings: {
backend: "filesystem",
restore: true,
cache_key: 'v0-{{ checksum "Cargo.lock" }}-{{ .Commit.Branch }}',
archive_format: "gzip",
mount: [ "~/.cargo/", "./target" ]
},
2020-06-26 11:53:11 +00:00
volumes: [ { name: "cache", path: "/tmp/cache" } ]
2020-06-26 11:38:13 +00:00
};
// And a step that saves the cache.
local saveCache = {
name: "save-cache",
image: "meltwater/drone-cache:dev",
pull: true,
settings: {
backend: "filesystem",
rebuild: true,
cache_key: 'v0-{{ checksum "Cargo.lock" }}-{{ .Commit.Branch }}',
archive_format: "gzip",
mount: [ "~/.cargo/", "./target" ]
},
2020-06-26 11:53:11 +00:00
volumes: [ { name: "cache", path: "/tmp/cache" } ]
2020-06-26 11:38:13 +00:00
};
// Finally, the Docker volume to store the cache
local cacheVolume = {
name: "cache",
host: {
path: "/var/lib/cache"
}
};
// This step starts a PostgreSQL database if the db parameter is "postgres",
// otherwise it does nothing.
local startDb(db) = if db == "postgres" then {
name: "start-db",
image: "postgres:9.6-alpine",
detach: true,
environment: {
POSTGRES_USER: "postgres",
POSTGRES_DB: "plume"
}
};
2020-07-15 10:40:11 +00:00
// A utility function to generate a new pipeline
local basePipeline(name, steps) = {
kind: "pipeline",
name: name,
type: "docker",
steps: steps
};
2020-06-26 11:38:13 +00:00
2020-07-15 10:40:11 +00:00
// And this function creates a pipeline with caching
local cachedPipeline(name, commands) = basePipeline(
name,
2020-06-26 11:38:13 +00:00
[
restoreCache,
{
2020-07-15 10:40:11 +00:00
name: name,
2020-06-26 11:38:13 +00:00
image: plumeEnv,
2020-07-15 10:40:11 +00:00
commands: commands,
2020-06-26 11:38:13 +00:00
},
2020-07-15 10:40:11 +00:00
saveCache
2020-06-26 11:38:13 +00:00
]
);
2020-07-15 10:40:11 +00:00
// Here starts the actual list of pipelines!
// PIPELINE 1: a pipeline that runs cargo fmt, and that fails if the style of
// the code is not standard.
local CargoFmt() = cachedPipeline(
"cargo-fmt",
[ "cargo fmt --all -- --check" ]
);
// PIPELINE 2: runs clippy, a tool that helps
// you writing idiomatic Rust.
// Helper function:
local cmd(db, pkg, features=true) = if features then
"cargo clippy --no-default-features --features " + db + "--release -p "
+ pkg + " -- -D warnings"
else
"cargo clippy --no-default-features --release -p "
+ pkg + " -- -D warnings";
// The actual pipeline:
local Clippy(db) = cachedPipeline(
2020-06-26 11:38:13 +00:00
"clippy-" + db,
[
2020-07-15 10:40:11 +00:00
cmd(db, "plume"),
cmd(db, "plume-cli"),
cmd(db, "plume-front", false)
]
);
// PIPELINE 3: runs unit tests
local Unit(db) = cachedPipeline(
"unit-" + db,
[
"cargo test --all --exclude plume-front --exclude plume-macro"
+ "--no-run --no-default-features --features=" + db
]
);
// PIPELINE 4: runs integration tests
// It installs a local instance an run integration test with Python scripts
// that use Selenium (located in scripts/browser_test).
local Integration(db) = cachedPipeline(
"integration-" + db,
[
// Install the front-end
"cargo web deploy -p plume-front",
// Install the server
'cargo install --debug --no-default-features --features="'
+ db + '",test --force --path .',
// Install plm
'cargo install --debug --no-default-features --features="'
+ db + '",test --force --path plume-cli',
// Run the tests
"./script/run_browser_test.sh"
]
);
// PIPELINE 5: make a release build and save artifacts
//
// It should also deploy the SQlite build to a test instance
// located at https://pr-XXX.joinplu.me (but this system is not very
// stable, and often breaks).
//
// TODO: save the artifacts that are generated somewhere
local Release(db) = cachedPipeline(
"release-" + db,
[
"cargo web deploy -p plume-front --release",
"cargo build --release --no-default-features --features=" + db + " -p plume",
"cargo build --release --no-default-features --features=" + db + " -p plume-cli",
"./script/generate_artifact.sh",
] + if db == "sqlite" then [ "./script/upload_test_environment.sh" ] else []
);
// PIPELINE 6: upload the new PO templates (.pot) to Crowdin
//
// TODO: run only on master
local PushTranslations() = basePipeline(
"push-translations",
[
2020-06-26 11:38:13 +00:00
{
2020-07-15 10:40:11 +00:00
name: "push-translations",
2020-06-26 11:38:13 +00:00
image: plumeEnv,
commands: [
2020-07-15 10:40:11 +00:00
"cargo build",
"crowdin upload -b master"
]
}
2020-06-26 11:38:13 +00:00
]
);
// And finally, the list of all our pipelines:
[
CargoFmt(),
Clippy("postgres"),
Clippy("sqlite"),
Unit("postgres"),
Unit("sqlite"),
Integration("postgres"),
Integration("sqlite"),
Release("postgres"),
Release("sqlite"),
PushTranslations()
]