SpringCloud/spring-cloud-vault
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix Checkstyle violations.

Browse Source 
Closes gh-290.
This commit is contained in:
Mark Paluch
2019-03-14 10:10:09 +01:00
parent 9541aa1b3e
commit 801eadbc66
14 changed files with 231 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

134
README.adoc
View File

@@ -383,6 +383,8 @@ from the `file` menu.
== Contributing
:spring-cloud-build-branch: master
Spring Cloud is released under the non-restrictive Apache 2.0 license,
and follows a very standard Github development process, using Github
tracker for issues and merging pull requests into master. If you want
@@ -427,3 +429,135 @@ added after the original pull request but before a merge.
* When writing a commit message please follow http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions],
if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit
message (where XXXX is the issue number).
=== Checkstyle
Spring Cloud Build comes with a set of checkstyle rules. You can find them in the `spring-cloud-build-tools` module. The most notable files under the module are:
.spring-cloud-build-tools/
----
└── src
   ├── checkstyle
   │   └── checkstyle-suppressions.xml <3>
   └── main
   └── resources
   ├── checkstyle-header.txt <2>
   └── checkstyle.xml <1>
----
<1> Default Checkstyle rules
<2> File header setup
<3> Default suppression rules
==== Checkstyle configuration
Checkstyle rules are *disabled by default*. To add checkstyle to your project just define the following properties and plugins.
.pom.xml
----
<properties>
<maven-checkstyle-plugin.failsOnError>true</maven-checkstyle-plugin.failsOnError> <1>
<maven-checkstyle-plugin.failsOnViolation>true
</maven-checkstyle-plugin.failsOnViolation> <2>
<maven-checkstyle-plugin.includeTestSourceDirectory>true
</maven-checkstyle-plugin.includeTestSourceDirectory> <3>
</properties>
<build>
<plugins>
<plugin> <4>
<groupId>io.spring.javaformat</groupId>
<artifactId>spring-javaformat-maven-plugin</artifactId>
</plugin>
<plugin> <5>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
</plugin>
</plugins>
<reporting>
<plugins>
<plugin> <5>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
</plugin>
</plugins>
</reporting>
</build>
----
<1> Fails the build upon Checkstyle errors
<2> Fails the build upon Checkstyle violations
<3> Checkstyle analyzes also the test sources
<4> Add the Spring Java Format plugin that will reformat your code to pass most of the Checkstyle formatting rules
<5> Add checkstyle plugin to your build and reporting phases
If you need to suppress some rules (e.g. line length needs to be longer), then it's enough for you to define a file under `${project.root}/src/checkstyle/checkstyle-suppressions.xml` with your suppressions. Example:
.projectRoot/src/checkstyle/checkstyle-suppresions.xml
----
<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
<suppressions>
<suppress files=".*ConfigServerApplication\.java" checks="HideUtilityClassConstructor"/>
<suppress files=".*ConfigClientWatch\.java" checks="LineLengthCheck"/>
</suppressions>
----
It's advisable to copy the `${spring-cloud-build.rootFolder}/.editorconfig` and `${spring-cloud-build.rootFolder}/.springformat` to your project. That way, some default formatting rules will be applied. You can do so by running this script:
```bash
$ curl https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/.editorconfig -o .editorconfig
$ touch .springformat
```
=== IDE setup
==== Intellij IDEA
In order to setup Intellij you should import our coding conventions, inspection profiles and set up the checkstyle plugin.
.spring-cloud-build-tools/
----
└── src
   ├── checkstyle
   │   └── checkstyle-suppressions.xml <3>
   └── main
   └── resources
   ├── checkstyle-header.txt <2>
   ├── checkstyle.xml <1>
   └── intellij
      ├── Intellij_Project_Defaults.xml <4>
      └── Intellij_Spring_Boot_Java_Conventions.xml <5>
