From a3ad83ab82662d237cc6595b5657b7eace9eb73e Mon Sep 17 00:00:00 2001 From: Edwin Kempin Date: Thu, 21 Jun 2018 17:37:41 +0200 Subject: [PATCH] Test that the plugin REST endpoints are correctly bound Change-Id: I94b070ed65c2ca29ba5cfbccbe3f3a2be71bf1ac Signed-off-by: Edwin Kempin --- .../rest/PluginsRestApiBindingsIT.java | 68 +++++++++++++++++++ .../RootCollectionsRestApiBindingsIT.java | 1 + 2 files changed, 69 insertions(+) create mode 100644 javatests/com/google/gerrit/acceptance/rest/PluginsRestApiBindingsIT.java diff --git a/javatests/com/google/gerrit/acceptance/rest/PluginsRestApiBindingsIT.java b/javatests/com/google/gerrit/acceptance/rest/PluginsRestApiBindingsIT.java new file mode 100644 index 0000000000..aba677f379 --- /dev/null +++ b/javatests/com/google/gerrit/acceptance/rest/PluginsRestApiBindingsIT.java @@ -0,0 +1,68 @@ +// Copyright (C) 2018 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.acceptance.rest; + +import static java.nio.charset.StandardCharsets.UTF_8; + +import com.google.common.collect.ImmutableList; +import com.google.gerrit.acceptance.GerritConfig; +import com.google.gerrit.common.RawInputUtil; +import com.google.gerrit.extensions.api.plugins.InstallPluginInput; +import com.google.gerrit.extensions.restapi.RawInput; +import org.junit.Test; + +/** + * Tests for checking the bindings of the plugins REST API. + * + *

These tests only verify that the plugin REST endpoints are correctly bound, they do no test + * the functionality of the plugin REST endpoints (for details see JavaDoc on {@link + * AbstractRestApiBindingsTest}). + */ +public class PluginsRestApiBindingsIT extends AbstractRestApiBindingsTest { + /** + * Plugin REST endpoints to be tested, each URL contains a placeholder for the plugin identifier. + */ + private static final ImmutableList PLUGIN_ENDPOINTS = + ImmutableList.of( + RestCall.put("/plugins/%s"), + + // For GET requests prefixing the view name with 'gerrit~' is required. + RestCall.get("/plugins/%s/gerrit~status"), + + // POST (and PUT) requests don't require the 'gerrit~' prefix in front of the view name. + RestCall.post("/plugins/%s/enable"), + RestCall.post("/plugins/%s/disable"), + RestCall.post("/plugins/%s/reload"), + + // Plugin deletion must be tested last + RestCall.delete("/plugins/%s")); + + private static final String JS_PLUGIN = "Gerrit.install(function(self){});\n"; + private static final RawInput JS_PLUGIN_CONTENT = RawInputUtil.create(JS_PLUGIN.getBytes(UTF_8)); + + @Test + @GerritConfig(name = "plugins.allowRemoteAdmin", value = "true") + public void pluginEndpoints() throws Exception { + String pluginName = "my-plugin"; + installPlugin(pluginName); + execute(PLUGIN_ENDPOINTS, pluginName); + } + + private void installPlugin(String pluginName) throws Exception { + InstallPluginInput input = new InstallPluginInput(); + input.raw = JS_PLUGIN_CONTENT; + gApi.plugins().install(pluginName + ".js", input); + } +} diff --git a/javatests/com/google/gerrit/acceptance/rest/RootCollectionsRestApiBindingsIT.java b/javatests/com/google/gerrit/acceptance/rest/RootCollectionsRestApiBindingsIT.java index 78651fed15..131ed1a1de 100644 --- a/javatests/com/google/gerrit/acceptance/rest/RootCollectionsRestApiBindingsIT.java +++ b/javatests/com/google/gerrit/acceptance/rest/RootCollectionsRestApiBindingsIT.java @@ -42,6 +42,7 @@ public class RootCollectionsRestApiBindingsIT extends AbstractRestApiBindingsTes RestCall.get("/groups/"), RestCall.put("/groups/new-group"), RestCall.get("/plugins/"), + RestCall.put("/plugins/new-plugin"), RestCall.get("/projects/"), RestCall.put("/projects/new-project"));