501 lines
18 KiB
Java
501 lines
18 KiB
Java
/*
|
|
* Copyright (C) 2018 Google Inc.
|
|
*
|
|
* 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.copybara;
|
|
|
|
import static com.google.common.truth.Truth.assertThat;
|
|
import static java.nio.charset.StandardCharsets.UTF_8;
|
|
import static org.junit.Assert.assertThrows;
|
|
|
|
import com.google.common.base.Joiner;
|
|
import com.google.common.collect.ImmutableList;
|
|
import com.google.common.collect.ImmutableMap;
|
|
import com.google.common.collect.ImmutableSetMultimap;
|
|
import com.google.common.collect.Iterables;
|
|
import com.google.common.jimfs.Jimfs;
|
|
import com.google.copybara.DestinationEffect.DestinationRef;
|
|
import com.google.copybara.config.Config;
|
|
import com.google.copybara.config.MapConfigFile;
|
|
import com.google.copybara.exception.EmptyChangeException;
|
|
import com.google.copybara.exception.RepoException;
|
|
import com.google.copybara.exception.ValidationException;
|
|
import com.google.copybara.feedback.Feedback;
|
|
import com.google.copybara.monitor.EventMonitor.ChangeMigrationFinishedEvent;
|
|
import com.google.copybara.testing.DummyTrigger;
|
|
import com.google.copybara.testing.OptionsBuilder;
|
|
import com.google.copybara.testing.SkylarkTestExecutor;
|
|
import com.google.copybara.testing.TestingEventMonitor;
|
|
import com.google.copybara.util.console.Message.MessageType;
|
|
import com.google.copybara.util.console.testing.TestingConsole;
|
|
import java.io.IOException;
|
|
import java.nio.file.Path;
|
|
import javax.annotation.Nullable;
|
|
import org.junit.Before;
|
|
import org.junit.Test;
|
|
import org.junit.runner.RunWith;
|
|
import org.junit.runners.JUnit4;
|
|
|
|
@RunWith(JUnit4.class)
|
|
public class FeedbackTest {
|
|
|
|
private SkylarkTestExecutor skylark;
|
|
private TestingConsole console;
|
|
private TestingEventMonitor eventMonitor;
|
|
private DummyTrigger dummyTrigger;
|
|
private Path workdir;
|
|
|
|
@Before
|
|
public void setup() throws Exception {
|
|
workdir = Jimfs.newFileSystem().getPath("/");
|
|
console = new TestingConsole(/*verbose=*/ false);
|
|
eventMonitor = new TestingEventMonitor();
|
|
OptionsBuilder options = new OptionsBuilder();
|
|
options.setConsole(console);
|
|
options.general.withEventMonitor(eventMonitor);
|
|
dummyTrigger = new DummyTrigger();
|
|
options.testingOptions.feedbackTrigger = dummyTrigger;
|
|
skylark = new SkylarkTestExecutor(options);
|
|
}
|
|
|
|
@Test
|
|
public void testParsing() throws Exception {
|
|
Feedback feedback = loggingFeedback();
|
|
assertThat(feedback.getName()).isEqualTo("default");
|
|
assertThat(feedback.getModeString()).isEqualTo("feedback");
|
|
assertThat(feedback.getMainConfigFile()).isNotNull();
|
|
assertThat(feedback.getOriginDescription()).isEqualTo(dummyTrigger.describe());
|
|
assertThat(feedback.getDestinationDescription()).isEqualTo(dummyTrigger.describe());
|
|
assertThat(feedback.getActionsDescription())
|
|
.containsEntry("test_action", ImmutableSetMultimap.of());
|
|
}
|
|
|
|
@Test
|
|
public void testDescription() throws Exception {
|
|
String config = ""
|
|
+ "def test_action(ctx):\n"
|
|
+ " return ctx.success()\n"
|
|
+ "\n"
|
|
+ "core.feedback(\n"
|
|
+ " name = 'default',\n"
|
|
+ " description = 'Do foo with bar',\n"
|
|
+ " origin = testing.dummy_trigger(),\n"
|
|
+ " destination = testing.dummy_endpoint(),\n"
|
|
+ " actions = [test_action],\n"
|
|
+ ")";
|
|
Feedback feedback = (Feedback) loadConfig(config).getMigration("default");
|
|
assertThat(feedback.getDescription()).isEqualTo("Do foo with bar");
|
|
}
|
|
|
|
|
|
@Test
|
|
public void testDescribeActions() throws Exception {
|
|
Feedback feedback = feedback(
|
|
""
|
|
+ "def _action1(ctx):\n"
|
|
+ " return ctx.success()\n"
|
|
+ "\n"
|
|
+ "def _action2(ctx):\n"
|
|
+ " return ctx.success()\n"
|
|
+ "\n"
|
|
+ "def action1(param1):\n"
|
|
+ " return core.dynamic_feedback(\n"
|
|
+ " impl = _action1,\n"
|
|
+ " params = {\n"
|
|
+ " 'param1': param1,\n"
|
|
+ " },\n"
|
|
+ " )"
|
|
+ "\n"
|
|
+ "def action2(param1, param2):\n"
|
|
+ " return core.dynamic_feedback(\n"
|
|
+ " impl = _action2,\n"
|
|
+ " params = {\n"
|
|
+ " 'param1': param1,\n"
|
|
+ " 'param2': param2,\n"
|
|
+ " },\n"
|
|
+ " )"
|
|
+ "\n",
|
|
"action1(param1 = 'foo')", "action2(param1 = True, param2 = 'Bar')");
|
|
assertThat(feedback.getActionsDescription())
|
|
.isEqualTo(
|
|
ImmutableSetMultimap.builder()
|
|
.put("_action1", ImmutableSetMultimap.of("param1", "foo"))
|
|
.put("_action2", ImmutableSetMultimap.of("param1", "true", "param2", "Bar"))
|
|
.build());
|
|
}
|
|
|
|
@Test
|
|
public void testAction() throws Exception {
|
|
Feedback feedback = loggingFeedback();
|
|
feedback.run(workdir, ImmutableList.of("12345"));
|
|
console.assertThat().onceInLog(MessageType.INFO, "Ref: 12345");
|
|
console.assertThat().onceInLog(MessageType.INFO, "Feedback name: default");
|
|
console.assertThat().onceInLog(MessageType.INFO, "Action name: test_action");
|
|
}
|
|
|
|
@Test
|
|
public void testNullSourceRef() throws Exception {
|
|
Feedback feedback = loggingFeedback();
|
|
feedback.run(workdir, ImmutableList.of());
|
|
console.assertThat()
|
|
.equalsNext(MessageType.INFO, "Action 'test_action' returned success")
|
|
.containsNoMoreMessages();
|
|
}
|
|
|
|
@Test
|
|
public void testMultipleSourceRefs() throws Exception {
|
|
Feedback feedback = loggingFeedback();
|
|
feedback.run(workdir, ImmutableList.of("12345", "67890"));
|
|
console
|
|
.assertThat()
|
|
.matchesNext(MessageType.INFO, ".*Ref: 12345")
|
|
.matchesNext(MessageType.INFO, ".*Feedback name: default")
|
|
.matchesNext(MessageType.INFO, ".*Action name: test_action")
|
|
.matchesNext(MessageType.INFO, ".*Ref: 67890")
|
|
.matchesNext(MessageType.INFO, ".*Feedback name: default")
|
|
.matchesNext(MessageType.INFO, ".*Action name: test_action")
|
|
.matchesNext(MessageType.INFO, ".*Action 'test_action' returned success.*");
|
|
}
|
|
|
|
@Test
|
|
public void testRefReturnsFirst() throws Exception {
|
|
Feedback feedback =
|
|
feedback(
|
|
""
|
|
+ "def test_action(ctx):\n"
|
|
+ " ctx.console.info('Ref: ' + str(ctx.refs[0]))\n"
|
|
+ " return ctx.success()\n"
|
|
+ "\n",
|
|
"test_action");
|
|
feedback.run(workdir, ImmutableList.of("12345", "67890"));
|
|
console
|
|
.assertThat()
|
|
.matchesNext(MessageType.INFO, ".*Ref: 12345")
|
|
.matchesNext(MessageType.INFO, ".*Action 'test_action' returned success.*")
|
|
.containsNoMoreMessages();
|
|
}
|
|
|
|
@Test
|
|
public void testRefReturnsNone() throws Exception {
|
|
Feedback feedback =
|
|
feedback(
|
|
""
|
|
+ "def test_action(ctx):\n"
|
|
+ " ref = None\n"
|
|
+ " if len(ctx.refs) > 0:\n"
|
|
+ " ref = ctx.refs[0]\n"
|
|
+ " ctx.console.info('Ref: '+ str(ref))\n"
|
|
+ " return ctx.success()\n"
|
|
+ "\n",
|
|
"test_action");
|
|
feedback.run(workdir, ImmutableList.of());
|
|
console
|
|
.assertThat()
|
|
.matchesNext(MessageType.INFO, ".*Ref: None")
|
|
.matchesNext(MessageType.INFO, ".*Action 'test_action' returned success.*")
|
|
.containsNoMoreMessages();
|
|
}
|
|
|
|
@Test
|
|
public void testActionsMustReturnResult() throws Exception {
|
|
Feedback feedback = feedback(
|
|
""
|
|
+ "def test_action(ctx):\n"
|
|
+ " ctx.console.info('Bad action')\n"
|
|
+ "\n",
|
|
"test_action");
|
|
ValidationException expected =
|
|
assertThrows(ValidationException.class, () -> feedback.run(workdir, ImmutableList.of()));
|
|
assertThat(expected)
|
|
.hasMessageThat()
|
|
.contains(
|
|
"Feedback actions must return a result via built-in functions: success(), "
|
|
+ "error(), noop() return, but 'test_action' returned: None");
|
|
}
|
|
|
|
@Test
|
|
public void testSuccessResult() throws Exception {
|
|
Feedback feedback = feedback(
|
|
""
|
|
+ "def test_action(ctx):\n"
|
|
+ " return ctx.success()\n",
|
|
"test_action");
|
|
feedback.run(workdir, ImmutableList.of());
|
|
console.assertThat().equalsNext(MessageType.INFO, "Action 'test_action' returned success");
|
|
}
|
|
|
|
@Test
|
|
public void testNoActionsThrowsEmptyChangeException() throws Exception {
|
|
Feedback feedback = feedback("");
|
|
EmptyChangeException expected =
|
|
assertThrows(EmptyChangeException.class, () -> feedback.run(workdir, ImmutableList.of()));
|
|
assertThat(expected)
|
|
.hasMessageThat()
|
|
.contains(
|
|
"Feedback migration 'default' was noop. Detailed messages: actions field is empty");
|
|
}
|
|
|
|
@Test
|
|
public void testNoopResultThrowsEmptyChangeException() throws Exception {
|
|
Feedback feedback = feedback(
|
|
""
|
|
+ "def test_action_1(ctx):\n"
|
|
+ " return ctx.noop('No effect 1')\n"
|
|
+ "\n"
|
|
+ "def test_action_2(ctx):\n"
|
|
+ " return ctx.noop('No effect 2')\n"
|
|
+ "\n",
|
|
"test_action_1", "test_action_2");
|
|
EmptyChangeException expected =
|
|
assertThrows(EmptyChangeException.class, () -> feedback.run(workdir, ImmutableList.of()));
|
|
assertThat(expected)
|
|
.hasMessageThat()
|
|
.contains(
|
|
"Feedback migration 'default' was noop. "
|
|
+ "Detailed messages: [No effect 1, No effect 2]");
|
|
console
|
|
.assertThat()
|
|
.equalsNext(MessageType.INFO, "Action 'test_action_1' returned noop: No effect 1")
|
|
.equalsNext(MessageType.INFO, "Action 'test_action_2' returned noop: No effect 2");
|
|
}
|
|
|
|
@Test
|
|
public void testErrorResultThrowsValidationException() throws Exception {
|
|
Feedback feedback = feedback(
|
|
""
|
|
+ "def test_action(ctx):\n"
|
|
+ " return ctx.error('This is an error')\n",
|
|
"test_action");
|
|
ValidationException expected =
|
|
assertThrows(ValidationException.class, () -> feedback.run(workdir, ImmutableList.of()));
|
|
assertThat(expected)
|
|
.hasMessageThat()
|
|
.contains(
|
|
"Feedback migration 'default' action 'test_action' returned error: "
|
|
+ "This is an error. Aborting execution.");
|
|
console
|
|
.assertThat()
|
|
.equalsNext(MessageType.ERROR, "Action 'test_action' returned error: This is an error");
|
|
}
|
|
|
|
@Test
|
|
public void testErrorResultAbortsExecution() throws Exception {
|
|
Feedback feedback = feedback(
|
|
""
|
|
+ "def test_action_1(ctx):\n"
|
|
+ " return ctx.error('This is an error')\n"
|
|
+ "\n"
|
|
+ "def test_action_2(ctx):\n"
|
|
+ " return ctx.success()\n"
|
|
, "test_action_1", "test_action_2");
|
|
ValidationException expected =
|
|
assertThrows(ValidationException.class, () -> feedback.run(workdir, ImmutableList.of()));
|
|
assertThat(expected)
|
|
.hasMessageThat()
|
|
.contains(
|
|
"Feedback migration 'default' action 'test_action_1' returned error: "
|
|
+ "This is an error. Aborting execution.");
|
|
console
|
|
.assertThat()
|
|
.equalsNext(MessageType.ERROR, "Action 'test_action_1' returned error: This is an error")
|
|
.containsNoMoreMessages();
|
|
}
|
|
|
|
@Test
|
|
public void testNoopSuccessReturnsSuccess() throws Exception {
|
|
Feedback feedback = feedback(
|
|
""
|
|
+ "def test_action_1(ctx):\n"
|
|
+ " return ctx.noop('No effect')\n"
|
|
+ "\n"
|
|
+ "def test_action_2(ctx):\n"
|
|
+ " return ctx.success()\n"
|
|
+ "\n", "test_action_1", "test_action_2");
|
|
feedback.run(workdir, ImmutableList.of());
|
|
console
|
|
.assertThat()
|
|
.equalsNext(MessageType.INFO, "Action 'test_action_1' returned noop: No effect")
|
|
.equalsNext(MessageType.INFO, "Action 'test_action_2' returned success")
|
|
.containsNoMoreMessages();
|
|
}
|
|
|
|
@Test
|
|
public void testErrorResultEmptyMsg() throws Exception {
|
|
Feedback feedback = feedback(
|
|
""
|
|
+ "def test_action(ctx):\n"
|
|
+ " result = ctx.error()\n"
|
|
+ "\n",
|
|
"test_action");
|
|
ValidationException expected =
|
|
assertThrows(ValidationException.class, () -> feedback.run(workdir, ImmutableList.of()));
|
|
assertThat(expected)
|
|
.hasMessageThat()
|
|
.matches(".*missing 1 required positional argument: msg.*");
|
|
}
|
|
|
|
@Test
|
|
public void testEvalExceptionIncludesLocation() throws Exception {
|
|
Feedback feedback = feedback(
|
|
""
|
|
+ "def test_action(ctx):\n"
|
|
+ " result = ctx.foo()\n"
|
|
+ "\n",
|
|
"test_action");
|
|
ValidationException expected =
|
|
assertThrows(ValidationException.class, () -> feedback.run(workdir, ImmutableList.of()));
|
|
assertThat(expected)
|
|
.hasMessageThat()
|
|
.contains(
|
|
"Error while executing the skylark transformation test_action: 'feedback.context'"
|
|
+ " value has no field or method 'foo'. Location: copy.bara.sky:2:14");
|
|
}
|
|
|
|
@Test
|
|
public void testDestinationEffects() throws Exception {
|
|
runAndVerifyDestinationEffects(""
|
|
+ "def test_action(ctx):\n"
|
|
+ " ctx.record_effect("
|
|
+ " 'Some effect',\n"
|
|
+ " [ctx.origin.new_origin_ref('foo')],\n"
|
|
+ " ctx.destination.new_destination_ref(ref = 'bar', type = 'some_type'))\n"
|
|
+ " return ctx.success()\n"
|
|
+ "\n", ImmutableList.of());
|
|
}
|
|
|
|
@Test
|
|
public void testDestinationEffectsWithErrors() throws Exception {
|
|
runAndVerifyDestinationEffects(
|
|
""
|
|
+ "def test_action(ctx):\n"
|
|
+ " ctx.record_effect("
|
|
+ " 'Some effect',\n"
|
|
+ " [ctx.origin.new_origin_ref('foo')],\n"
|
|
+ " ctx.destination.new_destination_ref(ref = 'bar', type = 'some_type'), "
|
|
+ " ['error1', 'error2'])\n"
|
|
+ " return ctx.success()\n"
|
|
+ "\n", ImmutableList.of("error1", "error2"));
|
|
}
|
|
|
|
@Test
|
|
public void testDestinationEffectsWithUrl() throws Exception {
|
|
runAndVerifyDestinationEffects(""
|
|
+ "def test_action(ctx):\n"
|
|
+ " ctx.record_effect("
|
|
+ " 'Some other effect',\n"
|
|
+ " [ctx.origin.new_origin_ref('origin_ref')],\n"
|
|
+ " ctx.destination.new_destination_ref("
|
|
+ " 'dest_ref', 'custom_type', 'https://foo.bar'))\n"
|
|
+ " return ctx.success()\n"
|
|
+ "\n", ImmutableList.of(),
|
|
"Some other effect",
|
|
"origin_ref",
|
|
"dest_ref",
|
|
"custom_type",
|
|
"https://foo.bar");
|
|
}
|
|
|
|
private void runAndVerifyDestinationEffects(
|
|
String actionsCode, ImmutableList<String> expectedErrors) throws Exception {
|
|
runAndVerifyDestinationEffects(
|
|
actionsCode,
|
|
expectedErrors,
|
|
"Some effect",
|
|
"foo",
|
|
"bar",
|
|
"some_type",
|
|
/*expectedDestUrl=*/ null);
|
|
}
|
|
|
|
private void runAndVerifyDestinationEffects(
|
|
String actionsCode,
|
|
ImmutableList<String> expectedErrors,
|
|
String expectedSummary,
|
|
String expectedOriginRef,
|
|
String expectedDestRef,
|
|
String expectedDestType,
|
|
@Nullable String expectedDestUrl)
|
|
throws IOException, ValidationException, RepoException {
|
|
Feedback feedback = feedback(actionsCode, "test_action");
|
|
feedback.run(workdir, ImmutableList.of());
|
|
console.assertThat().equalsNext(MessageType.INFO, "Action 'test_action' returned success");
|
|
|
|
assertThat(eventMonitor.changeMigrationStartedEventCount()).isEqualTo(1);
|
|
assertThat(eventMonitor.changeMigrationFinishedEventCount()).isEqualTo(1);
|
|
|
|
ChangeMigrationFinishedEvent event =
|
|
Iterables.getOnlyElement(eventMonitor.changeMigrationFinishedEvents);
|
|
DestinationEffect effect = Iterables.getOnlyElement(event.getDestinationEffects());
|
|
assertThat(effect.getSummary()).isEqualTo(expectedSummary);
|
|
assertThat(effect.getOriginRefs()).hasSize(1);
|
|
assertThat(effect.getOriginRefs().get(0).getRef()).isEqualTo(expectedOriginRef);
|
|
DestinationRef destinationRef = effect.getDestinationRef();
|
|
assertThat(destinationRef.getId()).isEqualTo(expectedDestRef);
|
|
assertThat(destinationRef.getType()).isEqualTo(expectedDestType);
|
|
if (expectedDestUrl == null) {
|
|
assertThat(destinationRef.getUrl()).isNull();
|
|
} else {
|
|
assertThat(destinationRef.getUrl()).isEqualTo(expectedDestUrl);
|
|
}
|
|
assertThat(effect.getErrors()).containsExactlyElementsIn(expectedErrors);
|
|
}
|
|
|
|
private Feedback loggingFeedback() throws IOException, ValidationException {
|
|
return feedback(
|
|
""
|
|
+ "def test_action(ctx):\n"
|
|
+ " for ref in ctx.refs:\n"
|
|
+ " ctx.console.info('Ref: ' + ref)\n"
|
|
+ " ctx.console.info('Feedback name: ' + ctx.feedback_name)\n"
|
|
+ " ctx.console.info('Action name: ' + ctx.action_name)\n"
|
|
+ " return ctx.success()\n"
|
|
+ "\n",
|
|
"test_action");
|
|
}
|
|
|
|
private Feedback feedback(String actionsCode, String... actionNames)
|
|
throws IOException, ValidationException {
|
|
String config =
|
|
actionsCode
|
|
+ "\n"
|
|
+ "core.feedback(\n"
|
|
+ " name = 'default',\n"
|
|
+ " origin = testing.dummy_trigger(),\n"
|
|
+ " destination = testing.dummy_endpoint(),\n"
|
|
+ " actions = [" + Joiner.on(',').join(actionNames) + "],\n"
|
|
+ ")\n"
|
|
+ "\n";
|
|
System.err.println(config);
|
|
return (Feedback) loadConfig(config).getMigration("default");
|
|
}
|
|
|
|
private Config loadConfig(String content) throws IOException, ValidationException {
|
|
return skylark.loadConfig(
|
|
new MapConfigFile(
|
|
ImmutableMap.of("copy.bara.sky", content.getBytes(UTF_8)), "copy.bara.sky"));
|
|
}
|
|
|
|
@Test
|
|
public void testInvalidMigrationName() {
|
|
skylark.evalFails(
|
|
""
|
|
+ "core.feedback(\n"
|
|
+ " name = 'foo| bad;name',\n"
|
|
+ " origin = testing.dummy_trigger(),\n"
|
|
+ " destination = testing.dummy_endpoint()\n"
|
|
+ ")\n",
|
|
".*Migration name 'foo[|] bad;name' doesn't conform to expected pattern.*");
|
|
}
|
|
}
|