From 272dfe918009de0938fde9835961b37420808ffa Mon Sep 17 00:00:00 2001 From: Teryk Bellahsene Date: Tue, 5 Sep 2017 18:20:37 +0200 Subject: [PATCH] SONAR-9181 Sanitize json example filenames of api/projects domain --- .../main/java/org/sonar/server/project/ws/GhostsAction.java | 2 +- .../java/org/sonar/server/project/ws/ProvisionedAction.java | 2 +- .../ws/{projects-example-ghosts.json => ghosts-example.json} | 0 ...ects-example-provisioned.json => provisioned-example.json} | 0 .../java/org/sonar/server/project/ws/GhostsActionTest.java | 4 +--- .../org/sonar/server/project/ws/ProvisionedActionTest.java | 4 +--- 6 files changed, 4 insertions(+), 8 deletions(-) rename server/sonar-server/src/main/resources/org/sonar/server/project/ws/{projects-example-ghosts.json => ghosts-example.json} (100%) rename server/sonar-server/src/main/resources/org/sonar/server/project/ws/{projects-example-provisioned.json => provisioned-example.json} (100%) diff --git a/server/sonar-server/src/main/java/org/sonar/server/project/ws/GhostsAction.java b/server/sonar-server/src/main/java/org/sonar/server/project/ws/GhostsAction.java index 2c7dd00c722..ab90d8496c6 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/project/ws/GhostsAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/project/ws/GhostsAction.java @@ -70,7 +70,7 @@ public class GhostsAction implements ProjectsWsAction { .setDescription("List ghost projects.
" + "With the current architecture, it's no more possible to have invisible ghost projects. Therefore, the web service is deprecated.
" + "Requires 'Administer System' permission.") - .setResponseExample(Resources.getResource(getClass(), "projects-example-ghosts.json")) + .setResponseExample(Resources.getResource(getClass(), "ghosts-example.json")) .setSince("5.2") .setDeprecatedSince("6.6") .addPagingParams(100, MAX_LIMIT) diff --git a/server/sonar-server/src/main/java/org/sonar/server/project/ws/ProvisionedAction.java b/server/sonar-server/src/main/java/org/sonar/server/project/ws/ProvisionedAction.java index a19e83f044f..a5fcf853663 100644 --- a/server/sonar-server/src/main/java/org/sonar/server/project/ws/ProvisionedAction.java +++ b/server/sonar-server/src/main/java/org/sonar/server/project/ws/ProvisionedAction.java @@ -78,7 +78,7 @@ public class ProvisionedAction implements ProjectsWsAction { "Require 'Create Projects' permission.") .setSince("5.2") .setDeprecatedSince("6.6") - .setResponseExample(Resources.getResource(getClass(), "projects-example-provisioned.json")) + .setResponseExample(Resources.getResource(getClass(), "provisioned-example.json")) .setHandler(this) .addPagingParams(100, MAX_LIMIT) .addSearchQuery("sonar", "names", "keys") diff --git a/server/sonar-server/src/main/resources/org/sonar/server/project/ws/projects-example-ghosts.json b/server/sonar-server/src/main/resources/org/sonar/server/project/ws/ghosts-example.json similarity index 100% rename from server/sonar-server/src/main/resources/org/sonar/server/project/ws/projects-example-ghosts.json rename to server/sonar-server/src/main/resources/org/sonar/server/project/ws/ghosts-example.json diff --git a/server/sonar-server/src/main/resources/org/sonar/server/project/ws/projects-example-provisioned.json b/server/sonar-server/src/main/resources/org/sonar/server/project/ws/provisioned-example.json similarity index 100% rename from server/sonar-server/src/main/resources/org/sonar/server/project/ws/projects-example-provisioned.json rename to server/sonar-server/src/main/resources/org/sonar/server/project/ws/provisioned-example.json diff --git a/server/sonar-server/src/test/java/org/sonar/server/project/ws/GhostsActionTest.java b/server/sonar-server/src/test/java/org/sonar/server/project/ws/GhostsActionTest.java index 5350d3090cb..47c73884037 100644 --- a/server/sonar-server/src/test/java/org/sonar/server/project/ws/GhostsActionTest.java +++ b/server/sonar-server/src/test/java/org/sonar/server/project/ws/GhostsActionTest.java @@ -19,7 +19,6 @@ */ package org.sonar.server.project.ws; -import com.google.common.io.Resources; import java.util.function.Consumer; import org.apache.commons.lang.StringUtils; import org.junit.Rule; @@ -216,8 +215,7 @@ public class GhostsActionTest { .setParam("organization", organization.getKey()) .execute(); - assertJson(result.getInput()) - .isSimilarTo(Resources.getResource(getClass(), "projects-example-ghosts.json")); + assertJson(result.getInput()).isSimilarTo(ws.getDef().responseExampleAsString()); } @Test diff --git a/server/sonar-server/src/test/java/org/sonar/server/project/ws/ProvisionedActionTest.java b/server/sonar-server/src/test/java/org/sonar/server/project/ws/ProvisionedActionTest.java index 269a85ba068..07b0782bce5 100644 --- a/server/sonar-server/src/test/java/org/sonar/server/project/ws/ProvisionedActionTest.java +++ b/server/sonar-server/src/test/java/org/sonar/server/project/ws/ProvisionedActionTest.java @@ -19,7 +19,6 @@ */ package org.sonar.server.project.ws; -import com.google.common.io.Resources; import org.apache.commons.lang.StringUtils; import org.junit.Rule; import org.junit.Test; @@ -192,8 +191,7 @@ public class ProvisionedActionTest { .setParam(PARAM_ORGANIZATION, org.getKey()) .execute(); - assertJson(result.getInput()) - .isSimilarTo(Resources.getResource(getClass(), "projects-example-provisioned.json")); + assertJson(result.getInput()).isSimilarTo(ws.getDef().responseExampleAsString()); } @Test -- 2.39.5