Deuxfleurs/garage
48
56
Fork 73
Code Issues 99 Pull requests 13 Releases 30 Wiki Activity

Tests: Add garage integration tests #215

Closed
KokaKiwi wants to merge 8 commits from KokaKiwi/garage:integration-tests into main
pull from: KokaKiwi/garage:integration-tests
merge into: Deuxfleurs:main
Conversation 1 Commits 8 Files changed 15 +2000 -82
KokaKiwi commented 2022-02-02 14:40:50 +00:00
Owner
Copy link

Use the aws-sdk-s3 crate as S3 client implementation.

To test-run the suite:

$ cargo test -p garage --test integration

The integration test can be configured by setting some env vars:

  • GARAGE_TEST_INTEGRATION_PORT: Garage server port to run on (default: 49995)
    NB: The config will actually bind the specified port plus the two following (49996 and 49997 for default value)
  • GARAGE_TEST_INTEGRATION_PATH: Garage test runtime directory (default: /tmp/garage-integ-test-<PORT>)
  • GARAGE_TEST_INTEGRATION_EXE: Garage executable path (default: $CARGO_BIN_EXE_garage)
Use the [`aws-sdk-s3`](https://crates.io/crates/aws-sdk-s3) crate as S3 client implementation. To test-run the suite: ``` $ cargo test -p garage --test integration ``` The integration test can be configured by setting some env vars: - `GARAGE_TEST_INTEGRATION_PORT`: Garage server port to run on (default: 49995) **NB:** The config will actually bind the specified port plus the two following (49996 and 49997 for default value) - `GARAGE_TEST_INTEGRATION_PATH`: Garage test runtime directory (default: `/tmp/garage-integ-test-<PORT>`) - `GARAGE_TEST_INTEGRATION_EXE`: Garage executable path (default: `$CARGO_BIN_EXE_garage`)
👍 1
KokaKiwi added 1 commit 2022-02-02 14:40:51 +00:00
tests: Add garage integration tests (base)
Some checks failed
continuous-integration/drone/pr Build is failing
Details
539b256525
KokaKiwi force-pushed integration-tests from 1fcf363a60 to ff064b8892 2022-02-02 15:29:45 +00:00 Compare
KokaKiwi force-pushed integration-tests from ff064b8892 to 06ad505cb5 2022-02-03 11:55:50 +00:00 Compare
KokaKiwi added 2 commits 2022-02-04 10:50:35 +00:00
Upgrade cargo2nix
Some checks failed
continuous-integration/drone/push Build is failing
Details
30f1608149
Add integration tests to Drone
Some checks failed
continuous-integration/drone/pr Build is passing
Details
continuous-integration/drone/push Build is failing
Details
f1679c6a08
quentin approved these changes 2022-02-04 14:07:21 +00:00
quentin left a comment
Owner
Copy link

LGTM, this is exactly what I imagined for a first version :-)
I have some questions to better understand your code, but I am OK to merge it.

Maybe we should wait until monday if Alex wants to review the code, but I pretty confident that we will be able to merge it very soon :-)

LGTM, this is exactly what I imagined for a first version :-) I have some questions to better understand your code, but I am OK to merge it. Maybe we should wait until monday if Alex wants to review the code, but I pretty confident that we will be able to merge it very soon :-)
src/garage/tests/common/ext/mod.rs Outdated
@ -0,0 +1,3 @@
pub use process::*;
quentin commented 2022-02-04 13:59:43 +00:00
Owner
Copy link

What does ext means? What is the purpose of this module?

What does `ext` means? What is the purpose of this module?
KokaKiwi commented 2022-02-04 14:32:33 +00:00
Author
Owner
Copy link

common::ext is meant to contains some "extension" helpers traits, mainly for stuff contained in std::process structs actually.

`common::ext` is meant to contains some "extension" helpers traits, mainly for stuff contained in `std::process` structs actually.
KokaKiwi marked this conversation as resolved
src/garage/tests/common/garage.rs Outdated
@ -0,0 +184,4 @@
static INSTANCE_INIT: Once = Once::new();
#[static_init::destructor]
extern "C" fn terminate_instance() {
quentin commented 2022-02-04 14:03:14 +00:00
Owner
Copy link

Why do you need extern "C" here?

Why do you need `extern "C"` here?
KokaKiwi commented 2022-02-04 14:30:08 +00:00
Author
Owner
Copy link

It's required by the static_init::destructor attribute, as it register the function to be called by libc global ctor/dtor stuff

It's required by the `static_init::destructor` attribute, as it register the function to be called by libc global ctor/dtor stuff
KokaKiwi marked this conversation as resolved
src/garage/tests/common/garage.rs Outdated
@ -0,0 +200,4 @@
INSTANCE.write(instance);
});
unsafe { INSTANCE.assume_init_ref() }
quentin commented 2022-02-04 14:04:03 +00:00
Owner
Copy link

Do you have any documentation explaining why unsafe is required in this function and the previous one?

Do you have any documentation explaining why `unsafe` is required in this function and the previous one?
KokaKiwi commented 2022-02-04 15:15:45 +00:00
Author
Owner
Copy link

The unsafe blocks here are required because:

  1. INSTANCE is a mutable static, accessing/modifying is unsafe by definition: https://doc.rust-lang.org/nomicon/what-unsafe-does.html
  2. INSTANCE is of MaybeUninit<T> type, accessing its value is unsafe it could be uninitialized at the time it's accessed: std::mem::MaybeUninit::assume_init_ref (see Safety section)

I'll add some changes here to document why these unsafe blocks are actually sound ("safe")

