chore: Split long running integration tests and fast unit tests (DEV-1537) #2315

seakayone · 2022-11-30T14:02:19Z

Pull Request Checklist

Task Description/Number

Split tests into different source sets, so that long running integration tests are separated from faster unit tests.

Make sbt it run all tests from all sbt sub projects from the IntegrationTest configuration in sequence.

Make stb test run all tests from all sbt sub projects from the Test configuration in parallel.

Run integration and unit tests in parallel Github Action build jobs.

Move most tests to it source set and keep some zio-test unit tests in test source set.

Fix schema-core to run tests by adding zio-test-sbt to its dependencies.

Add documentation: README.md and internal docs.

Issue Number: DEV-1537

Basic Requirements

Please check if your PR fulfils the following requirements:

Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

Bugfix: represents bug fixes
Refactor: represents production code refactoring
Feature: represents a new feature
Documentation: documentation changes (no production code change)
Chore: maintenance tasks (no production code change)
Style: styles updates (no production code change)
Test: all about tests: adding, refactoring tests (no production code change)
Other... Please describe:

Does this PR introduce a breaking change?

Yes
No

Does this PR change client-test-data?

Yes (don't forget to update the JS-LIB team about the change)
No

codecov · 2022-12-01T13:16:15Z

Codecov Report

Base: 86.95% // Head: 85.89% // Decreases project coverage by -1.05% ⚠️

Coverage data is based on head (bed666e) compared to base (bfe578a).
Patch coverage: 15.78% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2315      +/-   ##
==========================================
- Coverage   86.95%   85.89%   -1.06%     
==========================================
  Files         242      235       -7     
  Lines       28102    27916     -186     
==========================================
- Hits        24435    23978     -457     
- Misses       3667     3938     +271

Impacted Files	Coverage Δ
...p-shared/src/main/scala/dsp/config/AppConfig.scala	`0.00% <0.00%> (ø)`
...shared/src/main/scala/dsp/util/UuidGenerator.scala	`0.00% <0.00%> (ø)`
...sp-shared/src/main/scala/dsp/valueobjects/Id.scala	`0.00% <0.00%> (-65.39%)`	⬇️
...-shared/src/main/scala/dsp/valueobjects/User.scala	`27.27% <15.38%> (-54.40%)`	⬇️
...src/main/scala/dsp/valueobjects/LanguageCode.scala	`75.00% <33.33%> (-25.00%)`	⬇️
...p-shared/src/main/scala/dsp/valueobjects/Iri.scala	`68.04% <66.66%> (-26.64%)`	⬇️
...-shared/src/main/scala/dsp/valueobjects/Role.scala	`0.00% <0.00%> (-100.00%)`	⬇️
...d/src/main/scala/dsp/valueobjects/LangString.scala	`31.57% <0.00%> (-68.43%)`	⬇️
...shared/src/main/scala/dsp/valueobjects/Group.scala	`60.00% <0.00%> (-40.00%)`	⬇️
... and 30 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

swarmia · 2022-12-01T13:47:47Z

✅ Linked to Story DEV-1537 · DSP-API: Separate long running integration tests from short running unit tests
➡️ Part of Epic DEV-1531 · C: Make running unit tests locally possible and improve long running tests duration in Github

No updates since 2018 https://mvnrepository.com/repos/hseeberger Bintray is closed since 2021 https://www.jfrog.com/confluence/display/BT sbt has moved on https://www.scala-sbt.org/1.x/docs/Bintray-For-Plugins.html // https://bintray.com/sbt

…cies add failing test in order to demonstrate above

* add 'make integration-test'

irinaschubert

LGTM

irinaschubert · 2022-12-02T13:39:23Z

build.sbt

@@ -27,7 +24,8 @@ lazy val aggregatedProjects: Seq[ProjectReference] = Seq(webapi, sipi)

 lazy val buildSettings = Seq(
  organization := "org.knora",
-  version      := (ThisBuild / version).value
+  version      := (ThisBuild / version).value,
+  javaOptions += "-Xmx2G"


just curious: did you finally manage to make sbt take this parameter and actually use 2GB?

The OOM exception did not occur anymore. I will remove this setting here.

docs/05-internals/development/testing.md

dsp-schema/core/src/test/scala/dsp/schema/domain/SchemaCommandsSpec.scala

irinaschubert · 2022-12-02T14:05:40Z

.../webapi/messages/v2/responder/ontologymessages/KnoraCardinalityInfoIsStricterThanZSpec.scala

@@ -1,13 +1,12 @@
-/*


I think it was decided that we should use this copyright header in all files. It was probably used inconsistently - but instead of deleting, you should probably add it where it is missing...

I agree, this should be automated though.

I guess that some build tool plugin could do this work for us.

https://github.com/sbt/sbt-header e.g.

sounds good :)

Co-authored-by: irinaschubert <irina.schubert@dasch.swiss>

…sSpec.scala Co-authored-by: irinaschubert <irina.schubert@dasch.swiss>

seakayone force-pushed the wip/improve-test-setup branch from 9b08243 to 0af5e8a Compare November 30, 2022 17:06

seakayone force-pushed the wip/improve-test-setup branch 3 times, most recently from 4ea0a7b to 3b369ef Compare December 1, 2022 14:59

seakayone changed the title ~~Wip/improve test setup~~ Split long running integration tests and fast unit tests Dec 1, 2022

seakayone force-pushed the wip/improve-test-setup branch from 3b369ef to 409bb76 Compare December 2, 2022 07:46

seakayone changed the title ~~Split long running integration tests and fast unit tests~~ chore: Split long running integration tests and fast unit tests (DEV-1537) Dec 2, 2022

seakayone added 21 commits December 2, 2022 10:46

remove unused import

c4ca95f

remove needless comment and comma

999ffa1

Clarify name for Sonatype resolver

688eeee

Split dependencies in test and integration test dependencies

ff000d3

make schema-core run the tests by adding zio-test-sbt to its dependen…

6a9b485

…cies add failing test in order to demonstrate above

Move AppConfigZSpec to it

688c6eb

Run integration-test in parrallel on github

46e9a95

* add 'make integration-test'

Swap it and test source set

697a8f5

Formatting

0c6c28d

rename intergration-test name in github action

c9433c7

Increase jvm heap space to 2G use G1GC gc

fcb0139

reoder sbt args

d05b9e5

Formatting

ffadd12

finetuning

b1db8e0

finetuning

38a356d

finetuning

93d174a

finetuning

c5f04ac

docu

6c52974

sbt it depends on a locally built sipi image

820ba18

docu

28c4485

seakayone added 3 commits December 2, 2022 10:46

Remove prototype tests

9c3529c

Move KnoraCardinalityInfoIsStricterThanZSpec to unit tests

a499317

Move unit tests to test source set

72047ef

seakayone force-pushed the wip/improve-test-setup branch from 409bb76 to 72047ef Compare December 2, 2022 09:54

seakayone added 7 commits December 2, 2022 11:07

Formatting

c661e7f

fixup! Move unit tests to test source set

8e5a389

Remove check from build and test as a dedicated check-formatting exists

ef5268e

Revert renaming build-and-test job

ad654cf

revert changes in CacheSerializationZSpec

c9d36fa

revert changes

f8e3d4c

Formatting

26afbc2

seakayone self-assigned this Dec 2, 2022

seakayone marked this pull request as ready for review December 2, 2022 11:58

seakayone requested review from mpro7, BalduinLandolt and irinaschubert December 2, 2022 11:58

irinaschubert approved these changes Dec 2, 2022

View reviewed changes

seakayone and others added 5 commits December 2, 2022 15:13

Update docs/05-internals/development/testing.md

94d4385

Co-authored-by: irinaschubert <irina.schubert@dasch.swiss>

Update docs/05-internals/development/testing.md

89887db

Co-authored-by: irinaschubert <irina.schubert@dasch.swiss>

Update dsp-schema/core/src/test/scala/dsp/schema/domain/SchemaCommand…

a8f28bb

…sSpec.scala Co-authored-by: irinaschubert <irina.schubert@dasch.swiss>

add missing copyright header to unit test files

d165f5f

Remove needless javaOptions

bed666e

seakayone merged commit 5b4d601 into main Dec 2, 2022

seakayone deleted the wip/improve-test-setup branch December 2, 2022 15:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Split long running integration tests and fast unit tests (DEV-1537) #2315

chore: Split long running integration tests and fast unit tests (DEV-1537) #2315

seakayone commented Nov 30, 2022 •

edited

codecov bot commented Dec 1, 2022 •

edited

swarmia bot commented Dec 1, 2022

irinaschubert left a comment

irinaschubert Dec 2, 2022

seakayone Dec 2, 2022

irinaschubert Dec 2, 2022

seakayone Dec 2, 2022

seakayone Dec 2, 2022 •

edited

seakayone Dec 2, 2022

irinaschubert Dec 2, 2022

seakayone Dec 2, 2022

chore: Split long running integration tests and fast unit tests (DEV-1537) #2315

chore: Split long running integration tests and fast unit tests (DEV-1537) #2315

Conversation

seakayone commented Nov 30, 2022 • edited

Pull Request Checklist

Task Description/Number

Basic Requirements

PR Type

Does this PR introduce a breaking change?

Does this PR change client-test-data?

codecov bot commented Dec 1, 2022 • edited

Codecov Report

swarmia bot commented Dec 1, 2022

irinaschubert left a comment

Choose a reason for hiding this comment

irinaschubert Dec 2, 2022

Choose a reason for hiding this comment

seakayone Dec 2, 2022

Choose a reason for hiding this comment

irinaschubert Dec 2, 2022

Choose a reason for hiding this comment

seakayone Dec 2, 2022

Choose a reason for hiding this comment

seakayone Dec 2, 2022 • edited

Choose a reason for hiding this comment

seakayone Dec 2, 2022

Choose a reason for hiding this comment

irinaschubert Dec 2, 2022

Choose a reason for hiding this comment

seakayone Dec 2, 2022

Choose a reason for hiding this comment

seakayone commented Nov 30, 2022 •

edited

codecov bot commented Dec 1, 2022 •

edited

seakayone Dec 2, 2022 •

edited