Merge branch '1007-default-domain' into 3.x

Author: twoseat

cloudfoundry-client-reactor/src/main/java/org/cloudfoundry/reactor/client/v3/organizations/ReactorOrganizationsV3.java

@@ -20,6 +20,8 @@
 import org.cloudfoundry.client.v3.organizations.AssignOrganizationDefaultIsolationSegmentResponse;
 import org.cloudfoundry.client.v3.organizations.CreateOrganizationRequest;
 import org.cloudfoundry.client.v3.organizations.CreateOrganizationResponse;
+import org.cloudfoundry.client.v3.organizations.GetOrganizationDefaultDomainRequest;
+import org.cloudfoundry.client.v3.organizations.GetOrganizationDefaultDomainResponse;
 import org.cloudfoundry.client.v3.organizations.GetOrganizationDefaultIsolationSegmentRequest;
 import org.cloudfoundry.client.v3.organizations.GetOrganizationDefaultIsolationSegmentResponse;
 import org.cloudfoundry.client.v3.organizations.GetOrganizationRequest;
@@ -74,6 +76,12 @@ public Mono<GetOrganizationResponse> get(GetOrganizationRequest request) {
             .checkpoint();
     }
 
+    @Override
+    public Mono<GetOrganizationDefaultDomainResponse> getDefaultDomain(GetOrganizationDefaultDomainRequest request) {
+        return get(request, GetOrganizationDefaultDomainResponse.class, builder -> builder.pathSegment("organizations", request.getOrganizationId(), "domains", "default"))
+            .checkpoint();
+    }
+
     @Override
     public Mono<GetOrganizationDefaultIsolationSegmentResponse> getDefaultIsolationSegment(GetOrganizationDefaultIsolationSegmentRequest request) {
         return get(request, GetOrganizationDefaultIsolationSegmentResponse.class, builder ->

cloudfoundry-client/src/main/java/org/cloudfoundry/client/v3/_ToOneRelationship.java

@@ -18,6 +18,7 @@
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import org.cloudfoundry.Nullable;
 import org.immutables.value.Value;
 
 /**
@@ -30,6 +31,7 @@ abstract class _ToOneRelationship {
     /**
      * The relationship data
      */
+    @Nullable
     @JsonProperty("data")
     abstract Relationship getData();
 

cloudfoundry-client/src/main/java/org/cloudfoundry/client/v3/domains/Domain.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2013-2019 the original author or authors.
+ *
+ * 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 org.cloudfoundry.client.v3.domains;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import org.cloudfoundry.Nullable;
+import org.cloudfoundry.client.v3.Metadata;
+import org.cloudfoundry.client.v3.Resource;
+
+public abstract class Domain extends Resource {
+
+    /**
+     * Metadata applied to the domain.
+     */
+    @JsonProperty("metadata")
+    @Nullable
+    public abstract Metadata getMetadata();
+
+    /**
+     * The name of the domain.
+     * Must be between 3 ~ 253 characters and follow <a href="https://tools.ietf.org/html/rfc1035">RFC 1035</a>.
+     */
+    @JsonProperty("name")
+    public abstract String getName();
+
+    /**
+     * Relationships of the domain.
+     */
+    @JsonProperty("relationships")
+    public abstract DomainRelationships getRelationships();
+
+    /**
+     * Whether the domain is used for internal (container-to-container) traffic.
+     */
+    @JsonProperty("internal")
+    public abstract boolean isInternal();
+
+}

cloudfoundry-client/src/main/java/org/cloudfoundry/client/v3/domains/_DomainRelationships.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2013-2019 the original author or authors.
+ *
+ * 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 org.cloudfoundry.client.v3.domains;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import org.cloudfoundry.client.v3.ToManyRelationship;
+import org.cloudfoundry.client.v3.ToOneRelationship;
+import org.immutables.value.Value;
+
+@JsonDeserialize
+@Value.Immutable
+abstract class _DomainRelationships {
+
+    /**
+     * The organization the domain is scoped to. If set, the domain will only be available in that organization.
+     * Otherwise, the domain will be globally available.
+     */
+    @JsonProperty("organization")
+    abstract ToOneRelationship getOrganization();
+
+    /**
+     * Organizations the domain is shared with. If set, the domain will be available in these organizations in addition
+     * to the organization the domain is scoped to.
+     */
+    @JsonProperty("shared_organizations")
+    abstract ToManyRelationship getSharedOrganizations();
+
+}

cloudfoundry-client/src/main/java/org/cloudfoundry/client/v3/organizations/OrganizationsV3.java

@@ -47,6 +47,14 @@ public interface OrganizationsV3 {
      */
     Mono<GetOrganizationResponse> get(GetOrganizationRequest request);
 
+    /**
+     * Makes the <a href="https://v3-apidocs.cloudfoundry.org/version/3.76.0/index.html#get-default-domain">List Organizations</a> request
+     *
+     * @param request the List Organizations request
+     * @return the response from the List Organizations request
+     */
+    Mono<GetOrganizationDefaultDomainResponse> getDefaultDomain(GetOrganizationDefaultDomainRequest request);
+
     /**
      * Makes the <a href="https://v3-apidocs.cloudfoundry.org/version/3.27.0/index.html#get-default-isolation-segment">Get Default Isolation Segment</a> request
      *

cloudfoundry-client/src/main/java/org/cloudfoundry/client/v3/organizations/_GetOrganizationDefaultDomainRequest.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2013-2019 the original author or authors.
+ *
+ * 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 org.cloudfoundry.client.v3.organizations;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import org.immutables.value.Value;
+
+@Value.Immutable
+abstract class _GetOrganizationDefaultDomainRequest {
+
+    /**
+     * The organization id
+     */
+    @JsonIgnore
+    abstract String getOrganizationId();
+
+}

cloudfoundry-client/src/main/java/org/cloudfoundry/client/v3/organizations/_GetOrganizationDefaultDomainResponse.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2013-2019 the original author or authors.
+ *
+ * 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 org.cloudfoundry.client.v3.organizations;
+
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import org.cloudfoundry.client.v3.domains.Domain;
+import org.immutables.value.Value;
+
+@JsonDeserialize
+@Value.Immutable
+abstract class _GetOrganizationDefaultDomainResponse extends Domain {
+
+}

cloudfoundry-client/src/test/java/org/cloudfoundry/client/v3/ToOneRelationshipTest.java

@@ -20,18 +20,10 @@
 
 public final class ToOneRelationshipTest {
 
-    @Test(expected = IllegalStateException.class)
-    public void noData() {
-        ToOneRelationship.builder()
-            .build();
-    }
-
     @Test
     public void valid() {
         ToOneRelationship.builder()
-            .data(Relationship.builder()
-                .id("test-id")
-                .build())
             .build();
     }
+
 }

integration-test/src/test/java/org/cloudfoundry/client/v3/OrganizationsTest.java

@@ -28,6 +28,8 @@
 import org.cloudfoundry.client.v3.organizations.AssignOrganizationDefaultIsolationSegmentResponse;
 import org.cloudfoundry.client.v3.organizations.CreateOrganizationRequest;
 import org.cloudfoundry.client.v3.organizations.CreateOrganizationResponse;
+import org.cloudfoundry.client.v3.organizations.GetOrganizationDefaultDomainRequest;
+import org.cloudfoundry.client.v3.organizations.GetOrganizationDefaultDomainResponse;
 import org.cloudfoundry.client.v3.organizations.GetOrganizationDefaultIsolationSegmentRequest;
 import org.cloudfoundry.client.v3.organizations.GetOrganizationRequest;
 import org.cloudfoundry.client.v3.organizations.GetOrganizationResponse;
@@ -110,6 +112,23 @@ public void get() {
             .verify(Duration.ofMinutes(5));
     }
 
+    @IfCloudFoundryVersion(greaterThanOrEqualTo = CloudFoundryVersion.PCF_2_7)
+    @Test
+    public void getDefaultDomain() {
+        String organizationName = this.nameFactory.getOrganizationName();
+
+        createOrganizationId(this.cloudFoundryClient, organizationName)
+            .flatMap(organizationId -> this.cloudFoundryClient.organizationsV3()
+                .getDefaultDomain(GetOrganizationDefaultDomainRequest.builder()
+                    .organizationId(organizationId)
+                    .build()))
+            .map(GetOrganizationDefaultDomainResponse::getName)
+            .as(StepVerifier::create)
+            .consumeNextWith(name -> assertThat(name).contains("apps.", ".springapps.io"))
+            .expectComplete()
+            .verify(Duration.ofMinutes(5));
+    }
+
     @Test
     public void getDefaultIsolationSegment() {
         String isolationSegmentName = this.nameFactory.getIsolationSegmentName();