Make `BlackBox` provide a `Client` linked to the context under-the-test #1409

yevhenii-nadtochii · 2021-10-28T16:36:01Z

It's a migration of #1407 to the 2.x branch.

Problem

Previously, in scope of 2.x versions it was impossible to obtain a Client to some BlackBox context. That was a problem, since in a multi-Bounded-Context environment, the contexts often communicated with each other with the Clients. And the black-boxing of either clients made it very difficult to run the integration flow — as no proper Client could be created for the black-boxed Bounded Context.

Solution

It is now possible to create an in-process Client to any BlackBox:

BlackBox box = ...

// Creates the instance with the same `TenantId` as the one currently set in the `box`.
Client client = box.clients().withMatchingTenant();

// For multi-tenant Contexts only, it is also possible to create a `Client` with a specific tenant:
Client client = box.clients().create(myTenant);

The created Client instances are running through the in-process gRPC server. The lifecycle of this server is similar to the lifecycle of the associated BlackBox: once the box is closed, the server is closed as well.

Other Changes

The versions of the dependencies and the own version of core-java modules were set to the latest available.

…edContext`

codecov · 2021-10-28T16:48:54Z

Codecov Report

Merging #1409 (acfae46) into master (a3fe6f8) will increase coverage by 0.03%.
The diff coverage is 94.87%.

@@             Coverage Diff              @@
##             master    #1409      +/-   ##
============================================
+ Coverage     91.10%   91.13%   +0.03%     
- Complexity     4908     4929      +21     
============================================
  Files           626      628       +2     
  Lines         15342    15420      +78     
  Branches        890      893       +3     
============================================
+ Hits          13977    14053      +76     
+ Misses         1065     1064       -1     
- Partials        300      303       +3

# Conflicts: # license-report.md # pom.xml # version.gradle.kts

… `final`.

…more explicit manner.

armiol · 2021-11-15T17:12:22Z

@yevhenii-nadtochii PTAL. Should you have any comments, let's discuss them vocally.

yevhenii-nadtochii

Please see my questions

testutil-server/src/main/java/io/spine/testing/server/blackbox/BlackBoxClients.java

testutil-server/src/main/java/io/spine/testing/server/blackbox/BlackBox.java

dmdashenkov · 2021-11-16T13:50:42Z

testutil-server/src/main/java/io/spine/testing/server/blackbox/BlackBox.java

@@ -93,6 +94,11 @@
     */
    private final BoundedContext context;

+    /**
+     * A supplier of {@link Client}s which are linked to this context.


Suggested change

* A supplier of {@link Client}s which are linked to this context.

* A supplier of {@link Client}s which send requests to this context.

dmdashenkov · 2021-11-16T13:51:21Z

testutil-server/src/main/java/io/spine/testing/server/blackbox/BlackBox.java

+        if(!isOpen()) {
+            return;
+        }
+


Suggested change

if(!isOpen()) {

return;

}

if (!isOpen()) {

return;

}

dmdashenkov · 2021-11-16T13:52:37Z

testutil-server/src/main/java/io/spine/testing/server/blackbox/BlackBoxClients.java

+import static com.google.common.base.Preconditions.checkNotNull;
+
+/**
+ * Creates the {@link Client}s to a particular {@link BlackBox} instance.


Please check the grammar around articles here.
I'd expect:

Creates Clients for a ...

dmdashenkov · 2021-11-16T13:55:22Z

testutil-server/src/main/java/io/spine/testing/server/blackbox/ClientSupplier.java

+ * <p>As {@code Client} requires a gRPC server to be connected to, the supplier assembles
+ * and starts a {@link GrpcContainer}. The server and the created clients are working in-process.
+ */
+class ClientSupplier implements Closeable {


This should be called Clients so that it's coherent with the BlackBoxClients. Maybe, ClientFactory, but then the BlackBoxClients should also be renamed.

This type is too complicated to be a "supplier".

dmdashenkov

LGTM.

yevhenii.nadtochii added 5 commits October 28, 2021 18:37

Add static factory methods for grpc services based on a single `Bound…

fb11be2

