118 lines
4 KiB
Java
118 lines
4 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 com.google.common.collect.ImmutableSetMultimap;
|
|
import com.google.copybara.DestinationEffect.DestinationRef;
|
|
import com.google.copybara.DestinationEffect.OriginRef;
|
|
import com.google.copybara.util.console.Console;
|
|
import com.google.devtools.build.lib.skylarkinterface.Param;
|
|
import com.google.devtools.build.lib.skylarkinterface.StarlarkBuiltin;
|
|
import com.google.devtools.build.lib.skylarkinterface.StarlarkDocumentationCategory;
|
|
import com.google.devtools.build.lib.skylarkinterface.StarlarkMethod;
|
|
import com.google.devtools.build.lib.syntax.EvalUtils;
|
|
import com.google.devtools.build.lib.syntax.Printer;
|
|
import com.google.devtools.build.lib.syntax.StarlarkValue;
|
|
|
|
/**
|
|
* An origin or destination API in a feedback migration.
|
|
*
|
|
* <p>Endpoints are symmetric, that is, they need to be able to act both as an origin and
|
|
* destination of a feedback migration, which means that they need to support both read and write
|
|
* operations on the API.
|
|
*/
|
|
@SuppressWarnings("unused")
|
|
@StarlarkBuiltin(
|
|
name = "endpoint",
|
|
doc = "An origin or destination API in a feedback migration.",
|
|
category = StarlarkDocumentationCategory.TOP_LEVEL_TYPE)
|
|
public interface Endpoint extends StarlarkValue {
|
|
|
|
/**
|
|
* To be used for core.workflow origin/destinations that don't want to provide an api for giving
|
|
* feedback.
|
|
*/
|
|
Endpoint NOOP_ENDPOINT =
|
|
new Endpoint() {
|
|
@Override
|
|
public ImmutableSetMultimap<String, String> describe() {
|
|
throw new IllegalStateException("Instance shouldn't be used for core.feedback");
|
|
}
|
|
|
|
@Override
|
|
public void repr(Printer printer) {
|
|
printer.append("noop_endpoint");
|
|
}
|
|
};
|
|
|
|
@Override
|
|
default void repr(Printer printer) {
|
|
printer.append(toString());
|
|
}
|
|
|
|
/** Returns a key-value ist of the options the endpoint was instantiated with. */
|
|
ImmutableSetMultimap<String, String> describe();
|
|
|
|
@StarlarkMethod(
|
|
name = "new_origin_ref",
|
|
doc = "Creates a new origin reference out of this endpoint.",
|
|
parameters = {
|
|
@Param(name = "ref", type = String.class, named = true, doc = "The reference."),
|
|
})
|
|
default OriginRef newOriginRef(String ref) {
|
|
return new OriginRef(ref);
|
|
}
|
|
|
|
@StarlarkMethod(
|
|
name = "new_destination_ref",
|
|
doc = "Creates a new destination reference out of this endpoint.",
|
|
parameters = {
|
|
@Param(name = "ref", type = String.class, named = true, doc = "The reference."),
|
|
@Param(
|
|
name = "type",
|
|
type = String.class,
|
|
named = true,
|
|
doc = "The type of this reference."),
|
|
@Param(
|
|
name = "url",
|
|
type = String.class,
|
|
named = true,
|
|
noneable = true,
|
|
doc = "The url associated with this reference, if any.",
|
|
defaultValue = "None"),
|
|
})
|
|
default DestinationRef newDestinationRef(String ref, String type, Object urlObj) {
|
|
String url = EvalUtils.isNullOrNone(urlObj) ? null : (String) urlObj;
|
|
return new DestinationRef(ref, type, url);
|
|
}
|
|
|
|
@StarlarkMethod(
|
|
name = "url",
|
|
doc = "Return the URL of this endpoint.",
|
|
structField = true,
|
|
allowReturnNones = true)
|
|
default String getUrl() {
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Returns an instance of this endpoint with the given console.
|
|
*/
|
|
default Endpoint withConsole(Console console) {
|
|
return this;
|
|
}
|
|
}
|