----
<1> Default Checkstyle rules
<2> File header setup
<3> Default suppression rules
<4> Project defaults for Intellij that apply most of Checkstyle rules
<5> Project style conventions for Intellij that apply most of Checkstyle rules
.Code style
image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-code-style.png[Code style]
Go to `File` -> `Settings` -> `Editor` -> `Code style`. There click on the icon next to the `Scheme` section. There, click on the `Import Scheme` value and pick the `Intellij IDEA code style XML` option. Import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Spring_Boot_Java_Conventions.xml` file.
.Inspection profiles
image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-inspections.png[Code style]
Go to `File` -> `Settings` -> `Editor` -> `Inspections`. There click on the icon next to the `Profile` section. There, click on the `Import Profile` and import the `spring-cloud-build-tools/src/main/resources/intellij/Intellij_Project_Defaults.xml` file.
.Checkstyle
To have Intellij work with Checkstyle, you have to install the `Checkstyle` plugin. It's advisable to also install the `Assertions2Assertj` to automatically convert the JUnit assertions
image::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/{spring-cloud-build-branch}/docs/src/main/asciidoc/images/intellij-checkstyle.png[Checkstyle]
Go to `File` -> `Settings` -> `Other settings` -> `Checkstyle`. There click on the `+` icon in the `Configuration file` section. There, you'll have to define where the checkstyle rules should be picked from. In the image above, we've picked the rules from the cloned Spring Cloud Build repository. However, you can point to the Spring Cloud Build's GitHub repository (e.g. for the `checkstyle.xml` : `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle.xml`). We need to provide the following variables:
- `checkstyle.header.file` - please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/main/resources/checkstyle/checkstyle-header.txt` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle-header.txt` URL.
- `checkstyle.suppressions.file` - default suppressions. Please point it to the Spring Cloud Build's, `spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` file either in your cloned repo or via the `https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml` URL.
- `checkstyle.additional.suppressions.file` - this variable corresponds to suppressions in your local project. E.g. you're working on `spring-cloud-contract`. Then point to the `project-root/src/checkstyle/checkstyle-suppressions.xml` folder. Example for `spring-cloud-contract` would be: `/home/username/spring-cloud-contract/src/checkstyle/checkstyle-suppressions.xml`.
IMPORTANT: Remember to set the `Scan Scope` to `All sources` since we apply checkstyle rules for production and test sources.

16
spring-cloud-vault-config-aws/src/main/java/org/springframework/cloud/vault/config/aws/package-info.java
View File

@@ -1,3 +1,19 @@
/*
* Copyright 2018-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* AWS integration with Vault.
* @author Mark Paluch

16
spring-cloud-vault-config-consul/src/main/java/org/springframework/cloud/vault/config/consul/package-info.java
View File

@@ -1,3 +1,19 @@
/*
* Copyright 2018-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Consul integration with Vault.
* @author Mark Paluch

2
spring-cloud-vault-config-consul/src/test/java/org/springframework/cloud/vault/config/consul/VaultConfigConsulBootstrapConfigurationTests.java
View File

@@ -42,7 +42,7 @@ import static org.assertj.core.api.Assertions.assertThat;
@SpringBootTest(classes = CustomBootstrapConfiguration.class, properties = {
"VaultConfigConsulBootstrapConfigurationTests.custom.config=true",
"spring.cloud.vault.consul.role=foo", "spring.cloud.vault.consul.enabled=true",
"spring.cloud.consul.config.enabled=false", })
"spring.cloud.consul.config.enabled=false" })
public class VaultConfigConsulBootstrapConfigurationTests extends IntegrationTestSupport {
@Autowired

16
spring-cloud-vault-config-databases/src/main/java/org/springframework/cloud/vault/config/databases/package-info.java
View File

@@ -1,3 +1,19 @@
/*
* Copyright 2018-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Database integration with Vault.
* @author Mark Paluch

16
spring-cloud-vault-config-rabbitmq/src/main/java/org/springframework/cloud/vault/config/rabbitmq/package-info.java
View File

@@ -1,3 +1,19 @@
/*
* Copyright 2018-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* RabbitMQ integration with Vault.
* @author Mark Paluch

3
spring-cloud-vault-config/src/test/java/org/springframework/cloud/vault/config/ApplicationFailFastTests.java
View File

@@ -16,6 +16,7 @@
package org.springframework.cloud.vault.config;
import org.junit.Ignore;
import org.junit.Test;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@@ -30,6 +31,7 @@ import static org.junit.Assert.fail;
* @author Mark Paluch
*/
@SpringBootApplication
public class ApplicationFailFastTests {
@Test
@@ -61,6 +63,7 @@ public class ApplicationFailFastTests {
}
@Test
@Ignore("Fails because of method errors in Discovery health check")
public void contextLoadsWithoutFailFast() {
new SpringApplicationBuilder().sources(ApplicationFailFastTests.class).run(
"--server.port=0", "--spring.cloud.vault.failFast=false",

4
spring-cloud-vault-config/src/test/java/org/springframework/cloud/vault/config/ClientAuthenticationFactoryUnitTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2018 the original author or authors.
* Copyright 2018-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -27,7 +27,7 @@ import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
/**
* Unit tests for {@link }ClientAuthenticationFactory}.
* Unit tests for {@link ClientAuthenticationFactory}.
*
* @author Mark Paluch
*/

6
spring-cloud-vault-config/src/test/java/org/springframework/cloud/vault/config/DiscoveryClientVaultBootstrapConfigurationTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2018 the original author or authors.
* Copyright 2018-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -128,11 +128,11 @@ public class DiscoveryClientVaultBootstrapConfigurationTests {
private String serviceId;
public SimpleServiceInstance(URI uri) {
SimpleServiceInstance(URI uri) {
this.setUri(uri);
}
public void setUri(URI uri) {
void setUri(URI uri) {
this.uri = uri;
this.host = this.uri.getHost();
this.port = this.uri.getPort();

2
spring-cloud-vault-config/src/test/java/org/springframework/cloud/vault/config/ReactiveVaultOperationsTests.java
View File

@@ -47,7 +47,7 @@ import static org.assertj.core.api.Assertions.assertThat;
*/
@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = ReactiveVaultOperationsTests.TestApplication.class, properties = {
"spring.cloud.vault.host=foo", "spring.cloud.vault.uri=https://localhost:8200", })
"spring.cloud.vault.host=foo", "spring.cloud.vault.uri=https://localhost:8200" })
public class ReactiveVaultOperationsTests {
@Autowired

0
spring-cloud-vault-config/src/test/java/org/springframework/cloud/vault/config/VaultBootstrapPropertySourceConfigurationTests.java Normal file
View File

2
spring-cloud-vault-config/src/test/java/org/springframework/cloud/vault/config/VaultVersionedKvBackendConfigTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2018 the original author or authors.
* Copyright 2018-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.

18
spring-cloud-vault-config/src/test/java/org/springframework/cloud/vault/util/PrepareVault.java
View File

@@ -75,9 +75,9 @@ public class PrepareVault {
/**
* Create a token for the given {@code tokenId} and {@code policy}.
* @param tokenId
* @param policy
* @return
* @param tokenId the must not be {@literal null}.
* @param policy the must not be {@literal null}.
* @return the token.
*/
public VaultToken createToken(String tokenId, String policy) {
@@ -94,7 +94,7 @@ public class PrepareVault {
/**
* Check whether Vault is available (vault created and unsealed).
* @return
* @return whether Vault is available.
*/
public boolean isAvailable() {
return this.adminOperations.isInitialized()
@@ -103,7 +103,7 @@ public class PrepareVault {
/**
* Mount an auth backend.
* @param authBackend
* @param authBackend the must not be {@literal null}.
*/
public void mountAuth(String authBackend) {
@@ -114,8 +114,8 @@ public class PrepareVault {
/**
* Check whether a auth-backend is enabled.
* @param authBackend
* @return
* @param authBackend the must not be {@literal null}.
* @return whether the backend is mounted.
*/
public boolean hasAuth(String authBackend) {
@@ -152,8 +152,8 @@ public class PrepareVault {
/**
* Check whether a auth-backend is enabled.
* @param secretBackend
* @return
* @param secretBackend the must not be {@literal null}.
* @return whether the backend is mounted.
*/
public boolean hasSecretBackend(String secretBackend) {

26
spring-cloud-vault-config/src/test/java/org/springframework/cloud/vault/util/Version.java
View File

@@ -27,7 +27,7 @@ import org.springframework.util.StringUtils;
*
* @author Mark Paluch
*/
public class Version implements Comparable<Version> {
public final class Version implements Comparable<Version> {
private static final String VERSION_PARSE_ERROR = "Invalid version string! Could not parse segment %s within %s.";
@@ -64,11 +64,11 @@ public class Version implements Comparable<Version> {
/**
* Parses the given string representation of a version into a {@link Version} object.
* @param version must not be {@literal null} or empty.
* @return
* @return the version.
*/
public static Version parse(String version) {
Assert.hasText(version);
Assert.hasText(version, "Version must not be empty");
String[] parts = version.trim().split("\\.");
int[] intParts = new int[parts.length];
@@ -94,8 +94,8 @@ public class Version implements Comparable<Version> {
/**
* Returns whether the current {@link Version} is greater (newer) than the given one.
* @param version
* @return
* @param version must not be {@literal null}.
* @return comparison result.
*/
public boolean isGreaterThan(Version version) {
return compareTo(version) > 0;
@@ -104,8 +104,8 @@ public class Version implements Comparable<Version> {
/**
* Returns whether the current {@link Version} is greater (newer) or the same as the
* given one.
* @param version
* @return
* @param version must not be {@literal null}.
* @return comparison result.
*/
public boolean isGreaterThanOrEqualTo(Version version) {
return compareTo(version) >= 0;
@@ -113,8 +113,8 @@ public class Version implements Comparable<Version> {
/**
* Returns whether the current {@link Version} is the same as the given one.
* @param version
* @return
* @param version must not be {@literal null}.
* @return comparison result.
*/
public boolean is(Version version) {
return equals(version);
@@ -122,8 +122,8 @@ public class Version implements Comparable<Version> {
/**
* Returns whether the current {@link Version} is less (older) than the given one.
* @param version
* @return
* @param version must not be {@literal null}.
* @return comparison result.
*/
public boolean isLessThan(Version version) {
return compareTo(version) < 0;
@@ -132,8 +132,8 @@ public class Version implements Comparable<Version> {
/**
* Returns whether the current {@link Version} is less (older) or equal to the current
* one.
* @param version
* @return
* @param version must not be {@literal null}.
* @return comparison result.
*/
public boolean isLessThanOrEqualTo(Version version) {
return compareTo(version) <= 0;