Support plain cargo test and disable unused doctests for speed

Since DB tests execute diesel migrations automatically, concurrent
execution causes flaky failures from simultaneous migrations. This can
be worked around using `cargo test --workspace -- --test-threads=1`,
which is what the CI config does, but this is not intuitive for
newcomer developers and unnecessarily slows down the test suite for
the majority of tests which are safe to run concurrently. This fixes
this issue by integrating with the small test crate `serial_test` and
using it to explicitly mark DB tests to run sequentially while
allowing all other tests to run in parallel.

Additionally, this greatly improves the speed of `cargo test` by
disabling doc-tests in all crates, since these are aren't currently
used and cargo's doc-test pass, even when no doc-tests exist, has
significant overhead. On my machine, this change significantly
improves test suite times by about 85%, making it much more practical
to develop with tools like `cargo watch` auto-running tests.
This commit is contained in:
Andrew Yoon 2021-02-25 14:43:39 -05:00
parent ea3c0e1772
commit 600ae662a5
32 changed files with 94 additions and 2 deletions

View file

@ -29,7 +29,6 @@ steps:
environment:
LEMMY_DATABASE_URL: postgres://lemmy:password@database:5432/lemmy
RUST_BACKTRACE: 1
RUST_TEST_THREADS: 1
commands:
- sudo apt-get update
- sudo apt-get -y install --no-install-recommends espeak postgresql-client
@ -107,7 +106,6 @@ steps:
environment:
LEMMY_DATABASE_URL: postgres://lemmy:password@database:5432/lemmy
RUST_BACKTRACE: 1
RUST_TEST_THREADS: 1
commands:
- apt-get update
- apt-get -y install --no-install-recommends espeak postgresql-client libssl-dev pkg-config libpq-dev

26
Cargo.lock generated
View file

