Custom environment types by serhii-lekariev · Pull Request #539 · SpineEventEngine/base-libraries

serhii-lekariev · 2020-05-26T10:09:18Z

This PR extends the Environment API to allow the definition of custom environment types. It also migrates the current boolean test/not-a-test setup to a class-based solution.

To register a new environment type, define a custom one like so:

import io.spine.base.EnvironmentType;

public final class Local extends EnvironmentType {
        
         // ...

        @Override
         protected boolean enabled() {
            // Check an environment variable or a file.
         }

        public static Local type() {
        // Obtain the instance somehow. Encouraged to be a singleton instance.
        }
  }

Environment environment = Environment.instance();

// As the type is not registered yet.
assertThat(environment.is(Local.type)).isFalse();

Environment.register(Local.type());

// Assuming that "Local" is actually enabled
assertThat(environment.is(Local.type)).isTrue();
assertThat(environment.type()).isSameInstanceAs(Local.type());

When checking the environment types, user-defined types are checked first. If no type was found to be enabled, falls back to io.spine.base.Production.

Deprecation notes

The following methods are now deprecated in favor of the new API:

isTests: use is(Tests.type());;
setToTests: use setTo(Tests.type());;
isProduction: use is(Production.type());;
setToProduction: use setTo(Production.type());.

a boolean test/not-a-test. Instead, now it's an enum that the users can extend.

Related PR: #539.

codecov · 2020-05-26T10:22:42Z

Codecov Report

Merging #539 into master will increase coverage by 0.09%.
The diff coverage is 91.89%.

@@             Coverage Diff              @@
##             master     #539      +/-   ##
============================================
+ Coverage     73.71%   73.80%   +0.09%     
- Complexity     2936     2954      +18     
============================================
  Files           503      506       +3     
  Lines         11904    11954      +50     
  Branches        670      669       -1     
============================================
+ Hits           8775     8823      +48     
+ Misses         2905     2904       -1     
- Partials        224      227       +3

serhii-lekariev · 2020-05-26T10:32:38Z

@armiol, PTAL.

armiol

@serhii-lekariev please see my comments.

base/src/main/java/io/spine/base/BaseEnvironmentType.java

base/src/main/java/io/spine/base/EnvironmentType.java

Correct some docs errors.

Also update config.

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

serhii-lekariev · 2020-05-27T14:55:23Z

@armiol, PTAL again.

armiol

Please see my comments.

base/src/main/java/io/spine/base/BaseEnvironmentType.java

armiol · 2020-05-28T15:05:35Z

