feat(plugins): filled in scaffolding

orca-api/orca-api.gradle

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2019 Armory, 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.
+ */
+
+apply from: "$rootDir/gradle/kotlin.gradle"
+apply from: "$rootDir/gradle/spock.gradle"
+
+test {
+  useJUnitPlatform {
+    includeEngines "junit-vintage", "junit-jupiter"
+  }
+}
+
+dependencies {
+  implementation("com.google.guava:guava")
+}

orca-api/src/main/java/com/netflix/spinnaker/orca/api/Stage.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2019 Armory, 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.netflix.spinnaker.orca.api;
+
+import com.google.common.annotations.Beta;
+
+@Beta
+public interface Stage<T> {
+  <T> StageOutput execute(StageInput<T> stageInput);
+
+  String getName();
+}

orca-api/src/main/java/com/netflix/spinnaker/orca/api/StageInput.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2019 Armory, 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.netflix.spinnaker.orca.api;
+
+import com.google.common.annotations.Beta;
+
+@Beta
+public class StageInput<T> {
+  private T value;
+
+  public StageInput(T value) {
+    this.value = value;
+  }
+
+  public void setValue(T value) {
+    this.value = value;
+  }
+
+  public T getValue() {
+    return this.value;
+  }
+}

orca-api/src/main/java/com/netflix/spinnaker/orca/api/StageOutput.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2019 Armory, 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.netflix.spinnaker.orca.api;
+
+import com.google.common.annotations.Beta;
+import java.util.Map;
+
+@Beta
+public class StageOutput {
+  private StageStatus status;
+
+  public void setStatus(StageStatus status) {
+    this.status = status;
+  }
+
+  public StageStatus getStatus() {
+    return this.status;
+  }
+
+  private Map outputs;
+
+  public void setOutputs(Map outputs) {
+    this.outputs = outputs;
+  }
+
+  public Map getOutputs() {
+    return this.outputs;
+  }
+}

orca-api/src/main/java/com/netflix/spinnaker/orca/api/StageStatus.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2019 Armory, 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.netflix.spinnaker.orca.api;
+
+import com.google.common.annotations.Beta;
+
+@Beta
+public enum StageStatus {
+  TERMINAL,
+  RUNNING,
+  COMPLETED,
+  NOT_STARTED
+}

orca-core/orca-core.gradle

