Relax lowercase requirement for /api/v1/tag/{name}/project and `/ap…

…i/v1/tag/{name}/policy` Signed-off-by: nscuro <nscuro@protonmail.com>
DependencyTrack · Jun 26, 2024 · 5fbf0d9 · 5fbf0d9
1 parent 7ef0470
commit 5fbf0d9
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 110 deletions.
diff --git a/src/main/java/org/dependencytrack/model/validation/LowerCase.java b/src/main/java/org/dependencytrack/model/validation/LowerCase.java
diff --git a/src/main/java/org/dependencytrack/model/validation/LowerCaseValidator.java b/src/main/java/org/dependencytrack/model/validation/LowerCaseValidator.java
diff --git a/src/main/java/org/dependencytrack/resources/v1/TagResource.java b/src/main/java/org/dependencytrack/resources/v1/TagResource.java
@@ -33,7 +33,6 @@
 import io.swagger.v3.oas.annotations.security.SecurityRequirements;
 import org.dependencytrack.auth.Permissions;
 import org.dependencytrack.model.Tag;
-import org.dependencytrack.model.validation.LowerCase;
 import org.dependencytrack.model.validation.ValidUuid;
 import org.dependencytrack.persistence.QueryManager;
 import org.dependencytrack.persistence.TagQueryManager.TagListRow;
@@ -108,9 +107,13 @@ public Response getAllTags() {
  @PaginatedApi
  @PermissionRequired(Permissions.Constants.VIEW_PORTFOLIO)
  public Response getTaggedProjects(
- @Parameter(description = "Name of the tag to get projects for. Must be lowercase.", required = true)
- @PathParam("name") @LowerCase final String tagName
+ @Parameter(description = "Name of the tag to get projects for", required = true)
+ @PathParam("name") final String tagName
  ) {
+ // TODO: Should enforce lowercase for tagName once we are sure that
+ // users don't have any mixed-case tags in their system anymore.
+ // Will likely need a migration to cleanup existing tags for this.
+
  final List<TaggedProjectRow> taggedProjectListRows;
  try (final var qm = new QueryManager(getAlpineRequest())) {
  taggedProjectListRows = qm.getTaggedProjects(tagName);
@@ -141,9 +144,13 @@ public Response getTaggedProjects(
  @PaginatedApi
  @PermissionRequired(Permissions.Constants.VIEW_PORTFOLIO)
  public Response getTaggedPolicies(
- @Parameter(description = "Name of the tag to get policies for. Must be lowercase.", required = true)
- @PathParam("name") @LowerCase final String tagName
+ @Parameter(description = "Name of the tag to get policies for", required = true)
+ @PathParam("name") final String tagName
  ) {
+ // TODO: Should enforce lowercase for tagName once we are sure that
+ // users don't have any mixed-case tags in their system anymore.
+ // Will likely need a migration to cleanup existing tags for this.
+
  final List<TaggedPolicyRow> taggedPolicyListRows;
  try (final var qm = new QueryManager(getAlpineRequest())) {
  taggedPolicyListRows = qm.getTaggedPolicies(tagName);

diff --git a/src/test/java/org/dependencytrack/resources/v1/TagResourceTest.java b/src/test/java/org/dependencytrack/resources/v1/TagResourceTest.java
@@ -346,17 +346,9 @@ public void getTaggedProjectsWithNonLowerCaseTagNameTest() {
  .request()
  .header(X_API_KEY, apiKey)
  .get();
- assertThat(response.getStatus()).isEqualTo(400);
- assertThatJson(getPlainTextBody(response)).isEqualTo("""
- [
- {
- "message": "Value must only contain lowercase letters.",
- "messageTemplate": "Value must only contain lowercase letters.",
- "path": "getTaggedProjects.arg0",
- "invalidValue": "Foo"
- }
- ]
- """);
+ assertThat(response.getStatus()).isEqualTo(200);
+ assertThat(response.getHeaderString(TOTAL_COUNT_HEADER)).isEqualTo("0");
+ assertThat(getPlainTextBody(response)).isEqualTo("[]");
  }
 
  @Test
@@ -473,17 +465,9 @@ public void getTaggedPoliciesWithNonLowerCaseTagNameTest() {
  .request()
  .header(X_API_KEY, apiKey)
  .get();
- assertThat(response.getStatus()).isEqualTo(400);
- assertThatJson(getPlainTextBody(response)).isEqualTo("""
- [
- {
- "message": "Value must only contain lowercase letters.",
- "messageTemplate": "Value must only contain lowercase letters.",
- "path": "getTaggedPolicies.arg0",
- "invalidValue": "Foo"
- }
- ]
- """);
+ assertThat(response.getStatus()).isEqualTo(200);
+ assertThat(response.getHeaderString(TOTAL_COUNT_HEADER)).isEqualTo("0");
+ assertThat(getPlainTextBody(response)).isEqualTo("[]");
  }
 
  @Test