Skip to content

Commit 8a096fb

Browse files
committed
chore(ci): Typo and PR suggestions
1 parent 56c4ff3 commit 8a096fb

File tree

8 files changed

+30
-26
lines changed

8 files changed

+30
-26
lines changed

.gitlab/collect_profiles.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env bash
22

33
# Save all important profiles into (project-root)/profiles
4-
# This folder will be saved by circleci and available after test runs.
4+
# This folder will be saved by gitlab and available after test runs.
55

66
set -e
77
#Enable '**' support

.gitlab/collect_reports.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env bash
22

33
# Save all important reports into (project-root)/reports
4-
# This folder will be saved by circleci and available after test runs.
4+
# This folder will be saved by gitlab and available after test runs.
55

66
set -e
77
#Enable '**' support

.gitlab/collect_results.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env bash
22

33
# Save all important reports and artifacts into (project-root)/results
4-
# This folder will be saved by circleci and available after test runs.
4+
# This folder will be saved by gitlab and available after test runs.
55

66
set -e
77
# Enable '**' support

docs/how_to_test.md

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,25 @@
55
The project leverages different types of test:
66

77
1. The most common ones are **unit tests**.
8-
They are intended to test a single isolated feature, and rely on [JUnit 5 framework](https://junit.org/junit5/docs/current/user-guide/) or [Spock 2 framework](https://spockframework.org/spock/docs/).
9-
JUnit framework is recommended for most unit tests for its simplicity and performance reasons.
10-
Spock framework provides an alternative for more complex test scenarios, or tests that requires Groovy Script to access data outside their scope limitation (eg private fields).
8+
They are intended to test a single isolated feature, and rely on [JUnit 5 framework](https://junit.org/junit5/docs/current/user-guide/) or [Spock 2 framework](https://spockframework.org/spock/docs/).
9+
* JUnit framework is recommended for most unit tests for its simplicity and performance reasons.
10+
* Spock framework provides an alternative for more complex test scenarios, or tests that require Groovy Script to access data outside their scope limitation (eg private fields).
1111

12-
2. A variant of unit tests are **instrumented tests**.
13-
Their purpose is similar to the unit tests but the tested code is instrumented by the java agent (`:dd-trace-java:java-agent`) while running. They extend the Spock specification `datadog.trace.agent.test.AgentTestRunner` which allows to test produced traces and metrics.
12+
2. A variant of unit tests is **instrumented tests**.
13+
Their purpose is similar to the unit tests but the tested code is instrumented by the java agent (`:dd-trace-java:java-agent`) while running. They extend the Spock specification `datadog.trace.agent.test.AgentTestRunner` which allows to test produced traces and metrics.
1414

15-
3. The third type of tests are **Muzzle checks**.
16-
Their goal is to check the [Muzzle directives](./how_instrumentations_work.md#muzzle), making sure instrumentations are safe to load against specific library versions.
15+
3. The third type of tests is **Muzzle checks**.
16+
Their goal is to check the [Muzzle directives](./how_instrumentations_work.md#muzzle), making sure instrumentations are safe to load against specific library versions.
1717

18-
3. The fourth type of tests are **integration tests**.
19-
They test features that requires a more complex environment setup.
20-
In order to build such enviroments, integration tests use Testcontainers to setup the services needed to run the tests.
18+
4. The fourth type of tests is **integration tests**.
19+
They test features that require a more complex environment setup.
20+
In order to build such environment, integration tests use Testcontainers to set up the services needed to run the tests.
2121

22-
4. The fifth type of test are **smoke tests**.
23-
They are dedicated to test the java agent (`:dd-java-agent`) behavior against demo applications to prevent any regression. All smoke tests are located into the `:dd-smoke-tests` module.
22+
5. The fifth type of test is **smoke tests**.
23+
They are dedicated to test the java agent (`:dd-java-agent`) behavior against demo applications to prevent any regression. All smoke tests are located into the `:dd-smoke-tests` module.
2424

25-
5. The last type of test are **system tests**.
26-
They are intended to test behavior consistency between all the client libraries, and relies on [their on GitHub repository](https://github.com/DataDog/system-tests).
25+
6. The last type of test is **system tests**.
26+
They are intended to test behavior consistency between all the client libraries, and rely on [their on GitHub repository](https://github.com/DataDog/system-tests).
2727

2828
> [!TIP]
2929
> Most of the instrumented tests and integration tests are instrumentation tests.
@@ -40,13 +40,16 @@ This mechanism exists to make sure either java agent state or static data are re
4040
4141
### Flaky Tests
4242

43-
If a test runs unreliably, or doen't have a fully deterministic behavior, this will lead into recurrent unexpected errors in continuous integration.
43+
If a test runs unreliably, or doesn't have a fully deterministic behavior, this will lead into recurrent unexpected errors in continuous integration.
4444
In order to identify such tests and avoid the continuous integration to fail, they are marked as _flaky_ and must be annotated with the `@Flaky` annotation.
4545

4646
> [!TIP]
47-
> In case your pull request checks failed due to some unexpected flaky tests, you can retry the continous integration pilepeline on CircleCI using the `Rerun workflow from failed` button:
48-
49-
![Rerun workflow from failed](how_to_test/rerun-workflow-from-failed.png)
47+
> In case your pull request checks failed due to some unexpected flaky tests, you can retry the continuous
48+
> integration pipeline on Gitlab
49+
> * using the `Run again` button from the pipeline view:
50+
> ![Re run workflow from failed](how_to_test/run-again-job.png)
51+
> * using the `Retry` button from the job view:
52+
> ![Rerun workflow from failed](how_to_test/retry-failed-job.png)
5053
5154
## Running Tests
5255

@@ -71,7 +74,7 @@ To run tests on a different JVM than the one used for doing the build, you need
7174
7275
### Running System Tests
7376

74-
The system tests are setup to run on continous integration as pull request check.
77+
The system tests are setup to run on continuous integration as pull request check.
7578

7679
If you would like to run them locally, you would have to grab [a local copy of the system tests](https://github.com/DataDog/system-tests), and run them from there.
7780
You can make them use your development version of `dd-trace-java` by [dropping the built artifacts to the `/binaries` folder](https://github.com/DataDog/system-tests/blob/main/docs/execute/binaries.md#java-library) of your local copy of the system tests.
@@ -84,9 +87,10 @@ The APM test agent emulates the APM endpoints of the Datadog Agent.
8487
The APM Test Agent container runs alongside Java tracer Instrumentation Tests in CI,
8588
handling all traces during test runs and performing a number of `Trace Checks`.
8689
Trace Check results are returned within the `Get APM Test Agent Trace Check Results` step for all instrumentation test jobs.
87-
Check [trace invariant checks](https://github.com/DataDog/dd-apm-test-agent#trace-invariant-checks) for more informations.
90+
Check [trace invariant checks](https://github.com/DataDog/dd-apm-test-agent#trace-invariant-checks) for more information.
8891

8992
The APM Test Agent also emits helpful logging, including logging received traces' headers, spans, errors encountered,
90-
ands information on trace checks being performed.
91-
Logs can be viewed in CircleCI within the Test-Agent container step for all instrumentation test suites, ie: `z_test_8_inst` job.
93+
ands information on trace checks being performed.
94+
95+
Logs can be viewed in GitLab within the Test-Agent container step for all instrumentation test suites, e.g. the `test_inst` jobs.
9296
Read more about [the APM Test Agent](https://github.com/datadog/dd-apm-test-agent#readme).
-29.9 KB
Binary file not shown.
25.3 KB
Loading

docs/how_to_test/run-again-job.png

67.5 KB
Loading

gradle/configure_tests.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ def forkedTestLimit = gradle.sharedServices.registerIfAbsent("forkedTestLimit",
2323
maxParallelUsages = 3
2424
}
2525

26-
// Force timeout after 9 minutes (CircleCI defaults will fail after 10 minutes without output)
26+
// Force timeout after 9 minutes (The timeout is configurable per job, default job timeout is 1h)
2727
def testTimeoutDuration = Duration.of(9, ChronoUnit.MINUTES)
2828

2929
testing {

0 commit comments

Comments
 (0)