From 991045a292ad63d9838400762b11d016d4204d38 Mon Sep 17 00:00:00 2001 From: Ashley Frieze Date: Sun, 8 Nov 2020 19:56:55 +0000 Subject: [PATCH] Sanitise README and tests to help other contributors - fix minor typos - allow tests to pass when run in IntelliJ (avoid unrunnable test classes) - enhance info about building and running tests --- .gitignore | 2 ++ README.md | 12 ++++++------ .../systemlambda/RestoreSystemErrChecks.java | 2 +- .../systemlambda/RestoreSystemOutChecks.java | 2 +- 4 files changed, 10 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index 8643541..33cd2bd 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,4 @@ .flattened-pom.xml target +.idea +*.iml diff --git a/README.md b/README.md index 7c9bf33..2d55d6a 100644 --- a/README.md +++ b/README.md @@ -102,13 +102,13 @@ void execute_code_that_manipulates_system_properties( //code under test that reads properties (e.g. "some.property") or //modifies them. }); - + //Here the value of "some.property" is the same like before. //E.g. it is not set. } ``` - + ### System.out and System.err Command-line applications usually write to the console. If you write such @@ -322,11 +322,11 @@ simply have a question about System Lambda. ## Development Guide -System Lambda is build with [Maven](http://maven.apache.org/). If you -want to contribute code than +System Lambda is built with [Maven](http://maven.apache.org/) and must be +compiled under JDK8. If you want to contribute code then * Please write a test for your change. -* Ensure that you didn't break the build by running `mvnw test`. +* Ensure that you didn't break the build by running `mvnw clean verify -Dgpg.skip`. * Fork the repo and create a pull request. (See [Understanding the GitHub Flow](https://guides.github.com/introduction/flow/index.html)) The basic coding style is described in the @@ -334,7 +334,7 @@ The basic coding style is described in the System Lambda supports [GitHub Actions](https://help.github.com/en/actions) (Linux) and [AppVeyor](http://www.appveyor.com/) (Windows) for continuous -integration. Your pull request will be automatically build by both CI +integration. Your pull request will be automatically built by both CI servers. diff --git a/src/test/java/com/github/stefanbirkner/systemlambda/RestoreSystemErrChecks.java b/src/test/java/com/github/stefanbirkner/systemlambda/RestoreSystemErrChecks.java index 7fadb6c..ad0aa86 100644 --- a/src/test/java/com/github/stefanbirkner/systemlambda/RestoreSystemErrChecks.java +++ b/src/test/java/com/github/stefanbirkner/systemlambda/RestoreSystemErrChecks.java @@ -7,7 +7,7 @@ import static com.github.stefanbirkner.fishbowl.Fishbowl.ignoreException; import static org.assertj.core.api.Assertions.assertThat; -class RestoreSystemErrChecks { +abstract class RestoreSystemErrChecks { private final MethodUnderTest methodUnderTest; diff --git a/src/test/java/com/github/stefanbirkner/systemlambda/RestoreSystemOutChecks.java b/src/test/java/com/github/stefanbirkner/systemlambda/RestoreSystemOutChecks.java index b8b49c4..183b9e9 100644 --- a/src/test/java/com/github/stefanbirkner/systemlambda/RestoreSystemOutChecks.java +++ b/src/test/java/com/github/stefanbirkner/systemlambda/RestoreSystemOutChecks.java @@ -7,7 +7,7 @@ import static com.github.stefanbirkner.fishbowl.Fishbowl.ignoreException; import static org.assertj.core.api.Assertions.assertThat; -class RestoreSystemOutChecks { +abstract class RestoreSystemOutChecks { private final MethodUnderTest methodUnderTest;