From be83591547aaa6c69038c2ae3fde6dfeb89609d3 Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Wed, 8 May 2019 13:13:37 +0200 Subject: [PATCH] Fixed the build and docs --- docs/pom.xml | 22 + pom.xml | 3 +- spring-cloud-info/pom.xml | 10 +- .../src/main/asciidoc/spring-cloud-info.adoc | 1 + .../static/docs/spring-cloud-info.html | 877 ++++++++++++++++++ spring-cloud-release-tools-core/pom.xml | 8 +- .../internal/git/GithubIssuesTests.java | 7 +- .../internal/git/GithubMilestonesTests.java | 6 +- .../post/PostReleaseActionsTests.java | 10 +- 9 files changed, 923 insertions(+), 21 deletions(-) create mode 100644 spring-cloud-info/src/main/asciidoc/spring-cloud-info.adoc create mode 100644 spring-cloud-info/src/main/resources/static/docs/spring-cloud-info.html diff --git a/docs/pom.xml b/docs/pom.xml index 7dde8e5f..0e7470a5 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -37,6 +37,28 @@ org.apache.maven.plugins maven-resources-plugin + true + + + copy-resources-for-global-docs + prepare-package + + copy-resources + + + + ${project.build.directory}/generated-docs + + + + + ${maven.multiModuleProjectDirectory}/spring-cloud-info/target/generated-docs + + + + + + org.asciidoctor diff --git a/pom.xml b/pom.xml index 5efc3e6d..bf5e65dd 100644 --- a/pom.xml +++ b/pom.xml @@ -18,14 +18,15 @@ - docs spring-cloud-release-tools-core spring-cloud-release-tools-spring spring-cloud-info + docs Hoxton.BUILD-SNAPSHOT + 1.0 diff --git a/spring-cloud-info/pom.xml b/spring-cloud-info/pom.xml index 1c612871..8ad41c1f 100644 --- a/spring-cloud-info/pom.xml +++ b/spring-cloud-info/pom.xml @@ -13,16 +13,12 @@ spring-cloud-info - 1.8 3.6.1 - 1.0 1.0 3.6.1 2.1.2.RELEASE - Greenwich.RELEASE - 1.5.3 + Greenwich.RELEASE 2.0.3.RELEASE - 2.7 @@ -87,7 +83,7 @@ org.springframework.cloud spring-cloud-dependencies - ${spring-cloud.version} + ${spring-cloud-bom.version} pom import @@ -130,7 +126,7 @@ ${maven-resources-plugin.version} - copy-resources + copy-resources-for-fatjar prepare-package copy-resources diff --git a/spring-cloud-info/src/main/asciidoc/spring-cloud-info.adoc b/spring-cloud-info/src/main/asciidoc/spring-cloud-info.adoc new file mode 100644 index 00000000..d1f39f96 --- /dev/null +++ b/spring-cloud-info/src/main/asciidoc/spring-cloud-info.adoc @@ -0,0 +1 @@ +include::index.adoc[] \ No newline at end of file diff --git a/spring-cloud-info/src/main/resources/static/docs/spring-cloud-info.html b/spring-cloud-info/src/main/resources/static/docs/spring-cloud-info.html new file mode 100644 index 00000000..0cfc2001 --- /dev/null +++ b/spring-cloud-info/src/main/resources/static/docs/spring-cloud-info.html @@ -0,0 +1,877 @@ + + + + + + + +Rest API + + + + + + + + + +
+
+

Spring Cloud Versions

+
+
+

Gets all the available Spring Cloud release trains.

+
+
+

cURL Request

+
+
+
$ curl 'http://spring-cloud-info.cfapps.io/springcloudversions' -i -X GET \
+    -H 'Accept: application/json'
+
+
+
+
+

HTTPie Request

+
+
+
$ http GET 'http://spring-cloud-info.cfapps.io/springcloudversions' \
+    'Accept:application/json'
+
+
+
+
+

HTTP Request

+
+
+
GET /springcloudversions HTTP/1.1
+Accept: application/json
+Host: spring-cloud-info.cfapps.io
+
+
+
+
+

Response