base/src/main/java/io/spine/base/Environment.java

 /**
 * Provides information about the environment (current platform used, etc.).
+ *
+ * <p><b>When extending, please note</b> that this class does not handle the situations when two


Let's rephrase in terms of the responsibitliy of the framework user. It's not that this class handles or does not handle any use cases. It just delegates the responsibility to tell between different PRODUCTION environments to the developer writing the code.

base/src/main/java/io/spine/base/Environment.java

base/src/main/java/io/spine/base/EnvironmentType.java

serhii-lekariev · 2020-05-29T10:13:35Z

@armiol, PTAL again.

armiol

@serhii-lekariev please see my comments.

armiol · 2020-05-30T16:47:13Z

base/src/test/java/io/spine/base/EnvironmentTest.java

@@ -159,15 +159,15 @@ void mutateKnownEnvTypesOnce() {
        @Test
        @DisplayName("throw if a user attempts to create register the same environment twice")
        void throwOnDoubleCreation() {


Is this a creation?

armiol · 2020-05-30T16:48:18Z

base/src/main/java/io/spine/base/Environment.java

- * {@link EnvironmentType#enabled()}. As such, if two or more user-defined environment types
- * think that they are currently enabled, <b>the behaviour of {@link #currentType()} is
- * undefined.</b>
+ * <p><b>When extending, please ensure</b> the mutual exclusivity on your {@code EnvironmentType}s.


This class cannot be extended. Please put a bit more into this thought.

base/src/main/java/io/spine/base/BaseEnvironmentType.java

serhii-lekariev · 2020-05-30T17:11:47Z

@armiol, PTAL again.

Shorten the `currentType()` to `type()` and un-mark the `register(type)` as `@Internal`.

base/src/main/java/io/spine/base/Environment.java

…rentType()` to make it simpler for the callers. Make `EnvironmentType` into an `abstract class` to ensure a more strict access level of the `active` method.

armiol

@serhii-lekariev mostly LGTM. Please see my comments.

armiol · 2020-06-03T13:52:56Z

base/src/main/java/io/spine/base/Production.java

+    /**
+     * Returns the singleton instance.
+     */
+    public static Production instance() {


Let's call it type().

Don't forget to update the code samples in the documentation.

armiol · 2020-06-03T13:56:01Z

base/src/main/java/io/spine/base/Environment.java

-                || stacktrace.contains("org.testng")) {
-            this.tests = true;
-            return true;
+    public boolean is(EnvironmentType type) {


Let's bring back isTests() and isProduction() and mark them @Deprecated in favor of ... .enabled().
It's a proper way of propagating the public API changes.

armiol · 2020-06-03T13:56:46Z

base/src/main/java/io/spine/base/Tests.java

+    /**
+     * Returns the singleton instance of this class.
+     */
+    public static Tests instance() {


Same as above.

… report.

serhii-lekariev · 2020-06-03T15:02:08Z

@armiol, PTAL again.

a concrete instance in hands.

serhii-lekariev added 5 commits May 26, 2020 12:23

Adjust the EnvironmentTests to no longer assume environments to be

f56e3ca

a boolean test/not-a-test. Instead, now it's an enum that the users can extend.

Introduce the environment-related API. Strip the Environment docs.

6e42cc5

Update the Environment Javadocs and the license report.

fc5a8d8

Add a method Javadoc sentence.

e1ab97e

Advance the version.

55daf08

Related PR: #539.

serhii-lekariev self-assigned this May 26, 2020

serhii-lekariev added 2 commits May 26, 2020 13:30

Fix documentation errors.

478b10e

Remove unnecessary parens.

53370c6

serhii-lekariev marked this pull request as ready for review May 26, 2020 10:32

serhii-lekariev requested a review from armiol May 26, 2020 10:32

armiol requested changes May 26, 2020

View reviewed changes

serhii-lekariev added 8 commits May 27, 2020 14:51

@Internalize a method.

a32ff87

Cut the EnvironmentType - it no longer can set the system to itself.

1cf44c2

Correct some docs errors.

Register environment types even if they are not enums.

a7131d8

Also update config.

Bump the version, regenerate the license report.

927978e

Fix method naming and documentation wording errors.

6897c5e

Fix formatting.

f17fe9c

Merge remote-tracking branch 'origin/master' into env-types

7d71ccb

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

license-report.md and pom.xml.

0333a69

serhii-lekariev requested a review from armiol May 27, 2020 14:55

armiol requested changes May 28, 2020

View reviewed changes

serhii-lekariev added 2 commits May 29, 2020 12:36

Fix documentation and wording errors.

27de43d

Clear the env variable, specify env type checking order.

5976b4d

serhii-lekariev requested a review from armiol May 29, 2020 10:13

armiol reviewed May 30, 2020

View reviewed changes

Reword a doc paragraph.

8c18656

serhii-lekariev added 3 commits May 30, 2020 20:06

Fix formatting and documentation wording.

340fd04

Fix test methods naming.

35f1262

Decrease test verbosity.

a838155

serhii-lekariev requested a review from armiol May 30, 2020 17:11

serhii-lekariev and others added 3 commits May 31, 2020 17:23

Rephrase the Environment class-level doc.

aaddbd4

Document the new functionality of Environment.

8a042f6

Shorten the `currentType()` to `type()` and un-mark the `register(type)` as `@Internal`.

Remove the redundant empty lines.

d97c603

serhii-lekariev commented Jun 1, 2020

View reviewed changes

base/src/main/java/io/spine/base/Environment.java Outdated Show resolved Hide resolved

base/src/main/java/io/spine/base/Environment.java Show resolved Hide resolved

serhii-lekariev added 2 commits June 3, 2020 16:09

Tweak the API of Environment: is(EnvironmentType) instead of `cur…

dc6705e

…rentType()` to make it simpler for the callers. Make `EnvironmentType` into an `abstract class` to ensure a more strict access level of the `active` method.

Fix documentation errors.

2ac7fcb

armiol requested changes Jun 3, 2020

View reviewed changes

serhii-lekariev added 3 commits June 3, 2020 17:29

instance() -> type() for default EnvironmentTypes. Also license…

bf9bc3f

… report.

Deprecate the old API.

16f571a

Correct documentation errors, test the @Deprecated methods.

a45855e

serhii-lekariev requested a review from armiol June 4, 2020 12:24

serhii-lekariev added 8 commits June 4, 2020 17:28

Add a doc sentence.

b9e9bb4

Deprecate the setToTests and setToProduction.

62926e1

Introduce a type method to check the current env type without having

e4cefb6

a concrete instance in hands.

Ensure correct access level.

2de3048

Add a test.

117a4e9

Fix doc errors.

1d8891e

Allow to register the same environment twice.

9858b0d

Correct a documentation error.

5cf0c03

armiol approved these changes Jun 4, 2020

View reviewed changes

serhii-lekariev merged commit 365385f into master Jun 4, 2020

serhii-lekariev deleted the env-types branch June 4, 2020 17:28

yuri-sergiichuk mentioned this pull request Aug 13, 2020

server lacks proper Custom Environments support SpineEventEngine/core-jvm#1291

Closed

dmitrykuzmin mentioned this pull request Sep 8, 2020

Release 1.6.0 #565

Merged

Conversation

serhii-lekariev commented May 26, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deprecation notes

Uh oh!

codecov bot commented May 26, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

serhii-lekariev commented May 26, 2020

Uh oh!

armiol left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

serhii-lekariev commented May 27, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

armiol left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

armiol May 28, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

serhii-lekariev commented May 29, 2020

Uh oh!

armiol left a comment

Choose a reason for hiding this comment

Uh oh!

armiol May 30, 2020

Choose a reason for hiding this comment

Uh oh!

armiol May 30, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

serhii-lekariev commented May 30, 2020

Uh oh!

Uh oh!

Uh oh!

armiol left a comment

Choose a reason for hiding this comment

Uh oh!

armiol Jun 3, 2020

Choose a reason for hiding this comment

Uh oh!

armiol Jun 3, 2020

Choose a reason for hiding this comment

Uh oh!

armiol Jun 3, 2020

Choose a reason for hiding this comment

Uh oh!

serhii-lekariev commented Jun 3, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

serhii-lekariev commented May 26, 2020 •

edited

Loading

codecov bot commented May 26, 2020 •

edited

Loading

serhii-lekariev commented May 27, 2020 •

edited

Loading