Feature/1204/247 api client [Spike]

[algattik]

What this PR changes/adds

Add generated REST client module, and use it system tests. Fix serialised classes that were not compatible with Swagger OpenAPI generator.

Why it does that

• Reduce the verbosity, and improve the clarity of system tests
• Ensure the scope of system tests is not integration testing of the controllers, that can be done in specific RestAssured tests
• Provide a client module in Maven that can be directly used by end users running on JVM
• Dogfood our OpenAPI definition (value shown by discrepancies discovered and fixed in this PR)

Further notes

Several classes needed to be updated as they used Jackson patterns that are not compatible with Swagger generator. That is, the OpenAPI definition was previously broken.

• Permission and Duty: stop using JsonTypeName. This type of JSON inheritance is only useful when the superclass is used in API. Here only subclasses are used in API, and Swagger generator does not handle this case. See https://github.com/swagger-api/swagger-core/issues/4181
• PolicyType stop using custom deserialisation code. This is not compatible with Swagger generator
• DataPlaneInstance and DataPlaneInstanceImpl: Added annotations so that Swagger generator detects JSON inheritance scenario.

Linked Issue(s)

247

Checklist

• [ ] added appropriate tests?
• [ ] performed checkstyle check locally?
• [ ] added/updated copyright headers?
• [ ] documented public classes/methods?
• [ ] added/updated relevant documentation?
• [ ] added relevant details to the changelog? (skip with label no-changelog)
• [ ] formatted title correctly? (take a look at the CONTRIBUTING and styleguide for details)

[github-actions[bot]]

Unit Test Results

     399 files  ±0       399 suites  ±0   11m 13s :stopwatch: -53s 12 164 tests ±0  12 140 :heavy_check_mark:  - 1  18 :zzz: ±0  6 :x: +1  12 223 runs  ±0  12 199 :heavy_check_mark:  - 1  18 :zzz: ±0  6 :x: +1 

For more details on these failures, see this check.

Results for commit 3019512a. ± Comparison against base commit 70271b5b.

:recycle: This comment has been updated with latest results.

[codecov-commenter]

Codecov Report

Merging #268 (3019512) into feature/1204-api-client (70271b5) will increase coverage by 0.01%. The diff coverage is 100.00%.

@@                     Coverage Diff                     @@
##           feature/1204-api-client     #268      +/-   ##
===========================================================
+ Coverage                    67.51%   67.53%   +0.01%     
===========================================================
  Files                          717      717              
  Lines                        15749    15738      -11     
  Branches                      1051     1049       -2     
===========================================================
- Hits                         10633    10628       -5     
+ Misses                        4633     4628       -5     
+ Partials                       483      482       -1     

Impacted Files	Coverage Δ
.../eclipse/dataspaceconnector/policy/model/Duty.java	92.85% <ø> (ø)
...se/dataspaceconnector/policy/model/Permission.java	93.10% <ø> (ø)
...clipse/dataspaceconnector/policy/model/Policy.java	81.33% <ø> (ø)
.../eclipse/dataspaceconnector/policy/model/Rule.java	100.00% <ø> (ø)
...plane/selector/instance/DataPlaneInstanceImpl.java	90.00% <ø> (ø)
...se/dataspaceconnector/policy/model/PolicyType.java	100.00% <100.00%> (+46.15%)	:arrow_up:

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 70271b5...3019512. Read the comment docs.