Describe support type in generations endpoint

This commit provides the support for a particular generation. Besides,
the default support policy, a generation can be in extended support mode
(previously lastMinor), or with no support at all.

Closes gh-32

Author: snicoll

src/main/java/io/spring/projectapi/github/ProjectGeneration.java

@@ -24,6 +24,7 @@
 import com.fasterxml.jackson.annotation.JsonCreator.Mode;
 import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
 
 /**
  * Java representation of the {@code project generation} type as defined in
@@ -54,22 +55,22 @@ public static class Generation {
 		@JsonFormat(pattern = "yyyy-MM")
 		private final YearMonth initialRelease;
 
+		private final SupportType support;
+
 		@JsonFormat(pattern = "yyyy-MM")
 		private final YearMonth ossSupportEnd;
 
 		@JsonFormat(pattern = "yyyy-MM")
 		private final YearMonth enterpriseSupportEnd;
 
-		private final boolean lastMinor;
-
 		@JsonCreator(mode = Mode.PROPERTIES)
-		public Generation(String generation, YearMonth initialRelease, YearMonth ossSupportEnd,
-				YearMonth enterpriseSupportEnd, boolean lastMinor) {
+		public Generation(String generation, YearMonth initialRelease, SupportType support, YearMonth ossSupportEnd,
+				YearMonth enterpriseSupportEnd) {
 			this.generation = generation;
 			this.initialRelease = initialRelease;
+			this.support = (support != null) ? support : SupportType.DEFAULT;
 			this.ossSupportEnd = ossSupportEnd;
 			this.enterpriseSupportEnd = enterpriseSupportEnd;
-			this.lastMinor = lastMinor;
 		}
 
 		/**
@@ -88,6 +89,14 @@ public YearMonth getInitialRelease() {
 			return this.initialRelease;
 		}
 
+		/**
+		 * Return the {@link SupportType}.
+		 * @return the type of support
+		 */
+		public SupportType getSupport() {
+			return this.support;
+		}
+
 		/**
 		 * Return the end of the Open Source support or {@code null} if this generation
 		 * has no support.
@@ -106,9 +115,30 @@ public YearMonth getEnterpriseSupportEnd() {
 			return this.enterpriseSupportEnd;
 		}
 
-		public boolean isLastMinor() {
-			return this.lastMinor;
-		}
+	}
+
+	/**
+	 * Describe the type of support.
+	 */
+	public enum SupportType {
+
+		/**
+		 * Not supported.
+		 */
+		@JsonProperty("none")
+		NONE,
+
+		/**
+		 * Default support.
+		 */
+		@JsonProperty("default")
+		DEFAULT,
+
+		/**
+		 * Extended support.
+		 */
+		@JsonProperty("extended")
+		EXTENDED
 
 	}
 

src/main/java/io/spring/projectapi/web/generation/Generation.java