@ -1,5 +1,7 @@
# This file is automatically @generated by Cargo.
# It is not intended for manual editing.
version = 3
[[package]]
name = "activitystreams"
version = "0.7.0-alpha.10"
@ -1818,6 +1820,7 @@ dependencies = [
"regex",
"serde 1.0.123",
"serde_json",
"serial_test",
"sha2",
"strum",
"strum_macros",
@ -1845,6 +1848,7 @@ dependencies = [
"lemmy_db_schema",
"log",
"serde 1.0.123",
"serial_test",
"url",
]
@ -3080,6 +3084,28 @@ dependencies = [
"serde 1.0.123",
]
[[package]]
name = "serial_test"
version = "0.5.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e0bccbcf40c8938196944a3da0e133e031a33f4d6b72db3bda3cc556e361905d"
dependencies = [
"lazy_static",
"parking_lot",
"serial_test_derive",
]
[[package]]
name = "serial_test_derive"
version = "0.5.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b2acd6defeddb41eb60bb468f8825d0cfd0c2a76bc03bfd235b6a1dc4f6a1ad5"
dependencies = [
"proc-macro2",
"quote",
"syn",
]
[[package]]
name = "sha-1"
version = "0.8.2"

View file

@ -3,6 +3,9 @@ name = "lemmy_server"
version = "0.0.1"
edition = "2018"
[lib]
doctest = false
[profile.dev]
debug = 0

View file

@ -7,6 +7,7 @@ edition = "2018"
[lib]
name = "lemmy_api"
path = "src/lib.rs"
doctest = false
[dependencies]
lemmy_apub = { path = "../apub" }

View file

@ -7,6 +7,7 @@ edition = "2018"
[lib]
name = "lemmy_apub"
path = "src/lib.rs"
doctest = false
[dependencies]
lemmy_utils = { path = "../utils" }

View file

@ -6,6 +6,7 @@ edition = "2018"
[lib]
name = "lemmy_db_queries"
path = "src/lib.rs"
doctest = false
[dependencies]
lemmy_utils = { path = "../utils" }
@ -23,3 +24,6 @@ url = { version = "2.2.0", features = ["serde"] }
lazy_static = "1.4.0"
regex = "1.4.3"
bcrypt = "0.9.0"
[dev-dependencies]
serial_test = "0.5.1"

View file

@ -37,8 +37,10 @@ mod tests {
post::{Post, PostForm},
user::{UserForm, User_},
};
use serial_test::serial;
#[test]
#[serial]
fn test_crud() {
let conn = establish_unpooled_connection();

View file

@ -41,8 +41,10 @@ mod tests {
post::{Post, PostForm},
user::{UserForm, User_},
};
use serial_test::serial;
#[test]
#[serial]
fn test_crud() {
let conn = establish_unpooled_connection();

View file

@ -41,8 +41,10 @@ mod tests {
post::{Post, PostForm, PostLike, PostLikeForm},
user::{UserForm, User_},
};
use serial_test::serial;
#[test]
#[serial]
fn test_crud() {
let conn = establish_unpooled_connection();

View file

@ -39,8 +39,10 @@ mod tests {
site::{Site, SiteForm},
user::{UserForm, User_},
};
use serial_test::serial;
#[test]
#[serial]
fn test_crud() {
let conn = establish_unpooled_connection();

View file

@ -37,8 +37,10 @@ mod tests {
post::{Post, PostForm, PostLike, PostLikeForm},
user::{UserForm, User_},
};
use serial_test::serial;
#[test]
#[serial]
fn test_crud() {
let conn = establish_unpooled_connection();

View file

@ -9,6 +9,9 @@ extern crate lazy_static;
#[macro_use]
extern crate diesel_migrations;
#[cfg(test)]
extern crate serial_test;
use diesel::{result::Error, *};
use lemmy_db_schema::Url;
use regex::Regex;

View file

@ -133,8 +133,10 @@ mod tests {
user::{UserForm, User_},
};
use serde_json::Value;
use serial_test::serial;
#[test]
#[serial]
fn test_crud() {
let conn = establish_unpooled_connection();

View file

@ -212,8 +212,10 @@ mod tests {
post::*,
user::{UserForm, User_},
};
use serial_test::serial;
#[test]
#[serial]
fn test_crud() {
let conn = establish_unpooled_connection();

View file

@ -340,8 +340,10 @@ mod tests {
SortType,
};
use lemmy_db_schema::source::{community::*, user::*};
use serial_test::serial;
#[test]
#[serial]
fn test_crud() {
let conn = establish_unpooled_connection();

View file

@ -199,9 +199,11 @@ impl Crud<ModAddForm> for ModAdd {
mod tests {
use crate::{establish_unpooled_connection, Crud, ListingType, SortType};
use lemmy_db_schema::source::{comment::*, community::*, moderator::*, post::*, user::*};
use serial_test::serial;
// use Crud;
#[test]
#[serial]
fn test_crud() {
let conn = establish_unpooled_connection();

View file

@ -80,8 +80,10 @@ mod tests {
SortType,
};
use lemmy_db_schema::source::{password_reset_request::PasswordResetRequest, user::*};
use serial_test::serial;
#[test]
#[serial]
fn test_crud() {
let conn = establish_unpooled_connection();

View file

@ -231,8 +231,10 @@ mod tests {
community::{Community, CommunityForm},
user::*,
};
use serial_test::serial;
#[test]
#[serial]
fn test_crud() {
let conn = establish_unpooled_connection();

View file

@ -147,8 +147,10 @@ mod tests {
SortType,
};
use lemmy_db_schema::source::{private_message::*, user::*};
use serial_test::serial;
#[test]
#[serial]
fn test_crud() {
let conn = establish_unpooled_connection();

View file

@ -379,8 +379,10 @@ impl User for User_ {
#[cfg(test)]
mod tests {
use crate::{establish_unpooled_connection, source::user::*, ListingType, SortType};
use serial_test::serial;
#[test]
#[serial]
fn test_crud() {
let conn = establish_unpooled_connection();

View file

@ -81,8 +81,10 @@ mod tests {
user::*,
user_mention::*,
};
use serial_test::serial;
#[test]
#[serial]
fn test_crud() {
let conn = establish_unpooled_connection();

View file

@ -3,6 +3,9 @@ name = "lemmy_db_schema"
version = "0.1.0"
edition = "2018"
[lib]
doctest = false
[dependencies]
diesel = { version = "1.4.5", features = ["postgres","chrono","r2d2","serde_json"] }
chrono = { version = "0.4.19", features = ["serde"] }

View file

@ -3,6 +3,9 @@ name = "lemmy_db_views"
version = "0.1.0"
edition = "2018"
[lib]
doctest = false
[dependencies]
lemmy_db_queries = { path = "../db_queries" }
lemmy_db_schema = { path = "../db_schema" }
@ -10,3 +13,6 @@ diesel = { version = "1.4.5", features = ["postgres","chrono","r2d2","serde_json
serde = { version = "1.0.123", features = ["derive"] }
log = "0.4.14"
url = "2.2.0"
[dev-dependencies]
serial_test = "0.5.1"

View file

@ -443,8 +443,10 @@ mod tests {
SortType,
};
use lemmy_db_schema::source::{comment::*, community::*, post::*, user::*};
use serial_test::serial;
#[test]
#[serial]
fn test_crud() {
let conn = establish_unpooled_connection();

View file

@ -1,3 +1,6 @@
#[cfg(test)]
extern crate serial_test;
pub mod comment_report_view;
pub mod comment_view;
pub mod post_report_view;

View file

@ -434,8 +434,10 @@ mod tests {
SortType,
};
use lemmy_db_schema::source::{community::*, post::*, user::*};
use serial_test::serial;
#[test]
#[serial]
fn test_crud() {
let conn = establish_unpooled_connection();

View file

@ -3,6 +3,9 @@ name = "lemmy_db_views_actor"
version = "0.1.0"
edition = "2018"
[lib]
doctest = false
[dependencies]
lemmy_db_queries = { path = "../db_queries" }
lemmy_db_schema = { path = "../db_schema" }

View file

@ -3,6 +3,9 @@ name = "lemmy_db_views_moderator"
version = "0.1.0"
edition = "2018"
[lib]
doctest = false
[dependencies]
lemmy_db_queries = { path = "../db_queries" }
lemmy_db_schema = { path = "../db_schema" }

View file

@ -3,6 +3,9 @@ name = "lemmy_routes"
version = "0.1.0"
edition = "2018"
[lib]
doctest = false
[dependencies]
lemmy_utils = { path = "../utils" }
lemmy_websocket = { path = "../websocket" }

View file

@ -7,6 +7,7 @@ edition = "2018"
[lib]
name = "lemmy_structs"
path = "src/lib.rs"
doctest = false
[dependencies]
lemmy_db_queries = { path = "../db_queries" }

View file

@ -6,6 +6,7 @@ edition = "2018"
[lib]
name = "lemmy_utils"
path = "src/lib.rs"
doctest = false
[dependencies]
regex = "1.4.3"

View file

@ -7,6 +7,7 @@ edition = "2018"
[lib]
name = "lemmy_websocket"
path = "src/lib.rs"
doctest = false
[dependencies]
lemmy_utils = { path = "../utils" }