+
+
+
HTTP/1.1 200 OK
+Content-Length: 479
+Content-Type: application/json;charset=UTF-8
+
+["vGreenwich.SR1","vGreenwich.RELEASE","vGreenwich.RC2","vGreenwich.RC1","vGreenwich.M3","vGreenwich.M2","vGreenwich.M1","vFinchley.SR3","vFinchley.SR2","vFinchley.SR1","vFinchley.RELEASE","vFinchley.RC2","vFinchley.RC1","vFinchley.M9","vFinchley.M8","vFinchley.M7","vFinchley.M6","vFinchley.M5","vFinchley.M3","vFinchley.M2","vFinchley.M1","vEdgware.SR5","vEdgware.SR4","vEdgware.SR3","vEdgware.SR2","vEdgware.SR1","vEdgware.RELEASE","vEdgware.M1","vDalston.SR5","vDalston.SR4"]
+
+
+
+
+

Response Fields

+ +++++ + + + + + + + + + + + + + + +
PathTypeDescription

[]

Array

An array versions

+
+
+
+
+

Spring Cloud Version Given Spring Boot Version

+
+
+

Gets the Spring Cloud release train version given a Spring Boot version.

+
+
+

Path Parameters

+ + ++++ + + + + + + + + + + + + +
Table 1. /springcloudversion/{bootVersion}
ParameterDescription

bootVersion

The Spring Boot version

+
+
+

cURL Request

+
+
+
$ curl 'http://spring-cloud-info.cfapps.io/springcloudversion/2.1.1.RELEASE' -i -X GET \
+    -H 'Accept: application/json'
+
+
+
+
+

HTTPie Request

+
+
+
$ http GET 'http://spring-cloud-info.cfapps.io/springcloudversion/2.1.1.RELEASE' \
+    'Accept:application/json'
+
+
+
+
+

HTTP Request

+
+
+
GET /springcloudversion/2.1.1.RELEASE HTTP/1.1
+Accept: application/json
+Host: spring-cloud-info.cfapps.io
+
+
+
+
+

HTTP Response

+
+
+
HTTP/1.1 200 OK
+Content-Length: 31
+Content-Disposition: inline;filename=f.txt
+Content-Type: application/json;charset=UTF-8
+
+{"version":"Greenwich.RELEASE"}
+
+
+
+
+

Response Fields

+ +++++ + + + + + + + + + + + + + + +
PathTypeDescription

version

String

Spring Cloud version

+
+
+
+
+

Spring Cloud Project Versions

+
+
+

Get the Spring Cloud project versions for a given Spring Cloud release train.

+
+
+

cURL Request

+
+
+
$ curl 'http://spring-cloud-info.cfapps.io/bomversions/Finchley.SR1' -i -X GET \
+    -H 'Accept: application/json'
+
+
+
+
+

HTTPie Request

+
+
+
$ http GET 'http://spring-cloud-info.cfapps.io/bomversions/Finchley.SR1' \
+    'Accept:application/json'
+
+
+
+
+

HTTP Request

+
+
+
GET /bomversions/Finchley.SR1 HTTP/1.1
+Accept: application/json
+Host: spring-cloud-info.cfapps.io
+
+
+
+
+

HTTP Response

+
+
+
HTTP/1.1 200 OK
+Content-Length: 904
+Content-Disposition: inline;filename=f.txt
+Content-Type: application/json;charset=UTF-8
+
+{"spring-cloud-cloudfoundry":"2.2.0.BUILD-SNAPSHOT","spring-cloud-openfeign":"2.2.0.BUILD-SNAPSHOT","spring-cloud-task":"2.0.0.RELEASE","spring-cloud-security":"2.2.0.BUILD-SNAPSHOT","spring-cloud-zookeeper":"2.2.0.BUILD-SNAPSHOT","spring-cloud-config":"2.2.0.BUILD-SNAPSHOT","spring-cloud-function":"2.1.0.BUILD-SNAPSHOT","spring-cloud-netflix":"2.2.0.BUILD-SNAPSHOT","spring-cloud-vault":"2.2.0.BUILD-SNAPSHOT","spring-cloud-stream":"Germantown.BUILD-SNAPSHOT","spring-cloud-gcp":"1.1.0.BUILD-SNAPSHOT","spring-cloud-sleuth":"2.2.0.BUILD-SNAPSHOT","spring-cloud-kubernetes":"1.1.0.BUILD-SNAPSHOT","spring-cloud-commons":"2.2.0.BUILD-SNAPSHOT","spring-cloud-aws":"2.2.0.BUILD-SNAPSHOT","spring-cloud-contract":"2.2.0.BUILD-SNAPSHOT","spring-cloud-bus":"2.2.0.BUILD-SNAPSHOT","spring-cloud-gateway":"2.2.0.BUILD-SNAPSHOT","spring-boot":"2.2.0.BUILD-SNAPSHOT","spring-cloud-consul":"2.2.0.BUILD-SNAPSHOT"}
+
+
+
+
+
+
+