@@ -32,6 +32,7 @@ dependencies {
   api("io.reactivex:rxjava")
 
   implementation(project(":orca-extensionpoint"))
+  implementation(project(":orca-api"))
   implementation("com.github.ben-manes.caffeine:guava")
   implementation("org.slf4j:slf4j-api")
   implementation("com.fasterxml.jackson.core:jackson-annotations")

orca-core/src/main/java/com/netflix/spinnaker/orca/StageResolver.java

@@ -18,10 +18,13 @@
 
 import static java.lang.String.format;
 
+import com.netflix.spinnaker.orca.api.Stage;
+import com.netflix.spinnaker.orca.pipeline.ApiStageDefinitionBuilder;
 import com.netflix.spinnaker.orca.pipeline.StageDefinitionBuilder;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Objects;
 import javax.annotation.Nonnull;
 
 /**
@@ -32,7 +35,8 @@
 public class StageResolver {
   private final Map<String, StageDefinitionBuilder> stageDefinitionBuilderByAlias = new HashMap<>();
 
-  public StageResolver(Collection<StageDefinitionBuilder> stageDefinitionBuilders) {
+  public StageResolver(
+      Collection<StageDefinitionBuilder> stageDefinitionBuilders, Collection<Stage> apiStages) {
     for (StageDefinitionBuilder stageDefinitionBuilder : stageDefinitionBuilders) {
       stageDefinitionBuilderByAlias.put(stageDefinitionBuilder.getType(), stageDefinitionBuilder);
       for (String alias : stageDefinitionBuilder.aliases()) {
@@ -48,6 +52,13 @@ public StageResolver(Collection<StageDefinitionBuilder> stageDefinitionBuilders)
         stageDefinitionBuilderByAlias.put(alias, stageDefinitionBuilder);
       }
     }
+
+    if (!Objects.equals(apiStages, null)) {
+      for (Stage stage : apiStages) {
+        ApiStageDefinitionBuilder builder = new ApiStageDefinitionBuilder(stage);
+        stageDefinitionBuilderByAlias.put(stage.getName(), builder);
+      }
+    }
   }
 
   /**

orca-core/src/main/java/com/netflix/spinnaker/orca/config/OrcaConfiguration.java

@@ -25,6 +25,7 @@
 import com.netflix.spinnaker.orca.StageResolver;
 import com.netflix.spinnaker.orca.Task;
 import com.netflix.spinnaker.orca.TaskResolver;
+import com.netflix.spinnaker.orca.api.Stage;
 import com.netflix.spinnaker.orca.commands.ForceExecutionCancellationCommand;
 import com.netflix.spinnaker.orca.events.ExecutionEvent;
 import com.netflix.spinnaker.orca.events.ExecutionListenerAdapter;
@@ -187,8 +188,9 @@ public TaskResolver taskResolver(Collection<Task> tasks) {
   }
 
   @Bean
-  public StageResolver stageResolver(Collection<StageDefinitionBuilder> stageDefinitionBuilders) {
-    return new StageResolver(stageDefinitionBuilders);
+  public StageResolver stageResolver(
+      Collection<StageDefinitionBuilder> stageDefinitionBuilders, Collection<Stage> apiStages) {
+    return new StageResolver(stageDefinitionBuilders, apiStages);
   }
 
   @Bean(name = EVENT_LISTENER_FACTORY_BEAN_NAME)

orca-core/src/main/java/com/netflix/spinnaker/orca/pipeline/ApiStageDefinitionBuilder.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2019 Armory, 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.netflix.spinnaker.orca.pipeline;
+
+import com.netflix.spinnaker.orca.pipeline.model.Stage;
+import javax.annotation.Nonnull;
+
+public class ApiStageDefinitionBuilder implements StageDefinitionBuilder {
+  private com.netflix.spinnaker.orca.api.Stage apiStage;
+
+  public ApiStageDefinitionBuilder(com.netflix.spinnaker.orca.api.Stage apiStage) {
+    this.apiStage = apiStage;
+  }
+
+  public void taskGraph(@Nonnull Stage stage, @Nonnull TaskNode.Builder builder) {
+    ApiTask task = new ApiTask(apiStage);
+    builder.withTask(apiStage.getName(), task.getClass());
+  }
+}

orca-core/src/main/java/com/netflix/spinnaker/orca/pipeline/ApiTask.java

@@ -0,0 +1,95 @@
+/*
+ * Copyright 2019 Armory, 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.netflix.spinnaker.orca.pipeline;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.netflix.spinnaker.orca.ExecutionStatus;
+import com.netflix.spinnaker.orca.Task;
+import com.netflix.spinnaker.orca.TaskResult;
+import com.netflix.spinnaker.orca.api.StageInput;
+import com.netflix.spinnaker.orca.api.StageOutput;
+import com.netflix.spinnaker.orca.jackson.OrcaObjectMapper;
+import com.netflix.spinnaker.orca.pipeline.model.Stage;
+import java.lang.reflect.Method;
+import java.lang.reflect.Type;
+import java.lang.reflect.TypeVariable;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+import javax.annotation.Nonnull;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.core.GenericTypeResolver;
+import org.springframework.core.ResolvableType;
+import org.springframework.stereotype.Component;
+
+@Slf4j
+@Component
+public class ApiTask implements Task {
+  private com.netflix.spinnaker.orca.api.Stage apiStage;
+
+  ApiTask(com.netflix.spinnaker.orca.api.Stage apiStage) {
+    this.apiStage = apiStage;
+  }
+
+  @Nonnull
+  public TaskResult execute(@Nonnull Stage stage) {
+    ObjectMapper objectMapper = OrcaObjectMapper.newInstance();
+
+    ExecutionStatus status;
+    StageOutput outputs = new StageOutput();
+
+    try {
+      List<Class<?>> cArg = Arrays.asList(StageInput.class);
+      Method method = apiStage.getClass().getMethod("execute", cArg.toArray(new Class[0]));
+      Type inputType = ResolvableType.forMethodParameter(method, 0).getGeneric().getType();
+      Map<TypeVariable, Type> typeVariableMap =
+          GenericTypeResolver.getTypeVariableMap(apiStage.getClass());
+
+      StageInput stageInput =
+          new StageInput(
+              objectMapper.convertValue(
+                  stage.getContext(), GenericTypeResolver.resolveType(inputType, typeVariableMap)));
+      outputs = apiStage.execute(stageInput);
+      switch (outputs.getStatus()) {
+        case TERMINAL:
+          status = ExecutionStatus.TERMINAL;
+          break;
+        case RUNNING:
+          status = ExecutionStatus.RUNNING;
+          break;
+        case COMPLETED:
+          status = ExecutionStatus.SUCCEEDED;
+          break;
+        case NOT_STARTED:
+          status = ExecutionStatus.NOT_STARTED;
+          break;
+        default:
+          status = ExecutionStatus.FAILED_CONTINUE;
+          break;
+      }
+    } catch (Exception e) {
+      log.error("Cannot execute stage " + apiStage.getName());
+      log.error(e.getMessage());
+      status = ExecutionStatus.TERMINAL;
+    }
+
+    return TaskResult.builder(status)
+        .context(outputs.getOutputs())
+        .outputs(outputs.getOutputs())
+        .build();
+  }
+}

orca-web/orca-web.gradle

@@ -33,6 +33,7 @@ dependencies {
   implementation("net.logstash.logback:logstash-logback-encoder")
 
   implementation(project(":orca-core"))
+  implementation(project(":orca-api"))
   implementation(project(":orca-redis"))
   implementation(project(":orca-bakery"))
   implementation(project(":orca-clouddriver"))

settings.gradle

@@ -16,6 +16,7 @@
 
 include "orca-extensionpoint",
   "orca-core",
+  "orca-api",
   "orca-core-tck",
   "orca-redis",
   "orca-test-redis",