feat(provider/cf): add bake cf manifest stage (#3886)

* WIP

* feat(provider/cf): add bake cf manifest stage

* fix imports and typos

* move code to bake module

* switch Netflix -> Armory

orca-bakery/orca-bakery.gradle

@@ -33,4 +33,9 @@ dependencies {
 
   testImplementation(project(":orca-test-groovy"))
   testImplementation("com.github.tomakehurst:wiremock:2.15.0")
+  testImplementation("org.junit.jupiter:junit-jupiter-api")
+  testImplementation("org.assertj:assertj-core")
+  testImplementation("org.mockito:mockito-core:2.25.0")
+
+  testRuntimeOnly("org.junit.jupiter:junit-jupiter-api")
 }

orca-bakery/src/main/groovy/com/netflix/spinnaker/orca/bakery/api/manifests/cf/BakeCloudFoundryManifestRequest.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2020 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.bakery.api.manifests.cf;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.netflix.spinnaker.kork.artifacts.model.Artifact;
+import com.netflix.spinnaker.orca.bakery.api.manifests.BakeManifestRequest;
+import com.netflix.spinnaker.orca.bakery.tasks.manifests.cf.BakeCloudFoundryManifestContext;
+import java.util.List;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class BakeCloudFoundryManifestRequest extends BakeManifestRequest {
+
+  @JsonProperty("manifestTemplate")
+  private Artifact manifestTemplate;
+
+  @JsonProperty("varsArtifacts")
+  private List<Artifact> varsArtifacts;
+
+  public BakeCloudFoundryManifestRequest(
+      BakeCloudFoundryManifestContext bakeCloudFoundryManifestContext,
+      Artifact manifestTemplate,
+      List<Artifact> varsArtifacts,
+      String outputArtifactName) {
+    super(
+        bakeCloudFoundryManifestContext.getTemplateRenderer(),
+        outputArtifactName,
+        bakeCloudFoundryManifestContext.getOutputName());
+    this.setManifestTemplate(manifestTemplate);
+    this.setVarsArtifacts(varsArtifacts);
+  }
+}

orca-bakery/src/main/groovy/com/netflix/spinnaker/orca/bakery/pipeline/cf/BakeCloudFoundryManifestStage.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2020 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.bakery.pipeline.cf;
+
+import com.netflix.spinnaker.orca.api.pipeline.graph.StageDefinitionBuilder;
+import com.netflix.spinnaker.orca.api.pipeline.graph.TaskNode;
+import com.netflix.spinnaker.orca.api.pipeline.models.StageExecution;
+import com.netflix.spinnaker.orca.bakery.tasks.manifests.cf.BakeCloudFoundryManifestTask;
+import com.netflix.spinnaker.orca.clouddriver.utils.CloudProviderAware;
+import com.netflix.spinnaker.orca.pipeline.tasks.artifacts.BindProducedArtifactsTask;
+import groovy.transform.CompileStatic;
+import javax.annotation.Nonnull;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Component;
+
+@Slf4j
+@Component
+@CompileStatic
+public class BakeCloudFoundryManifestStage implements StageDefinitionBuilder, CloudProviderAware {
+  @Override
+  public void taskGraph(@Nonnull StageExecution stage, @Nonnull TaskNode.Builder builder) {
+    builder
+        .withTask("bakeCloudFoundryManifest", BakeCloudFoundryManifestTask.class)
+        .withTask("bindProducedArtifacts", BindProducedArtifactsTask.class);
+  }
+}

orca-bakery/src/main/groovy/com/netflix/spinnaker/orca/bakery/tasks/manifests/cf/BakeCloudFoundryManifestContext.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2020 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.bakery.tasks.manifests.cf;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.netflix.spinnaker.kork.artifacts.model.ExpectedArtifact;
+import java.util.List;
+import lombok.Getter;
+
+@Getter
+public class BakeCloudFoundryManifestContext {
+
+  private final List<BakeCloudFoundryManifestTask.InputArtifact> inputArtifacts;
+  private final List<ExpectedArtifact> expectedArtifacts;
+  private final String outputName;
+  private final String templateRenderer = "CF";
+
+  public BakeCloudFoundryManifestContext(
+      @JsonProperty("inputArtifacts")
+          List<BakeCloudFoundryManifestTask.InputArtifact> inputArtifacts,
+      @JsonProperty("expectedArtifacts") List<ExpectedArtifact> expectedArtifact,
+      @JsonProperty("outputName") String outputName) {
+    this.inputArtifacts = inputArtifacts;
+    this.expectedArtifacts = expectedArtifact;
+    this.outputName = outputName;
+  }
+}

orca-bakery/src/main/groovy/com/netflix/spinnaker/orca/bakery/tasks/manifests/cf/BakeCloudFoundryManifestTask.java

@@ -0,0 +1,134 @@
+/*
+ * Copyright 2020 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.bakery.tasks.manifests.cf;
+
+import com.netflix.spinnaker.kork.artifacts.model.Artifact;
+import com.netflix.spinnaker.kork.artifacts.model.ExpectedArtifact;
+import com.netflix.spinnaker.orca.api.pipeline.RetryableTask;
+import com.netflix.spinnaker.orca.api.pipeline.TaskResult;
+import com.netflix.spinnaker.orca.api.pipeline.models.ExecutionStatus;
+import com.netflix.spinnaker.orca.api.pipeline.models.StageExecution;
+import com.netflix.spinnaker.orca.bakery.api.BakeryService;
+import com.netflix.spinnaker.orca.bakery.api.manifests.BakeManifestRequest;
+import com.netflix.spinnaker.orca.bakery.api.manifests.cf.BakeCloudFoundryManifestRequest;
+import com.netflix.spinnaker.orca.pipeline.util.ArtifactUtils;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.stream.Collectors;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import lombok.Data;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+
+@Component
+@Slf4j
+public class BakeCloudFoundryManifestTask implements RetryableTask {
+
+  @Nullable private final BakeryService bakery;
+
+  private final ArtifactUtils artifactUtils;
+
+  @Autowired
+  public BakeCloudFoundryManifestTask(ArtifactUtils artifactUtils, Optional<BakeryService> bakery) {
+    this.artifactUtils = artifactUtils;
+    this.bakery = bakery.orElse(null);
+  }
+
+  @Override
+  public long getBackoffPeriod() {
+    return 30000;
+  }
+
+  @Override
+  public long getTimeout() {
+    return 300000;
+  }
+
+  @Nonnull
+  @Override
+  public TaskResult execute(@Nonnull StageExecution stage) {
+
+    if (bakery == null) {
+      throw new IllegalStateException(
+          "A BakeryService must be configured in order to run a Bake Manifest task.");
+    }
+
+    BakeCloudFoundryManifestContext context = stage.mapTo(BakeCloudFoundryManifestContext.class);
+
+    if (context.getInputArtifacts() == null || context.getInputArtifacts().size() < 2) {
+      throw new IllegalArgumentException(
+          "There must be one manifest template and at least one variables artifact supplied");
+    }
+
+    List<Artifact> resolvedInputArtifacts =
+        context.getInputArtifacts().stream()
+            .map(
+                p -> {
+                  Artifact a =
+                      artifactUtils.getBoundArtifactForStage(stage, p.getId(), p.getArtifact());
+                  if (a == null) {
+                    throw new IllegalArgumentException(
+                        String.format(
+                            "Input artifact (id: %s, account: %s) could not be found in execution (id: %s).",
+                            p.getId(), p.getAccount(), stage.getExecution().getId()));
+                  }
+                  return ArtifactUtils.withAccount(a, p.getAccount());
+                })
+            .collect(Collectors.toList());
+
+    if (context.getExpectedArtifacts() == null || context.getExpectedArtifacts().size() > 1) {
+      throw new IllegalArgumentException(
+          "The CreateCloudFoundryManifest stage produces one embedded base64 artifact.  Please ensure that your stage"
+              + " config's `Produces Artifacts` section (`expectedArtifacts` field) contains exactly one artifact.");
+    }
+
+    ExpectedArtifact expectedArtifacts = context.getExpectedArtifacts().get(0);
+    String outputArtifactName = expectedArtifacts.getMatchArtifact().getName();
+
+    if (context.getOutputName() == null || !context.getOutputName().equals(outputArtifactName)) {
+      throw new IllegalArgumentException(
+          "The name of the output manifest is required and it must match the artifact name in the Produces Artifact section.");
+    }
+
+    BakeManifestRequest request =
+        new BakeCloudFoundryManifestRequest(
+            context,
+            resolvedInputArtifacts.get(0),
+            resolvedInputArtifacts.subList(1, resolvedInputArtifacts.size()),
+            outputArtifactName);
+
+    Artifact result = bakery.bakeManifest(request.getTemplateRenderer(), request);
+
+    Map<String, Object> outputs = new HashMap<>();
+    outputs.put("artifacts", Collections.singleton(result));
+    outputs.put("cloudProvider", "cloudfoundry"); // Needed for stat collection.
+
+    return TaskResult.builder(ExecutionStatus.SUCCEEDED).context(outputs).outputs(outputs).build();
+  }
+
+  @Data
+  static class InputArtifact {
+    String id;
+    String account;
+    Artifact artifact;
+  }
+}