Upcoming Spring Cloud Releases

+
+
+

Gets all the upcoming Spring Cloud releases.

+
+
+

cURL Request

+
+
+
$ curl 'http://spring-cloud-info.cfapps.io/milestones' -i -X GET \
+    -H 'Accept: application/json'
+
+
+
+
+

HTTPie Request

+
+
+
$ http GET 'http://spring-cloud-info.cfapps.io/milestones' \
+    'Accept:application/json'
+
+
+
+
+

HTTP Request

+
+
+
GET /milestones HTTP/1.1
+Accept: application/json
+Host: spring-cloud-info.cfapps.io
+
+
+
+
+

HTTP Response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json;charset=UTF-8
+Content-Length: 57
+
+["Hoxton.RELEASE","Finchley.SR4","Hoxton.M1","Hoxton.M2"]
+
+
+
+
+
+
+

Get Spring Cloud Release Date

+
+
+

Gets the tentative date given an upcoming Spring Cloud release train name.

+
+
+

Path Parameters

+ + ++++ + + + + + + + + + + + + +
Table 2. /milestones/{release}/duedate
ParameterDescription

release

The Spring Cloud release train name

+
+
+

cURL Request

+
+
+
$ curl 'http://spring-cloud-info.cfapps.io/milestones/Hoxton.RELEASE/duedate' -i -X GET \
+    -H 'Accept: application/json'
+
+
+
+
+

HTTPie Request

+
+
+
$ http GET 'http://spring-cloud-info.cfapps.io/milestones/Hoxton.RELEASE/duedate' \
+    'Accept:application/json'
+
+
+
+
+

HTTP Request

+
+
+
GET /milestones/Hoxton.RELEASE/duedate HTTP/1.1
+Accept: application/json
+Host: spring-cloud-info.cfapps.io
+
+
+
+
+

HTTP Response

+
+
+
HTTP/1.1 200 OK
+Content-Type: application/json;charset=UTF-8
+Content-Length: 34
+
+{"dueDate":"2019-07-31T07:00:00Z"}
+
+
+
+
+

Response Fields

+ +++++ + + + + + + + + + + + + + + +
PathTypeDescription

dueDate

String

Spring Cloud milestone due date

