diff --git a/README.adoc b/README.adoc index 2212f52d..1988bda0 100644 --- a/README.adoc +++ b/README.adoc @@ -2,37 +2,43 @@ image::https://travis-ci.org/spring-cloud/spring-cloud-zookeeper.svg?branch=master[Build Status, link=https://travis-ci.org/spring-cloud/spring-cloud-zookeeper] -This project provides Zookeeper integrations for Spring Boot apps through autoconfiguration -and binding to the Spring Environment and other Spring programming model idioms. With a few -simple annotations you can quickly enable and configure the common patterns inside your -application and build large distributed systems with Zookeeper based components. The -patterns provided include Service Discovery and Configuration. -Intelligent Routing (Zuul) and Client Side Load Balancing (Ribbon), Circuit Breaker -(Hystrix) are provided by integration with Spring Cloud Netflix. - +This project provides Zookeeper integrations for Spring Boot applications through +autoconfiguration and binding to the Spring Environment and other Spring programming model +idioms. With a few annotations, you can quickly enable and configure the common patterns +inside your application and build large distributed systems with Zookeeper based +components. The provided patterns include Service Discovery and Configuration. Integration +with Spring Cloud Netflix provides Intelligent Routing (Zuul), Client Side Load Balancing +(Ribbon), and Circuit Breaker (Hystrix). == Zookeeper overview -"ZooKeeper is a centralized service for maintaining configuration information, naming, providing distributed synchronization, and providing group services." - -See the https://zookeeper.apache.org[Zookeeper site] for more information. Spring Cloud Zookeeper also builds on the https://curator.apache.org[Apache Curator] project which started life at Netflix. +ZooKeeper is a centralized service for maintaining configuration information, naming, +providing distributed synchronization, and providing group services. See the +https://zookeeper.apache.org[Zookeeper site] for more information. Spring Cloud Zookeeper +also builds on the https://curator.apache.org[Apache Curator] project, which started life +at Netflix. == Spring Cloud Zookeeper Features -* Spring Cloud `DiscoveryClient` implementation -** supports Ribbon and Zuul -* Zookeeper based `PropertySource` loaded during the 'bootstrap' phase. +Spring Cloud Zookeeper includes the following features: -== Running the sample +* Spring Cloud `DiscoveryClient` implementation (supports Ribbon and Zuul) +* Zookeeper-based `PropertySource` loaded during the 'bootstrap' phase -1. https://zookeeper.apache.org/doc/current/zookeeperStarted.html#sc_Download[Install zookeeper] (On a mac with homebrew `brew install zookeeper`). -2. https://zookeeper.apache.org/doc/current/zookeeperStarted.html#sc_InstallingSingleMode[Start zookeeper]. -3. https://zookeeper.apache.org/doc/current/zookeeperStarted.html#sc_ConnectingToZooKeeper[Verify zookeeper is running]. -4. Run `mvn --settings .settings.xml package` this will bring in the required spring cloud maven repositories and build -5. Run `java -jar spring-cloud-zookeeper-sample/target/spring-cloud-zookeeper-sample-1.2.0.BUILD-SNAPSHOT.jar` -6. Visit http://localhost:8080, verify that `{"serviceId":"testZookeeperApp","host":"","port":8080}` results -7. run `java -jar spring-cloud-zookeeper-sample/target/spring-cloud-zookeeper-sample-1.2.0.BUILD-SNAPSHOT.jar --server.port=8081` -8. visit http://localhost:8080 again, verify that `{"serviceId":"testZookeeperApp","host":"","port":8081}` eventually shows up in the results in a round robbin fashion (may take a minute or so). +== Running the Sample + +. https://zookeeper.apache.org/doc/current/zookeeperStarted.html#sc_Download[Install +zookeeper] (On a mac with homebrew, use `brew install zookeeper`). +. https://zookeeper.apache.org/doc/current/zookeeperStarted.html#sc_InstallingSingleMode[Start +zookeeper]. +. https://zookeeper.apache.org/doc/current/zookeeperStarted.html#sc_ConnectingToZooKeeper[Verify +zookeeper is running]. +. Run `mvn --settings .settings.xml package`. +Doing so brings in the required Spring Cloud Maven repositories and Build. +. Run `java -jar spring-cloud-zookeeper-sample/target/spring-cloud-zookeeper-sample-1.2.0.BUILD-SNAPSHOT.jar`. +. Visit http://localhost:8080 to verify that `{"serviceId":"testZookeeperApp","host":"","port":8080}` works. +. Run `java -jar spring-cloud-zookeeper-sample/target/spring-cloud-zookeeper-sample-1.2.0.BUILD-SNAPSHOT.jar --server.port=8081` +. Visit http://localhost:8080 again to verify that `{"serviceId":"testZookeeperApp","host":"","port":8081}` eventually shows up in the results in a round-robin fashion. (It may take a minute or so.) == Building @@ -71,7 +77,7 @@ credentials and you already have those. The projects that require middleware generally include a `docker-compose.yml`, so consider using -https://compose.docker.io/[Docker Compose] to run the middeware servers +https://docs.docker.com/compose/[Docker Compose] to run the middeware servers in Docker containers. See the README in the https://github.com/spring-cloud-samples/scripts[scripts demo repository] for specific instructions about the common cases of mongo, @@ -127,6 +133,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 @@ -170,4 +178,136 @@ added after the original pull request but before a merge. other target branch in the main project). * When writing a commit message please follow https://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). \ No newline at end of file + 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 +---- + +true <1> + true + <2> + true + <3> + + + + + <4> + io.spring.javaformat + spring-javaformat-maven-plugin + + <5> + org.apache.maven.plugins + maven-checkstyle-plugin + + + + + + <5> + org.apache.maven.plugins + maven-checkstyle-plugin + + + + +---- +<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 +---- + + + + + + +---- + +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. \ No newline at end of file diff --git a/docs/pom.xml b/docs/pom.xml index 081f83ef..23632b48 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -6,7 +6,7 @@ org.springframework.cloud spring-cloud-zookeeper - 2.0.2.BUILD-SNAPSHOT + 2.0.2.RELEASE spring-cloud-zookeeper-docs pom diff --git a/pom.xml b/pom.xml index 2b862a03..0a97e863 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ org.springframework.cloud spring-cloud-zookeeper - 2.0.2.BUILD-SNAPSHOT + 2.0.2.RELEASE pom Spring Cloud Zookeeper Spring Cloud Zookeeper @@ -14,7 +14,7 @@ org.springframework.cloud spring-cloud-build - 2.0.2.RELEASE + 2.0.6.RELEASE @@ -229,11 +229,11 @@ 2.17 - 2.0.4.RELEASE - 2.0.3.BUILD-SNAPSHOT - 2.0.3.BUILD-SNAPSHOT - 2.0.3.BUILD-SNAPSHOT - 2.0.3.BUILD-SNAPSHOT + 2.0.6.RELEASE + 2.0.4.RELEASE + 2.0.5.RELEASE + 2.0.4.RELEASE + 2.0.4.RELEASE diff --git a/spring-cloud-starter-zookeeper-all/pom.xml b/spring-cloud-starter-zookeeper-all/pom.xml index 686b9e6d..678e21fe 100644 --- a/spring-cloud-starter-zookeeper-all/pom.xml +++ b/spring-cloud-starter-zookeeper-all/pom.xml @@ -5,7 +5,7 @@ org.springframework.cloud spring-cloud-zookeeper - 2.0.2.BUILD-SNAPSHOT + 2.0.2.RELEASE .. spring-cloud-starter-zookeeper-all diff --git a/spring-cloud-starter-zookeeper-config/pom.xml b/spring-cloud-starter-zookeeper-config/pom.xml index cfa7c7a0..3999f292 100644 --- a/spring-cloud-starter-zookeeper-config/pom.xml +++ b/spring-cloud-starter-zookeeper-config/pom.xml @@ -5,7 +5,7 @@ org.springframework.cloud spring-cloud-zookeeper - 2.0.2.BUILD-SNAPSHOT + 2.0.2.RELEASE .. spring-cloud-starter-zookeeper-config diff --git a/spring-cloud-starter-zookeeper-discovery/pom.xml b/spring-cloud-starter-zookeeper-discovery/pom.xml index 844fb9c9..76ccc76c 100644 --- a/spring-cloud-starter-zookeeper-discovery/pom.xml +++ b/spring-cloud-starter-zookeeper-discovery/pom.xml @@ -6,7 +6,7 @@ org.springframework.cloud spring-cloud-zookeeper - 2.0.2.BUILD-SNAPSHOT + 2.0.2.RELEASE .. spring-cloud-starter-zookeeper-discovery diff --git a/spring-cloud-starter-zookeeper/pom.xml b/spring-cloud-starter-zookeeper/pom.xml index 98565c45..579f1b6c 100644 --- a/spring-cloud-starter-zookeeper/pom.xml +++ b/spring-cloud-starter-zookeeper/pom.xml @@ -5,7 +5,7 @@ org.springframework.cloud spring-cloud-zookeeper - 2.0.2.BUILD-SNAPSHOT + 2.0.2.RELEASE .. spring-cloud-starter-zookeeper diff --git a/spring-cloud-zookeeper-config/pom.xml b/spring-cloud-zookeeper-config/pom.xml index 30209412..e74caa7f 100644 --- a/spring-cloud-zookeeper-config/pom.xml +++ b/spring-cloud-zookeeper-config/pom.xml @@ -12,7 +12,7 @@ org.springframework.cloud spring-cloud-zookeeper - 2.0.2.BUILD-SNAPSHOT + 2.0.2.RELEASE .. diff --git a/spring-cloud-zookeeper-core/pom.xml b/spring-cloud-zookeeper-core/pom.xml index c5cab5f0..36240b97 100644 --- a/spring-cloud-zookeeper-core/pom.xml +++ b/spring-cloud-zookeeper-core/pom.xml @@ -12,7 +12,7 @@ org.springframework.cloud spring-cloud-zookeeper - 2.0.2.BUILD-SNAPSHOT + 2.0.2.RELEASE .. diff --git a/spring-cloud-zookeeper-dependencies/pom.xml b/spring-cloud-zookeeper-dependencies/pom.xml index dfdc3882..64f217d4 100644 --- a/spring-cloud-zookeeper-dependencies/pom.xml +++ b/spring-cloud-zookeeper-dependencies/pom.xml @@ -5,11 +5,11 @@ spring-cloud-dependencies-parent org.springframework.cloud - 2.0.2.BUILD-SNAPSHOT + 2.0.6.RELEASE spring-cloud-zookeeper-dependencies - 2.0.2.BUILD-SNAPSHOT + 2.0.2.RELEASE pom spring-cloud-zookeeper-dependencies Spring Cloud Zookeeper Dependencies diff --git a/spring-cloud-zookeeper-discovery/pom.xml b/spring-cloud-zookeeper-discovery/pom.xml index 72273be2..cf705d46 100644 --- a/spring-cloud-zookeeper-discovery/pom.xml +++ b/spring-cloud-zookeeper-discovery/pom.xml @@ -12,7 +12,7 @@ org.springframework.cloud spring-cloud-zookeeper - 2.0.2.BUILD-SNAPSHOT + 2.0.2.RELEASE .. diff --git a/spring-cloud-zookeeper-sample/pom.xml b/spring-cloud-zookeeper-sample/pom.xml index 2c012524..0e5263da 100644 --- a/spring-cloud-zookeeper-sample/pom.xml +++ b/spring-cloud-zookeeper-sample/pom.xml @@ -11,7 +11,7 @@ org.springframework.cloud spring-cloud-zookeeper - 2.0.2.BUILD-SNAPSHOT + 2.0.2.RELEASE ..