…edContext`

Proofread javadoc

a1ac1f8

Implement tests for BlackBox.client()

ad1f66a

Create ClientSupplier and implement BlackBox.client()

e7d32ef

Bump the version

a791f9b

yevhenii-nadtochii changed the base branch from master to integration-broker-feature October 28, 2021 16:36

yevhenii-nadtochii marked this pull request as ready for review November 1, 2021 09:05

armiol self-requested a review November 1, 2021 13:39

armiol assigned yevhenii-nadtochii Nov 1, 2021

Base automatically changed from integration-broker-feature to master November 12, 2021 13:25

armiol added 2 commits November 12, 2021 16:35

Merge branch 'master' into black-box-feature

0f1ee8f

# Conflicts: # license-report.md # pom.xml # version.gradle.kts

Bump the version and update the license report files.

ec03714

armiol self-assigned this Nov 12, 2021

armiol removed their request for review November 12, 2021 14:51

armiol added 15 commits November 12, 2021 16:53

Ensure the passed Bounded Context instance isn't null.

35f0382

Reformat the documentation.

ab9e521

Document the mehtod.

8326156

Unify the "multi-tenant" spelling in scope of the type.

16ffa7e

Rename the field. Add more docs.

410f583

Simplify the docs.

92f7b6e

Give a more deterministic name to the started server.

908f00a

Clarify the working mode.

534e024

Shorten the number of API methods.

a4505c7

Mark the chainable builder methods as @CanIgnoreReturnValue.

6660981

Improve the wrapping.

ade0ef3

Suppress the warning.

e3c1e89

Suppress another warning.

951189a

Mark Client as final explicitly, since it was already effectively…

b640b80

… `final`.

Expose the functionality of creating Clients for BlackBoxes in a …

be2a5ed

…more explicit manner.

armiol changed the title ~~Make BlackBoxContext provide a Client linked to the context under the test~~ Make BlackBox provide a Client linked to the context under-the-test Nov 15, 2021

armiol added 7 commits November 15, 2021 18:57

Fix a typo.

0489461

Suppress the warnings.

e020f4a

Allow to ignore the return value if the call is not a part of any chain.

63dc0f6

Allow to ignore another return value.

fac2b80

Mark more methods with @CanIgnoreReturnValue.

c18caf6

Add a missing article.

b9ea772

Kill the redundant suppression.

32b95fb

armiol unassigned yevhenii-nadtochii Nov 15, 2021

armiol requested a review from a team November 15, 2021 17:12

yevhenii-nadtochii commented Nov 16, 2021

View reviewed changes

testutil-server/src/main/java/io/spine/testing/server/blackbox/BlackBoxClients.java Outdated Show resolved Hide resolved

testutil-server/src/main/java/io/spine/testing/server/blackbox/BlackBox.java Outdated Show resolved Hide resolved

dmdashenkov reviewed Nov 16, 2021

View reviewed changes

armiol added 6 commits November 16, 2021 15:57

Kill the redundant @throws clause.

3c960cd

Kill an excessive line.

21f6ca4

Rephrase the description.

ab1fe57

Format the expression.

bdd78bc

Rename ClientSupplier to ClientFactory.

83dcb64

Use a more appropriate preposition.

acfae46

dmdashenkov approved these changes Nov 16, 2021

View reviewed changes

armiol merged commit 894d7a8 into master Nov 16, 2021

armiol deleted the black-box-feature branch November 16, 2021 15:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Make `BlackBox` provide a `Client` linked to the context under-the-test #1409

Make `BlackBox` provide a `Client` linked to the context under-the-test #1409

Uh oh!

yevhenii-nadtochii commented Oct 28, 2021 •

edited by armiol

Loading

Uh oh!

codecov bot commented Oct 28, 2021 •

edited

Loading

Uh oh!

armiol commented Nov 15, 2021

Uh oh!

yevhenii-nadtochii left a comment

Uh oh!

Uh oh!

Uh oh!

dmdashenkov Nov 16, 2021

Uh oh!

dmdashenkov Nov 16, 2021

Uh oh!

dmdashenkov Nov 16, 2021

Uh oh!

dmdashenkov Nov 16, 2021

Uh oh!

dmdashenkov left a comment

Uh oh!

Uh oh!

	* A supplier of {@link Client}s which are linked to this context.
	* A supplier of {@link Client}s which send requests to this context.

Make BlackBox provide a Client linked to the context under-the-test #1409

Make BlackBox provide a Client linked to the context under-the-test #1409

Uh oh!

Conversation

yevhenii-nadtochii commented Oct 28, 2021 • edited by armiol Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Oct 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

armiol commented Nov 15, 2021

Uh oh!

yevhenii-nadtochii left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dmdashenkov Nov 16, 2021

Choose a reason for hiding this comment

Uh oh!

dmdashenkov Nov 16, 2021

Choose a reason for hiding this comment

Uh oh!

dmdashenkov Nov 16, 2021

Choose a reason for hiding this comment

Uh oh!

dmdashenkov Nov 16, 2021

Choose a reason for hiding this comment

Uh oh!

dmdashenkov left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Make `BlackBox` provide a `Client` linked to the context under-the-test #1409

Make `BlackBox` provide a `Client` linked to the context under-the-test #1409

yevhenii-nadtochii commented Oct 28, 2021 •

edited by armiol

Loading

codecov bot commented Oct 28, 2021 •

edited

Loading