Skip to content

5.x.x app features #1351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aegliv wants to merge 2 commits into
base: 5.x.x
Choose a base branch
from
Open

5.x.x app features #1351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab50897
feat: adds schema support for app features
aegliv Mar 25, 2026
fd95e2c
refactor: Moves logic to manifestV3
aegliv Apr 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions ...rc/main/java/org/cloudfoundry/operations/applications/ApplicationManifestUtilsCommon.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@

package org.cloudfoundry.operations.applications;

import static java.util.Collections.emptyMap;
import org.cloudfoundry.util.tuple.Consumer2;
import org.yaml.snakeyaml.DumperOptions;
import org.yaml.snakeyaml.Yaml;
import reactor.core.Exceptions;

import java.io.IOException;
import java.io.InputStream;
Expand All @@ -36,10 +39,8 @@
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import org.cloudfoundry.util.tuple.Consumer2;
import org.yaml.snakeyaml.DumperOptions;
import org.yaml.snakeyaml.Yaml;
import reactor.core.Exceptions;

import static java.util.Collections.emptyMap;

/**
* Common base class for dealing with manifests
Expand Down Expand Up @@ -321,7 +322,7 @@ static Map<String, Object> getNamedObject(List<Object> array, String name) {
value ->
value instanceof Map
&& name.equals(
((Map<String, String>) value).get("name")))
((Map<String, String>) value).get("name")))
.findFirst()
.orElseGet(() -> getEmptyNamedObject(array, name));
}
Expand Down
29 changes: 21 additions & 8 deletions ...ns/src/main/java/org/cloudfoundry/operations/applications/ApplicationManifestUtilsV3.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,12 @@

package org.cloudfoundry.operations.applications;

import static java.util.Collections.emptyMap;
import static java.util.stream.Collectors.toMap;
import org.cloudfoundry.client.v3.Metadata;
import org.cloudfoundry.client.v3.processes.HealthCheckType;
import org.cloudfoundry.client.v3.processes.ReadinessHealthCheckType;
import org.yaml.snakeyaml.DumperOptions;
import org.yaml.snakeyaml.Yaml;
import reactor.core.Exceptions;

import java.io.IOException;
import java.io.OutputStream;
Expand All @@ -33,12 +37,9 @@
import java.util.TreeMap;
import java.util.regex.Pattern;
import java.util.stream.Stream;
import org.cloudfoundry.client.v3.Metadata;
import org.cloudfoundry.client.v3.processes.HealthCheckType;
import org.cloudfoundry.client.v3.processes.ReadinessHealthCheckType;
import org.yaml.snakeyaml.DumperOptions;
import org.yaml.snakeyaml.Yaml;
import reactor.core.Exceptions;

import static java.util.Collections.emptyMap;
import static java.util.stream.Collectors.toMap;

/**
* Utilities for dealing with {@link ManifestV3}s. Includes the functionality to transform to and from standard CLI YAML files.
Expand Down Expand Up @@ -156,6 +157,13 @@ private static ManifestV3Application.Builder toApplicationManifest(
Path root) {
toApplicationManifestCommon(application, variables, builder, root);

asMap(
application,
"features",
variables,
String::valueOf,
(k,v) -> builder.feature(k, Boolean.valueOf(v))
);
asList(
application,
"processes",
Expand Down Expand Up @@ -299,6 +307,11 @@ private static Map<String, Object> toYaml(ManifestV3 manifest) {
private static Map<String, Object> toApplicationYaml(ManifestV3Application application) {
Map<String, Object> yaml = ApplicationManifestUtilsCommon.toApplicationYaml(application);

putIfPresent(
yaml,
"features",
application.getFeatures()
);
putIfPresent(
yaml,
"processes",
Expand Down
15 changes: 13 additions & 2 deletions ...ations/src/main/java/org/cloudfoundry/operations/applications/_ManifestV3Application.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@

package org.cloudfoundry.operations.applications;

import org.cloudfoundry.AllowNulls;
import org.cloudfoundry.Nullable;
import org.immutables.value.Value;
import org.cloudfoundry.client.v3.Metadata;
import org.immutables.value.Value;

import java.util.List;
import java.util.Map;
Expand All @@ -36,6 +37,13 @@ abstract class _ManifestV3Application extends _ApplicationManifestCommon {
@Nullable
abstract Boolean getDefaultRoute();

/**
* Manage whether optional capabilities are enabled
*/
@AllowNulls
@Nullable
abstract Map<String, Object> getFeatures();

/**
* The metadata for this application
*/
Expand All @@ -61,6 +69,9 @@ abstract class _ManifestV3Application extends _ApplicationManifestCommon {
abstract List<ManifestV3Sidecar> getSidecars();

public abstract static class Builder implements _ApplicationManifestCommon.Builder {

abstract Builder feature(String key, Object value);
abstract Builder feature(Map.Entry<String, ? extends Object> entry);
abstract Builder features(@Nullable Map<String, ? extends Object> entries);
abstract Builder putAllFeatures(Map<String, ? extends Object> entries);
}
}
68 changes: 50 additions & 18 deletions ...rc/test/java/org/cloudfoundry/operations/applications/ApplicationManifestUtilsV3Test.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,61 @@
package org.cloudfoundry.operations.applications;