@@ -41,17 +41,20 @@ public class Generation {
 	@JsonFormat(pattern = "yyyy-MM-dd")
 	private final LocalDate initialReleaseDate;
 
+	private String support;
+
 	@JsonFormat(pattern = "yyyy-MM-dd")
 	private final LocalDate ossSupportEndDate;
 
 	@JsonFormat(pattern = "yyyy-MM-dd")
 	private final LocalDate commercialSupportEndDate;
 
 	@JsonCreator
-	public Generation(String name, YearMonth initialReleaseDate, YearMonth ossSupportEndDate,
+	public Generation(String name, YearMonth initialReleaseDate, String support, YearMonth ossSupportEndDate,
 			YearMonth commercialSupportEndDate) {
 		this.name = name;
 		this.initialReleaseDate = initialReleaseDate.atEndOfMonth();
+		this.support = support;
 		this.ossSupportEndDate = (ossSupportEndDate != null) ? ossSupportEndDate.atEndOfMonth() : null;
 		this.commercialSupportEndDate = (commercialSupportEndDate != null) ? commercialSupportEndDate.atEndOfMonth()
 				: null;
@@ -65,6 +68,10 @@ public LocalDate getInitialReleaseDate() {
 		return this.initialReleaseDate;
 	}
 
+	public String getSupport() {
+		return this.support;
+	}
+
 	public LocalDate getOssSupportEndDate() {
 		return this.ossSupportEndDate;
 	}

src/main/java/io/spring/projectapi/web/generation/GenerationsController.java

@@ -17,6 +17,7 @@
 package io.spring.projectapi.web.generation;
 
 import java.util.List;
+import java.util.Locale;
 
 import io.spring.projectapi.ProjectRepository;
 import io.spring.projectapi.github.ProjectGeneration;
@@ -56,11 +57,7 @@ public GenerationsController(ProjectRepository projectRepository) {
 	@GetMapping
 	public CollectionModel<EntityModel<Generation>> generations(@PathVariable String id) {
 		ProjectGeneration projectGeneration = this.projectRepository.getProjectGenerations(id);
-		String supportPolicy = this.projectRepository.getProjectSupportPolicy(id);
-		List<Generation> generations = projectGeneration.getGenerations()
-			.stream()
-			.map((generation) -> asGeneration(generation, supportPolicy))
-			.toList();
+		List<Generation> generations = projectGeneration.getGenerations().stream().map(this::asGeneration).toList();
 		CollectionModel<EntityModel<Generation>> model = CollectionModel
 			.of(generations.stream().map((generation) -> asModel(id, generation)).toList());
 		model.add(linkToProject(id));
@@ -70,11 +67,7 @@ public CollectionModel<EntityModel<Generation>> generations(@PathVariable String
 	@GetMapping("/{name}")
 	public EntityModel<Generation> generation(@PathVariable String id, @PathVariable String name) {
 		ProjectGeneration projectGeneration = this.projectRepository.getProjectGenerations(id);
-		String supportPolicy = this.projectRepository.getProjectSupportPolicy(id);
-		List<Generation> generations = projectGeneration.getGenerations()
-			.stream()
-			.map((generation) -> asGeneration(generation, supportPolicy))
-			.toList();
+		List<Generation> generations = projectGeneration.getGenerations().stream().map(this::asGeneration).toList();
 		Generation generation = generations.stream()
 			.filter((candidate) -> candidate.getName().equals(name))
 			.findFirst()
@@ -83,8 +76,9 @@ public EntityModel<Generation> generation(@PathVariable String id, @PathVariable
 		return asModel(id, generation);
 	}
 
-	private Generation asGeneration(ProjectGeneration.Generation generation, String supportPolicy) {
-		return new Generation(generation.getGeneration(), generation.getInitialRelease(), generation.getOssSupportEnd(),
+	private Generation asGeneration(ProjectGeneration.Generation generation) {
+		return new Generation(generation.getGeneration(), generation.getInitialRelease(),
+				generation.getSupport().name().toLowerCase(Locale.ROOT), generation.getOssSupportEnd(),
 				generation.getEnterpriseSupportEnd());
 	}
 

src/test/java/io/spring/projectapi/github/GithubProjectRepositoryTests.java

@@ -22,6 +22,7 @@
 import java.util.Map;
 
 import io.spring.projectapi.github.Project.Status;
+import io.spring.projectapi.github.ProjectGeneration.SupportType;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
@@ -150,9 +151,9 @@ private Map<String, Project> getProjects(String project) {
 
 	private Map<String, ProjectGeneration> getProjectSupports(String project) {
 		ProjectGeneration.Generation generation1 = new ProjectGeneration.Generation("2.2.x", YearMonth.parse("2020-02"),
-				null, null, false);
+				SupportType.NONE, null, null);
 		ProjectGeneration.Generation generation2 = new ProjectGeneration.Generation("2.3.x", YearMonth.parse("2021-02"),
-				null, null, false);
+				SupportType.NONE, null, null);
 		ProjectGeneration support = new ProjectGeneration(List.of(generation1, generation2));
 		return Map.of(project, support);
 	}

src/test/java/io/spring/projectapi/github/GithubQueriesTests.java

@@ -27,6 +27,7 @@
 import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 import com.fasterxml.jackson.module.paramnames.ParameterNamesModule;
 import io.spring.projectapi.github.Project.Status;
+import io.spring.projectapi.github.ProjectGeneration.SupportType;
 import org.hamcrest.text.MatchesPattern;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -209,9 +210,9 @@ private Map<String, Project> getProjects() {
 
 	private Map<String, ProjectGeneration> getProjectSupports() {
 		ProjectGeneration.Generation generation1 = new ProjectGeneration.Generation("2.2.x", YearMonth.parse("2020-02"),
-				null, null, false);
+				SupportType.NONE, null, null);
 		ProjectGeneration.Generation generation2 = new ProjectGeneration.Generation("2.3.x", YearMonth.parse("2021-02"),
-				null, null, false);
+				SupportType.NONE, null, null);
 		ProjectGeneration support = new ProjectGeneration(List.of(generation1, generation2));
 		return Map.of("spring-boot", support);
 	}

src/test/java/io/spring/projectapi/github/ProjectGenerationJsonTests.java

@@ -18,6 +18,7 @@
 
 import java.time.YearMonth;
 
+import io.spring.projectapi.github.ProjectGeneration.SupportType;
 import org.junit.jupiter.api.Test;
 
 import org.springframework.beans.factory.annotation.Autowired;
@@ -32,6 +33,7 @@
  *
  * @author Madhura Bhave
  * @author Phillip Webb
+ * @author Stephane Nicoll
  */
 @JsonTest
 @AutoConfigureWebClient
@@ -42,13 +44,27 @@ class ProjectGenerationJsonTests {
 
 	@Test
 	void readObjectReadsJson() throws Exception {
-		ProjectGeneration projectGeneration = this.json.readObject("project-generations.json");
-		assertThat(projectGeneration.getGenerations().get(0).getGeneration()).isEqualTo("1.5.x");
-		assertThat(projectGeneration.getGenerations().get(0).getInitialRelease()).isEqualTo(YearMonth.parse("2017-01"));
-		assertThat(projectGeneration.getGenerations().get(0).getOssSupportEnd()).isEqualTo(YearMonth.parse("2019-08"));
-		assertThat(projectGeneration.getGenerations().get(0).getEnterpriseSupportEnd())
-			.isEqualTo(YearMonth.parse("2020-11"));
-		assertThat(projectGeneration.getGenerations().get(0).isLastMinor()).isTrue();
+		ProjectGeneration projectGeneration = this.json.readObject("project-generations-content.json");
+		assertThat(projectGeneration.getGenerations()
+			.stream()
+			.filter((candidate) -> candidate.getGeneration().equals("1.5.x"))).singleElement()
+			.satisfies((generation) -> {
+				assertThat(generation.getGeneration()).isEqualTo("1.5.x");
+				assertThat(generation.getSupport()).isEqualTo(SupportType.DEFAULT);
+				assertThat(generation.getInitialRelease()).isEqualTo(YearMonth.parse("2017-01"));
+				assertThat(generation.getOssSupportEnd()).isEqualTo(YearMonth.parse("2019-08"));
+				assertThat(generation.getEnterpriseSupportEnd()).isEqualTo(YearMonth.parse("2020-11"));
+			});
+		assertThat(projectGeneration.getGenerations()
+			.stream()
+			.filter((candidate) -> candidate.getGeneration().equals("2.7.x"))).singleElement()
+			.satisfies((generation) -> {
+				assertThat(generation.getGeneration()).isEqualTo("2.7.x");
+				assertThat(generation.getSupport()).isEqualTo(SupportType.EXTENDED);
+				assertThat(generation.getInitialRelease()).isEqualTo(YearMonth.parse("2022-05"));
+				assertThat(generation.getOssSupportEnd()).isEqualTo(YearMonth.parse("2023-06"));
+				assertThat(generation.getEnterpriseSupportEnd()).isEqualTo(YearMonth.parse("2029-06"));
+			});
 	}
 
 }

src/test/java/io/spring/projectapi/web/generation/GenerationsControllerTests.java

@@ -23,6 +23,7 @@
 import io.spring.projectapi.ProjectRepository;
 import io.spring.projectapi.github.NoSuchGithubProjectException;
 import io.spring.projectapi.github.ProjectGeneration;
+import io.spring.projectapi.github.ProjectGeneration.SupportType;
 import io.spring.projectapi.test.WebApiTests;
 import org.junit.jupiter.api.Test;
 
@@ -75,6 +76,7 @@ void generationsReturnsGenerations() throws Exception {
 			.andExpect(jsonPath("$._embedded.generations.length()").value("3"))
 			.andExpect(generationJsonPath(0, "name").value("1.0.x"))
 			.andExpect(generationJsonPath(0, "initialReleaseDate").value("2015-03-31"))
+			.andExpect(generationJsonPath(0, "support").value("none"))
 			.andExpect(generationJsonPath(0, "ossSupportEndDate").doesNotExist())
 			.andExpect(generationJsonPath(0, "commercialSupportEndDate").doesNotExist())
 			.andExpect(generationJsonPath(0, "_links.self.href")
@@ -83,6 +85,7 @@ void generationsReturnsGenerations() throws Exception {
 
 			.andExpect(generationJsonPath(1, "name").value("2.2.x"))
 			.andExpect(generationJsonPath(1, "initialReleaseDate").value("2020-02-29"))
+			.andExpect(generationJsonPath(1, "support").value("extended"))
 			.andExpect(generationJsonPath(1, "ossSupportEndDate").value("2021-03-31"))
 			.andExpect(generationJsonPath(1, "commercialSupportEndDate").value("2021-03-31"))
 			.andExpect(generationJsonPath(1, "_links.self.href")
@@ -91,6 +94,7 @@ void generationsReturnsGenerations() throws Exception {
 
 			.andExpect(generationJsonPath(2, "name").value("2.1.x"))
 			.andExpect(generationJsonPath(2, "initialReleaseDate").value("2020-01-31"))
+			.andExpect(generationJsonPath(2, "support").value("default"))
 			.andExpect(generationJsonPath(2, "ossSupportEndDate").value("2021-03-31"))
 			.andExpect(generationJsonPath(2, "commercialSupportEndDate").value("2022-03-31"))
 			.andExpect(generationJsonPath(2, "_links.self.href")
@@ -133,18 +137,20 @@ void generationWhenNotFoundReturns404() throws Exception {
 
 	private ProjectGeneration getProjectGenerations() {
 		List<ProjectGeneration.Generation> generations = new ArrayList<>();
-		generations.add(new ProjectGeneration.Generation("1.0.x", YearMonth.parse("2015-03"), null, null, false));
-		generations.add(new ProjectGeneration.Generation("2.2.x", YearMonth.parse("2020-02"),
-				YearMonth.parse("2021-03"), YearMonth.parse("2021-03"), true));
-		generations.add(new ProjectGeneration.Generation("2.1.x", YearMonth.parse("2020-01"),
-				YearMonth.parse("2021-03"), YearMonth.parse("2022-03"), false));
+		generations
+			.add(new ProjectGeneration.Generation("1.0.x", YearMonth.parse("2015-03"), SupportType.NONE, null, null));
+		generations.add(new ProjectGeneration.Generation("2.2.x", YearMonth.parse("2020-02"), SupportType.EXTENDED,
+				YearMonth.parse("2021-03"), YearMonth.parse("2021-03")));
+		generations.add(new ProjectGeneration.Generation("2.1.x", YearMonth.parse("2020-01"), SupportType.DEFAULT,
+				YearMonth.parse("2021-03"), YearMonth.parse("2022-03")));
 		return new ProjectGeneration(generations);
 	}
 
 	FieldDescriptor[] generationPayload() {
 		return new FieldDescriptor[] { fieldWithPath("name").type(JsonFieldType.STRING).description("Generation Name"),
 				fieldWithPath("initialReleaseDate").type(JsonFieldType.STRING)
 					.description("Date of the first release for this Generation"),
+				fieldWithPath("support").type(JsonFieldType.STRING).description("Type of support"),
 				fieldWithPath("ossSupportEndDate").type(JsonFieldType.STRING)
 					.optional()
 					.description("End date of the OSS support"),

src/test/resources/io/spring/projectapi/github/project-generations-content.json

@@ -92,7 +92,7 @@
     {
       "generation": "2.7.x",
       "initialRelease": "2022-05",
-      "lastMinor": true,
+      "support": "extended",
       "ossSupportEnd": "2023-06",
       "enterpriseSupportEnd": "2029-06",
       "linkedGenerations": {
@@ -159,7 +159,7 @@
     {
       "generation": "3.5.x",
       "initialRelease": "2025-05",
-      "lastMinor": true,
+      "support": "extended",
       "ossSupportEnd": "2026-06",
       "enterpriseSupportEnd": "2032-06",
       "linkedGenerations": {