From 20a522477bf8bf7ebdc6a90bbe728f4931fed815 Mon Sep 17 00:00:00 2001 From: Greg Turnquist Date: Mon, 10 Jun 2019 18:04:21 -0500 Subject: [PATCH] DATACOUCH-456 - Introduce Jenkins CI. --- Jenkinsfile | 87 +++++++++++++++++++++ README.md => README.adoc | 159 +++++++++++++++++++++++++-------------- ci/build.sh | 15 ---- ci/build.yml | 20 ----- ci/test.sh | 11 --- ci/test.yml | 20 ----- pom.xml | 72 ++++++++++++++---- 7 files changed, 246 insertions(+), 138 deletions(-) create mode 100644 Jenkinsfile rename README.md => README.adoc (63%) delete mode 100755 ci/build.sh delete mode 100644 ci/build.yml delete mode 100755 ci/test.sh delete mode 100644 ci/test.yml diff --git a/Jenkinsfile b/Jenkinsfile new file mode 100644 index 00000000..9309b631 --- /dev/null +++ b/Jenkinsfile @@ -0,0 +1,87 @@ +pipeline { + agent none + + triggers { + pollSCM 'H/10 * * * *' + upstream(upstreamProjects: "spring-data-commons/master", threshold: hudson.model.Result.SUCCESS) + } + + options { + disableConcurrentBuilds() + } + + stages { + stage("Test") { + parallel { + stage("test: baseline") { + agent { + docker { + image 'adoptopenjdk/openjdk8:latest' + args '-u root -v /var/run/docker.sock:/var/run/docker.sock' // root but with no maven caching + } + } + steps { + sh "./mvnw -Pci clean dependency:list test -Dsort -Dbundlor.enabled=false -B" + sh "chown -R 1001:1001 target" + } + } + } + } + + stage('Release to artifactory') { + when { + branch 'issue/*' + } + agent { + docker { + image 'adoptopenjdk/openjdk8:latest' + args '-v $HOME/.m2:/root/.m2' + } + } + + environment { + ARTIFACTORY = credentials('02bd1690-b54f-4c9f-819d-a77cb7a9822c') + } + + steps { + sh "./mvnw -Pci,snapshot deploy -Dmaven.test.skip=true -B" + } + } + + stage('Release to artifactory with docs') { + when { + branch 'master' + } + agent { + docker { + image 'adoptopenjdk/openjdk8:latest' + args '-v $HOME/.m2:/root/.m2' + } + } + + environment { + ARTIFACTORY = credentials('02bd1690-b54f-4c9f-819d-a77cb7a9822c') + } + + steps { + sh "./mvnw -Pci,snapshot deploy -Dmaven.test.skip=true -B" + } + } + } + + post { + changed { + script { + slackSend( + color: (currentBuild.currentResult == 'SUCCESS') ? 'good' : 'danger', + channel: '#spring-data-dev', + message: "${currentBuild.fullDisplayName} - `${currentBuild.currentResult}`\n${env.BUILD_URL}") + emailext( + subject: "[${currentBuild.fullDisplayName}] ${currentBuild.currentResult}", + mimeType: 'text/html', + recipientProviders: [[$class: 'CulpritsRecipientProvider'], [$class: 'RequesterRecipientProvider']], + body: "${currentBuild.fullDisplayName} is reported as ${currentBuild.currentResult}") + } + } + } +} diff --git a/README.md b/README.adoc similarity index 63% rename from README.md rename to README.adoc index 4575cc1b..10f76ba1 100644 --- a/README.md +++ b/README.adoc @@ -1,7 +1,15 @@ -[![Spring Data Couchbase](https://spring.io/badges/spring-data-couchbase/ga.svg)](https://projects.spring.io/spring-data-couchbase#quick-start) -[![Spring Data Couchbase](https://spring.io/badges/spring-data-couchbase/snapshot.svg)](https://projects.spring.io/spring-data-couchbase#quick-start) +image:https://spring.io/badges/spring-data-couchbase/ga.svg[Spring Data Couchbase,link=https://projects.spring.io/spring-data-couchbase#quick-start] +image:https://spring.io/badges/spring-data-couchbase/snapshot.svg[Spring Data Couchbase,link=https://projects.spring.io/spring-data-couchbase#quick-start] + +image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-couchbase%2Fmaster&subject=Moore%20(master)["Spring Data Couchbase", link="https://jenkins.spring +.io/view/SpringData/job/spring-data-couchbase/"] +image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-couchbase%2F3.1.x&subject=Lovelace%20(3.1.x)["Spring Data Couchbase", link="https://jenkins.spring +.io/view/SpringData/job/spring-data-couchbase/"] +image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-couchbase%2F2.2.x&subject=Ingalls%20(2.2.x)["Spring Data Couchbase", link="https://jenkins.spring +.io/view/SpringData/job/spring-data-couchbase/"] + += Spring Data Couchbase 3.0.x -# Spring Data Couchbase 3.0.x `Spring-Data Couchbase 3.0.x` is the Spring Data connector for the `Couchbase Java SDK 2.x` generation. Both the SDK and this Spring Data community project are major version changes with lots of differences from their @@ -9,9 +17,9 @@ respective previous versions. Notably, this version is compatible with `Couchbase Server 4.0`, bringing support for the `N1QL` query language. -# Spring Data Couchbase += Spring Data Couchbase -The primary goal of the [Spring Data](https://www.springsource.org/spring-data) project is to make it easier to build +The primary goal of the https://www.springsource.org/spring-data[Spring Data] project is to make it easier to build Spring-powered applications that use new data access technologies such as non-relational databases, map-reduce frameworks, and cloud based data services. @@ -24,38 +32,39 @@ Integration tests require a couchbase server with a bucket name "protected" with If the server allows users, then an user with username "protected" with "password" as the password should also be set. The recommended way to run tests is to install docker and use container in server.properties. -## Getting Help +== Getting Help For a comprehensive treatment of all the Spring Data Couchbase features, please refer to: -* the [User Guide](https://docs.spring.io/spring-data/couchbase/docs/current/reference/html/) for the current GA version. -* the [JavaDocs](https://docs.spring.io/spring-data/couchbase/docs/current/api/) have extensive comments - in them as well. -* for more detailed questions, use the [StackOverflow `spring-data-couchbase` tag](https://stackoverflow.com/questions/tagged/spring-data-couchbase) -or Couchbase's own [forums](https://forums.couchbase.com/c/java-sdk). +* the https://docs.spring.io/spring-data/couchbase/docs/current/reference/html/[User Guide] for the current GA version. +* the https://docs.spring.io/spring-data/couchbase/docs/current/api/[JavaDocs] have extensive comments + in them as well. +* for more detailed questions, use the https://stackoverflow.com/questions/tagged/spring-data-couchbase[StackOverflow `spring-data-couchbase` tag] +or Couchbase's own https://forums.couchbase.com/c/java-sdk[forums]. If you are new to Spring as well as to Spring Data, look for information about -[Spring projects](https://www.springsource.org/projects). +https://www.springsource.org/projects[Spring projects]. +== Quick Start -## Quick Start - -### Maven configuration +=== Maven configuration Add the Maven dependency: -```xml +[source,xml] +---- org.springframework.data spring-data-couchbase ${version}.RELEASE -``` +---- If you'd rather like the latest snapshots of the upcoming major version, use our Maven snapshot repository and declare the appropriate dependency version. -```xml +[source,xml] +---- org.springframework.data spring-data-couchbase @@ -67,17 +76,17 @@ the appropriate dependency version. Spring Snapshot Repository https://repo.spring.io/libs-snapshot -``` +---- -### CouchbaseTemplate +=== CouchbaseTemplate CouchbaseTemplate is the central support class for Couchbase database operations. It provides: * Basic POJO mapping support to and from JSON (by default through Jackson) * Convenience methods to interact with the store (insert object, update objects) and Couchbase specific ones -* Exception translation into Spring's [technology agnostic DAO exception hierarchy](https://docs.spring.io/spring/docs/current/spring-framework-reference/html/dao.html#dao-exceptions). +* Exception translation into Spring's https://docs.spring.io/spring/docs/current/spring-framework-reference/html/dao.html#dao-exceptions[technology agnostic DAO exception hierarchy]. -### Spring Data Repositories +=== Spring Data Repositories To simplify the creation of data repositories Spring Data Couchbase provides a generic repository programming model. It will automatically create a repository proxy for you that adds implementations of finder methods you specify on an @@ -85,7 +94,8 @@ interface. To create a repository on top of a `UserInfo` entity, all you need to write is: -```java +[source,java] +---- public interface UserRepository extends CrudRepository { /** @@ -106,7 +116,7 @@ public interface UserRepository extends CrudRepository { List findByFirstnameContains(String word); } -``` +---- Once you get a reference to that repository bean, you'll find a lot of methods that make it very easy to work with this entity. In addition to the ones provided through the `CrudRepository`, you can add your own methods as well. @@ -114,7 +124,8 @@ entity. In addition to the ones provided through the `CrudRepository`, you can a In general, every CRUD method that does not depend on a single key (like `findById`) needs a backing View, `all` on the server side (the design document is by default expected to be the uncapitalized name of the entity, like `userInfo`). -## Custom Repository Methods and Views +== Custom Repository Methods and Views + Finder methods you define, if annotated with `@View`, also are backed by views. Either you want to return all items from these views and you can let the method name reflect the view name (like in `findAdults()`, where it'll expect an `adults` view), or provide simple criteria (you explicitly specify the `viewName` and let the method name determine your @@ -126,13 +137,14 @@ production before accessing it. This is an example view for the `findByLastname` method: -```javascript +[source,javascript] +---- function (doc, meta) { if(doc._class == "com.example.entity.UserInfo" && doc.lastname) { emit(doc.lastname, null); } } -``` +---- If you want to use more query parameters than what is supported through query derivation (see `ViewQueryCreator`), you need to provide the implementation of the finder methods yourself and use the underlying `CouchbaseTemplate`. @@ -140,25 +152,28 @@ need to provide the implementation of the finder methods yourself and use the un The `all` view that backs CRUD `findAll()` and `count()` needs to look like this (and do not forget the `_count` reduce function): -```javascript +[source,javascript] +---- function (doc, meta) { if(doc._class == "com.example.entity.UserInfo") { emit(null, null); } } -``` +---- Alternatively, if view creation isn't too costly, you can ask the framework to create it automatically by annotating the -repository with `@ViewIndexed(designDoc = "userInfo", viewName = "all")`. +repository with `@ViewIndexed(designDoc = "userInfo", viewName = "all")`. + +== N1QL and Query Derivation -## N1QL and Query Derivation With the introduction of `N1QL`, Couchbase can now better support query derivation (the mechanism that allows you to add custom methods that will automatically be implemented as a N1QL query derived from the method's name). This is the default repository query mechanism, so the associated `@Query` annotation is optional. Here is what it looks like: -```java +[source,java] +---- public interface UserRepository extends CrudRepository { /** @@ -167,37 +182,40 @@ public interface UserRepository extends CrudRepository { @Query List findByLastnameEqualsIgnoreCaseAndFirstnameStartsWithAndIsAdultTrue(String lastName, String fnamePrefix); } -``` +---- -For instance, calling `find...("Locke", "J")` will get resolved to this N1QL WHERE clause (similar to SQL): +For instance, calling `find...("Locke", "J")` will get resolved to this N1QL WHERE clause (similar to SQL): -```sql +[source,sql] +---- ...WHERE LOWER(lastname) = LOWER("Locke") AND firstname LIKE "J%" AND isAdult = TRUE; -``` +---- You can alternatively write the statement yourself inside the `@Query` annotation, using the `$SELECT_ENTITY$` placeholder to make sure all necessary fields and metadata are selected by N1QL: -```java +[source,java] +---- @Query("$SELECT_ENTITY$ WHERE firstname LIKE "%ck%") List findPatrickAndJackAmongOthers(); @Query("$SELECT_ENTITY$ WHERE firstname LIKE $1") List findUsersWithTheirFirstnameLike(String likePattern); -``` +---- N1QL needs at least a generic purpose `N1QL primary index` to work with, and can make use of a more entity type-specific `N1QL secondary index`. You can create both automatically (provided you are confident this is not to much of a cost) by annotating a repository with `@N1qlPrimaryIndexed` and/or `@N1qlSecondaryIndexed`. -## Using The Repository +== Using The Repository Extending `CrudRepository` causes CRUD methods being pulled into the interface so that you can easily save and find single entities and collections of them. You can have Spring automatically create a proxy for the interface by using the following JavaConfig: -```java +[source,java] +---- @Configuration @EnableCouchbaseRepositories public class Config extends AbstractCouchbaseConfiguration { @@ -217,12 +235,13 @@ public class Config extends AbstractCouchbaseConfiguration { return ""; } } -``` +---- This sets up a connection to a Couchbase cluster and enables the detection of Spring Data repositories (through `@EnableCouchbaseRepositories`). The same configuration would look like this in XML: -```xml +[source,xml] +---- localhost @@ -232,11 +251,12 @@ This sets up a connection to a Couchbase cluster and enables the detection of Sp -``` +---- This will find the repository interface and register a proxy object in the container. You can use it as shown below: -```java +[source,java] +---- @Service public class MyService { @@ -258,23 +278,48 @@ public class MyService { List allJacksons = userRepository.findByLastname("Jackson"); } } -``` +---- +== Running CI tasks locally -## Contributing to Spring Data +Since this pipeline is purely Docker-based, it's easy to: + +* Debug what went wrong on your local machine. +* Test out a a tweak to your `test.sh` script before sending it out. +* Experiment against a new image before submitting your pull request. + +All of these use cases are great reasons to essentially run what the CI server does on your local machine. + +IMPORTANT: To do this you must have Docker installed on your machine. + +1. `docker run -it --mount type=bind,source="$(pwd)",target=/spring-data-couchbase-github -v /usr/bin/docker:/usr/bin/docker -v /var/run/docker.sock:/var/run/docker.sock adoptopenjdk/openjdk8:latest /bin/bash` ++ +This will launch the Docker image and mount your source code at `spring-data-couchbase-github`. ++ +2. `cd spring-data-couchbase-github` ++ +Next, test everything from inside the container: ++ +3. `./mvnw -Pci clean dependency:list test -Dsort -B` (or whatever test configuration you must use) + +Since the container is binding to your source, you can make edits from your IDE and continue to run build jobs. + +NOTE: Docker containers can eat up disk space fast! From time to time, run `docker system prune` to clean out old images. + +== Contributing to Spring Data Here are some ways for you to get involved in the community: -* Get involved with the Spring community on Stack Overflow. Please help out on the - [`spring-data`](https://stackoverflow.com/questions/tagged/spring-data) and - [`spring-data-couchbase`](https://stackoverflow.com/questions/tagged/spring-data-couchbase) tags by responding to - questions. -* Create [JIRA](https://jira.spring.io/browse/DATACOUCH) `DATACOUCH` tickets for bugs and new features and comment and - vote on the ones that you are interested in. +* Get involved with the Spring community on Stack Overflow. Please help out on the + https://stackoverflow.com/questions/tagged/spring-data[`spring-data`] and + https://stackoverflow.com/questions/tagged/spring-data-couchbase[`spring-data-couchbase`] tags by responding to + questions. +* Create https://jira.spring.io/browse/DATACOUCH[JIRA] `DATACOUCH` tickets for bugs and new features and comment and + vote on the ones that you are interested in. * Github is for social coding: if you want to write code, we encourage contributions through pull requests from - [forks of this repository](https://help.github.com/forking/). If you want to contribute code this way, please reference - a JIRA ticket as well covering the specific issue you are addressing. -* Watch for upcoming articles on Spring by [subscribing](https://assets.spring.io/drupal/node/feed.xml) to spring.io RSS feed. + https://help.github.com/forking/[forks of this repository]. If you want to contribute code this way, please reference + a JIRA ticket as well covering the specific issue you are addressing. +* Watch for upcoming articles on Spring by https://assets.spring.io/drupal/node/feed.xml[subscribing] to spring.io RSS feed. -Before we accept a non-trivial patch or pull request we will need you to [sign the Contributor License Agreement](https://cla.pivotal.io/sign/spring). Signing the contributor’s agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. If you forget to do so, you'll be reminded when you submit a pull request. Active contributors might be asked to join the core team, and given the ability -to merge pull requests. +Before we accept a non-trivial patch or pull request we will need you to https://cla.pivotal.io/sign/spring[sign the Contributor License Agreement]. Signing the contributor’s agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. If you forget to do so, you'll be reminded when you submit a pull request. Active contributors might be asked to join the core team, and given the ability +to merge pull requests. \ No newline at end of file diff --git a/ci/build.sh b/ci/build.sh deleted file mode 100755 index 72305877..00000000 --- a/ci/build.sh +++ /dev/null @@ -1,15 +0,0 @@ -#!/usr/bin/env sh - -set -euo pipefail - -[[ -d $PWD/maven && ! -d $HOME/.m2 ]] && ln -s $PWD/maven $HOME/.m2 - -spring_data_couchbase_artifactory=$(pwd)/spring-data-couchbase-artifactory - -rm -rf $HOME/.m2/repository/org/springframework/data 2> /dev/null || : - -cd spring-data-couchbase-github - -./mvnw deploy \ - -Dmaven.test.skip=true \ - -DaltDeploymentRepository=distribution::default::file://${spring_data_couchbase_artifactory} diff --git a/ci/build.yml b/ci/build.yml deleted file mode 100644 index bcd9bc9c..00000000 --- a/ci/build.yml +++ /dev/null @@ -1,20 +0,0 @@ ---- -platform: linux - -image_resource: - type: docker-image - source: - repository: openjdk - tag: 8-jdk-alpine - -inputs: -- name: spring-data-couchbase-github - -outputs: -- name: spring-data-couchbase-artifactory - -caches: -- path: maven - -run: - path: spring-data-couchbase-github/ci/build.sh diff --git a/ci/test.sh b/ci/test.sh deleted file mode 100755 index 84f8ca78..00000000 --- a/ci/test.sh +++ /dev/null @@ -1,11 +0,0 @@ -#!/usr/bin/env sh - -set -euo pipefail - -[[ -d $PWD/maven && ! -d $HOME/.m2 ]] && ln -s $PWD/maven $HOME/.m2 - -rm -rf $HOME/.m2/repository/org/springframework/data 2> /dev/null || : - -cd spring-data-couchbase-github - -./mvnw clean dependency:list test -P${PROFILE} -Dsort diff --git a/ci/test.yml b/ci/test.yml deleted file mode 100644 index 8c9c0429..00000000 --- a/ci/test.yml +++ /dev/null @@ -1,20 +0,0 @@ ---- -platform: linux - -image_resource: - type: docker-image - source: - repository: openjdk - tag: 8-jdk-alpine - -inputs: -- name: spring-data-couchbase-github - -outputs: -- name: spring-data-couchbase-artifactory - -caches: -- path: maven - -run: - path: spring-data-couchbase-github/ci/test.sh diff --git a/pom.xml b/pom.xml index f489a2aa..abd2bd13 100644 --- a/pom.xml +++ b/pom.xml @@ -1,5 +1,6 @@ - + 4.0.0 @@ -257,19 +258,60 @@ - - - release - - - - org.jfrog.buildinfo - artifactory-maven-plugin - false - - - - - + + + snapshot + + + + + org.jfrog.buildinfo + artifactory-maven-plugin + 2.6.1 + false + + + build-info + + publish + + + + {{BUILD_URL}} + + + spring-data-couchbase + spring-data-couchbase + false + *:*:*:*@zip + + + https://repo.spring.io + {{ARTIFACTORY_USR}} + {{ARTIFACTORY_PSW}} + libs-snapshot-local + libs-snapshot-local + + + + + + + + + + + release + + + + org.jfrog.buildinfo + artifactory-maven-plugin + false + + + + +