import static org.junit.jupiter.api.Assertions.*;
import org.cloudfoundry.client.v3.Metadata;
import org.cloudfoundry.client.v3.processes.ReadinessHealthCheckType;
import org.junit.jupiter.api.Test;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import org.cloudfoundry.client.v3.Metadata;
import org.cloudfoundry.client.v3.processes.ReadinessHealthCheckType;
import org.junit.jupiter.api.Test;
import java.util.Map;

import static org.junit.jupiter.api.Assertions.assertEquals;

class ApplicationManifestUtilsV3Test {
@Test
void testWithDockerApp() throws IOException {
ManifestV3 manifest =
ManifestV3.builder()
.application(
ManifestV3Application.builder()
.name("test-app")
.docker(Docker.builder().image("test-image").build())
.build())
.build();

assertSerializeDeserialize(manifest);
}

@Test
void testWithFeature() throws IOException {
ManifestV3 manifest =
ManifestV3.builder()
.application(
ManifestV3Application.builder()
.name("test-app")
.feature("file-based-vcap-services", true)
.build())
.build();

assertSerializeDeserialize(manifest);
}

@Test
void testWithFeatureAsMap() throws IOException {
Map<String, Boolean> features = new java.util.HashMap<>();
features.put("file-based-vcap-services", true);
ManifestV3 manifest =
ManifestV3.builder()
.application(
ManifestV3Application.builder()
.name("test-app")
.features(features)
.build())
.build();

assertSerializeDeserialize(manifest);
}

@Test
void testGenericApplication() throws IOException {
ManifestV3 manifest =
Expand Down Expand Up @@ -47,20 +93,6 @@ void testGenericApplication() throws IOException {
assertSerializeDeserialize(manifest);
}

@Test
void testWithDockerApp() throws IOException {
ManifestV3 manifest =
ManifestV3.builder()
.application(
ManifestV3Application.builder()
.name("test-app")
.docker(Docker.builder().image("test-image").build())
.build())
.build();

assertSerializeDeserialize(manifest);
}

@Test
void testWithMetadata() throws IOException {
ManifestV3 manifest =
Expand Down
77 changes: 68 additions & 9 deletions integration-test/src/test/java/org/cloudfoundry/operations/ApplicationsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,13 @@

package org.cloudfoundry.operations;

import static org.assertj.core.api.Assertions.assertThat;

import java.io.IOException;
import java.nio.file.Path;
import java.time.Duration;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import org.cloudfoundry.AbstractIntegrationTest;
import org.cloudfoundry.CleanupCloudFoundryAfterClass;
import org.cloudfoundry.CloudFoundryVersion;
import org.cloudfoundry.IfCloudFoundryVersion;
import org.cloudfoundry.client.CloudFoundryClient;
import org.cloudfoundry.client.v3.applications.ApplicationFeatureResource;
import org.cloudfoundry.client.v3.applications.ListApplicationFeaturesRequest;
import org.cloudfoundry.operations.applications.ApplicationDetail;
import org.cloudfoundry.operations.applications.ApplicationEnvironments;
import org.cloudfoundry.operations.applications.ApplicationEvent;
Expand Down Expand Up @@ -79,6 +72,7 @@
import org.cloudfoundry.operations.services.GetServiceInstanceRequest;
import org.cloudfoundry.operations.services.ServiceInstance;
import org.cloudfoundry.util.FluentMap;
import org.cloudfoundry.util.PaginationUtils;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
Expand All @@ -87,6 +81,16 @@
import reactor.core.publisher.Mono;
import reactor.test.StepVerifier;

import java.io.IOException;
import java.nio.file.Path;
import java.time.Duration;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;

import static org.assertj.core.api.Assertions.assertThat;

@CleanupCloudFoundryAfterClass
public final class ApplicationsTest extends AbstractIntegrationTest {

Expand Down Expand Up @@ -745,6 +749,61 @@ public void pushManifestV3() throws IOException {
.verify(Duration.ofMinutes(5));
}

@Test
@IfCloudFoundryVersion(
greaterThanOrEqualTo =
CloudFoundryVersion.PCF_4_v3)
public void pushManifestV3WithFeature() throws IOException {
String applicationName = this.nameFactory.getApplicationName();

final String featureKey = "ssh";
final boolean featureValue = false;
ManifestV3 manifest =
ManifestV3.builder()
.application(
ManifestV3Application.builder()
.buildpack("staticfile_buildpack")
.disk(512)
.healthCheckType(ApplicationHealthCheck.PORT)
.memory(64)
.name(applicationName)
.feature(featureKey, false)
.path(
new ClassPathResource("test-application.zip")
.getFile()
.toPath())
.build())
.build();

this.cloudFoundryOperations
.applications()
.pushManifestV3(PushManifestV3Request.builder().manifest(manifest).build())
.then(
this.cloudFoundryOperations
.applications()
.get(GetApplicationRequest.builder().name(applicationName).build()))

.map(ApplicationDetail::getId)
.flatMapMany(
applicationId ->
PaginationUtils.requestClientV3Resources(
page ->
this.cloudFoundryClient
.applicationsV3()
.listFeatures(
ListApplicationFeaturesRequest
.builder()
.applicationId(applicationId)
.page(page)
.build())))
.filter(feature -> featureKey.equals(feature.getName()))
.map(ApplicationFeatureResource::getEnabled)
.as(StepVerifier::create)
.expectNext(featureValue)
.expectComplete()
.verify(Duration.ofMinutes(5));
}

@Test
@IfCloudFoundryVersion(greaterThanOrEqualTo = CloudFoundryVersion.PCF_4_v2)
public void pushManifestV3WithMetadata() throws IOException {
Expand Down