+
+
+
+
+ + + \ No newline at end of file diff --git a/spring-cloud-release-tools-core/pom.xml b/spring-cloud-release-tools-core/pom.xml index 42a4d9f3..d8a5a63d 100644 --- a/spring-cloud-release-tools-core/pom.xml +++ b/spring-cloud-release-tools-core/pom.xml @@ -89,7 +89,7 @@ com.jcabi jcabi-github - 0.23 + ${jcabi-github.version} com.github.jknack @@ -111,6 +111,12 @@ spring-cloud-starter-contract-stub-runner test + + org.awaitility + awaitility + 3.1.6 + test + sagan diff --git a/spring-cloud-release-tools-core/src/test/java/org/springframework/cloud/release/internal/git/GithubIssuesTests.java b/spring-cloud-release-tools-core/src/test/java/org/springframework/cloud/release/internal/git/GithubIssuesTests.java index 3dcaef94..55d539ae 100644 --- a/spring-cloud-release-tools-core/src/test/java/org/springframework/cloud/release/internal/git/GithubIssuesTests.java +++ b/spring-cloud-release-tools-core/src/test/java/org/springframework/cloud/release/internal/git/GithubIssuesTests.java @@ -19,12 +19,11 @@ package org.springframework.cloud.release.internal.git; import java.io.IOException; import java.util.Collections; -import javax.json.Json; - import com.jcabi.github.Coordinates; import com.jcabi.github.Github; import com.jcabi.github.Issue; import com.jcabi.github.Repo; +import com.jcabi.github.Repos; import com.jcabi.github.mock.MkGithub; import org.junit.Before; import org.junit.Rule; @@ -123,8 +122,8 @@ public class GithubIssuesTests { } private Repo createGettingStartedGuides(MkGithub github) throws IOException { - return github.repos().create( - Json.createObjectBuilder().add("name", "getting-started-guides").build()); + return github.repos() + .create(new Repos.RepoCreate("getting-started-guides", false)); } private ProjectVersion nonGaSleuthProject() { diff --git a/spring-cloud-release-tools-core/src/test/java/org/springframework/cloud/release/internal/git/GithubMilestonesTests.java b/spring-cloud-release-tools-core/src/test/java/org/springframework/cloud/release/internal/git/GithubMilestonesTests.java index c291e0fd..49df2a7f 100644 --- a/spring-cloud-release-tools-core/src/test/java/org/springframework/cloud/release/internal/git/GithubMilestonesTests.java +++ b/spring-cloud-release-tools-core/src/test/java/org/springframework/cloud/release/internal/git/GithubMilestonesTests.java @@ -19,10 +19,9 @@ package org.springframework.cloud.release.internal.git; import java.io.IOException; import java.net.URL; -import javax.json.Json; - import com.jcabi.github.Milestone; import com.jcabi.github.Repo; +import com.jcabi.github.Repos; import com.jcabi.github.mock.MkGithub; import org.junit.Before; import org.junit.Rule; @@ -254,8 +253,7 @@ public class GithubMilestonesTests { } private Repo createSleuthRepo(MkGithub github) throws IOException { - return github.repos().create( - Json.createObjectBuilder().add("name", "spring-cloud-sleuth").build()); + return github.repos().create(new Repos.RepoCreate("spring-cloud-sleuth", false)); } @Test diff --git a/spring-cloud-release-tools-core/src/test/java/org/springframework/cloud/release/internal/post/PostReleaseActionsTests.java b/spring-cloud-release-tools-core/src/test/java/org/springframework/cloud/release/internal/post/PostReleaseActionsTests.java index 87bd0300..f1a9b8a5 100644 --- a/spring-cloud-release-tools-core/src/test/java/org/springframework/cloud/release/internal/post/PostReleaseActionsTests.java +++ b/spring-cloud-release-tools-core/src/test/java/org/springframework/cloud/release/internal/post/PostReleaseActionsTests.java @@ -26,10 +26,10 @@ import java.util.concurrent.atomic.AtomicReference; import org.apache.maven.model.Model; import org.assertj.core.api.BDDAssertions; +import org.awaitility.Awaitility; import org.eclipse.jgit.api.Git; import org.eclipse.jgit.revwalk.RevCommit; import org.junit.Before; -import org.junit.Ignore; import org.junit.Rule; import org.junit.Test; import org.junit.rules.TemporaryFolder; @@ -312,7 +312,6 @@ public class PostReleaseActionsTests { } @Test - @Ignore public void should_build_and_deploy_guides_when_switch_is_on() throws Exception { this.properties.getGit().setUpdateSpringGuides(true); String projects = this.temporaryFolder.getAbsolutePath(); @@ -336,8 +335,11 @@ public class PostReleaseActionsTests { actions.deployGuides(Collections .singletonList(new ProcessedProject(this.properties, projectVersion))); - BDDAssertions.then(projectBuilderStub.get()).isNotNull(); - BDDMockito.then(projectBuilderStub.get()).should().deployGuides(projectVersion); + Awaitility.await().untilAsserted(() -> { + BDDAssertions.then(projectBuilderStub.get()).isNotNull(); + BDDMockito.then(projectBuilderStub.get()).should() + .deployGuides(projectVersion); + }); } private String sleuthParentPomVersion() {