The unsafe blocks here are required because: 1. `INSTANCE` is a mutable static, accessing/modifying is unsafe by definition: https://doc.rust-lang.org/nomicon/what-unsafe-does.html 2. `INSTANCE` is of `MaybeUninit<T>` type, accessing its value is unsafe it could be uninitialized at the time it's accessed: [`std::mem::MaybeUninit::assume_init_ref`](https://doc.rust-lang.org/std/mem/union.MaybeUninit.html#method.assume_init_ref) (see `Safety` section) I'll add some changes here to document why these unsafe blocks are actually sound ("safe")
KokaKiwi marked this conversation as resolved
src/garage/tests/common/macros.rs Outdated
@ -0,0 +1,11 @@
macro_rules! assert_bytes_eq {
quentin commented 2022-02-04 14:04:36 +00:00
Owner
Copy link

Just curiosity here, but why did you define a macro instead of a function here?

Just curiosity here, but why did you define a macro instead of a function here?
KokaKiwi commented 2022-02-04 15:17:09 +00:00
Author
Owner
Copy link

Simply because i wanted to keep the code convention about test assertions utilities: assert!, assert_eq! and assert_ne!

Simply because i wanted to keep the code convention about test assertions utilities: `assert!`, `assert_eq!` and `assert_ne!`
KokaKiwi marked this conversation as resolved
src/garage/tests/simple.rs Outdated
@ -0,0 +1,61 @@
use crate::common;
#[tokio::test]
async fn test_simple() {
quentin commented 2022-02-04 14:05:41 +00:00
Owner
Copy link

happy to see that writing an integration test if very elegant and straightforwrd, gg :-)

happy to see that writing an integration test if very elegant and straightforwrd, gg :-)
❤️ 1
KokaKiwi marked this conversation as resolved
quentin commented 2022-02-04 14:11:04 +00:00
Owner
Copy link

You should also rebase your branch on main, LX merged a patch recently.

You should also rebase your branch on main, LX merged a patch recently.
KokaKiwi added 2 commits 2022-02-04 16:56:30 +00:00
Hide deleted key in bucket info (fix #211)
Some checks failed
continuous-integration/drone/push Build is failing
Details
ae2f32baf1
Probably fix test-smoke
All checks were successful
continuous-integration/drone/pr Build is passing
Details
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/tag Build is passing
Details
continuous-integration/drone Build is passing
Details
935670690f
KokaKiwi force-pushed integration-tests from c6aedebb67 to 2e1b48424a 2022-02-07 13:50:34 +00:00 Compare
KokaKiwi self-assigned this 2022-02-10 10:43:08 +00:00
KokaKiwi force-pushed integration-tests from db3d23c4e5 to 71496c9f4e 2022-02-10 16:04:17 +00:00 Compare
KokaKiwi closed this pull request 2022-02-10 16:05:45 +00:00
Some checks are pending
continuous-integration/drone/pr Build is passing
Details
ci/woodpecker/pr/debug
Required

Pull request closed

Please reopen this pull request to perform a merge.
Sign in to join this conversation.
Reviewers
No reviewers
quentin
Labels
Clear labels   
action
check-aws
The behaviour should be checked against AWS S3

  
action
discussion-needed
We need to discuss if the feature is desirable and/or better specify the envisioned behavior or technical implementation

  
action
for-external-contributors
Core team does not plan working on this in the near future however an external contribution will be reviewed & merged

  
action
for-newcomers
An issue that should be newcomer friendly.

  
action
more-info-needed
More information is needed to investigate this issue

  
action
need-funding
This issue represents lots of work, we need to find money to pay our core team work

  
action
triage-required
It's not very clear what we want to do with this issue yet, more thoughts is required

  
kind
correctness
Issues of theoretical correctness that may impact edge-case scenarios

  
kind
ideas
For abstract ideas/proposal to make Garage better, to better communicate our not yet achieved aims

  
kind
improvement
Feature requests that do not fall in other categories

  
kind
performance
Deceptive performance observed OR idea to improve performances

  
kind
testing
Functional tests, integration tests, Jepsen, etc.

  
kind
usability
Propositions to make Garage easier to operate, by improving error reporting, CLI, etc.

  
kind
wrong-behavior
Unintended behavior

  
prio
critical
Could impact integrity or availability of production clusters

  
prio
low
For issues that we don't want to spend time on until made absolutely necessary

  
scope
admin-api
Issues concerning the administration API

  
scope
background-healing
Background healing covers repair tasks, anti-entropy, merkle trees, etc. ; everything related to replicating data appropriately.

  
scope
build
Issues with Nix, Drone, Rust Compiler, etc.

  
scope
documentation

  
scope
k8s
Kubernetes related, including Helm Charts

  
scope
layout
Linked to the cluster layout and storage management

  
scope
metadata
Metadata Engine (LMDB, sqlite, etc.)

  
scope
ops
Operations related to operations/maintenance issue, tooling related (like CLI missing info ; impossible, too dangerous, too complicated migration, etc.)

  
scope
rpc
Linked to RPC

  
scope
s3-api
Related to the S3 API (especially compatibility issues).

  
scope
security
Cryptography-related, auth-related, authorization-related issues

  
scope
telemetry
OpenTelemetry (traces, metrics, etc.)

No labels
action
check-aws
action
discussion-needed
action
for-external-contributors
action
for-newcomers
action
more-info-needed
action
need-funding
action
triage-required
kind
correctness
kind
ideas
kind
improvement
kind
performance
kind
testing
kind
usability
kind
wrong-behavior
prio
critical
prio
low
scope
admin-api
scope
background-healing
scope
build
scope
documentation
scope
k8s
scope
layout
scope
metadata
scope
ops
scope
rpc
scope
s3-api
scope
security
scope
telemetry
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
KokaKiwi
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: Deuxfleurs/garage#215
No description provided.
Delete branch "KokaKiwi/garage:integration-tests"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?