Skip to content

Commit

Permalink
fix: Corrected logic to enable additional secure properties to be pas…
Browse files Browse the repository at this point in the history 
…sed into a cloudhub v2 deployment request
  • Loading branch information
@djizatt-avio
djizatt-avio authored Nov 14, 2024
1 parent 14dd004 commit 846077f
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 276 deletions.
4 changes: 3 additions & 1 deletion ...vioconsulting/mule/deployment/api/models/deployment/RuntimeFabricDeploymentRequest.groovy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,9 @@ class RuntimeFabricDeploymentRequest extends ExchangeAppDeploymentRequest {
def secureProps = [:]
secureProps[CloudhubAppProperties.ANYPOINT_PLATFORM_CLIENT_SECRET] = anypointClientSecret
secureProps[cloudhubAppProperties.cryptoKeyProperty] = cryptoKey
this.appSecureProperties
if (appSecureProperties) {
secureProps += appSecureProperties
}

def result = [
// CloudHub's v2 API calls the Mule application the 'domain'
Expand Down
265 changes: 9 additions & 256 deletions ...java/com/avioconsulting/mule/deployment/api/models/CloudhubV2DeploymentRequestTest.groovy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,7 @@ import static org.hamcrest.MatcherAssert.assertThat
import static org.hamcrest.Matchers.equalTo
import static org.hamcrest.Matchers.is

class CloudhubV2DeploymentRequestTest implements MavenInvoke {

@BeforeAll
static void setup() {
buildApp()
}
class CloudhubV2DeploymentRequestTest {


WorkerSpecRequest getWorkerSpecBase() {
Expand All @@ -32,6 +27,8 @@ class CloudhubV2DeploymentRequestTest implements MavenInvoke {
@Test
void test_deploymentRequest_creation_ok() {

double vCoreSizeExpected = 0.1

def request = new CloudhubV2DeploymentRequest('DEV', null,
getWorkerSpecBase(),
'theKey', null,
Expand All @@ -41,6 +38,8 @@ class CloudhubV2DeploymentRequestTest implements MavenInvoke {
'1.2.3',
'f2ea2cb4-c600-4bb5-88e8-e952ff5591ee')

def appInfo = request.getCloudhubAppInfo()

request.with {
assertThat appName.baseAppName,
is(equalTo('new-app'))
Expand All @@ -53,254 +52,8 @@ class CloudhubV2DeploymentRequestTest implements MavenInvoke {
assertThat target,
is(equalTo('us-west-2'))
}
assertThat appInfo.target.deploymentSettings.enforceDeployingReplicasAcrossNodes, is(equalTo(true))
assertThat appInfo.target.deploymentSettings.persistentObjectStore, is(equalTo(false))
assertThat appInfo.application.vCores, is(equalTo(vCoreSizeExpected))
}

/**
* This case validates that the application to deploy doesn't contain spaces in it's name
* example: appName="some app name" is not a valid name. appName="my-app" is a valid one.
*/
@Test
void spaces_in_nametest_deploymentRequest_appName_should_not_contain_spaces() {

def exception = shouldFail {
new CloudhubV2DeploymentRequest('DEV', null,
getWorkerSpecBase(),
'theKey', null,
'theClientId',
'theSecret',
new ApplicationName('some app name', 'client', null),
'4.2.2',
'f2ea2cb4-c600-4bb5-88e8-e952ff5591ee')
}

MatcherAssert.assertThat('fail', exception.message.contains("Name must be alphanumeric with dashes allowed within"))
}

/**
* This case validates that a new CloudhubV2DeploymentRequest contains all the attributes correctly set by using
* getCloudhubAppInfo() method.
*/
// @Test
void test_getCloudhubAppInfo_only_required() {

def request = new CloudhubV2DeploymentRequest('DEV', null,
getWorkerSpecBase(),
'theKey', null,
'theClientId',
'theSecret',
new ApplicationName('new-app', null, null),
'2.2.9',
'f2ea2cb4-c600-4bb5-88e8-e952ff5591ee')
def appInfo = request.getCloudhubAppInfo()

assertThat appInfo,
is(equalTo([
name : 'new-app',
application: [
ref : [
groupId : 'f2ea2cb4-c600-4bb5-88e8-e952ff5591ee',
artifactId: 'new-app',
version : '2.2.9',
packaging : "jar"
],
desiredState : "STARTED",
configuration: [
"mule.agent.application.properties.service": [
applicationName : 'new-app',
properties : ['anypoint.platform.client_id' : 'theClientId', 'env': 'dev',
'anypoint.platform.visualizer.layer': 'null'],
secureProperties: ['anypoint.platform.client_secret': 'theSecret', 'crypto.key': 'theKey']
]
],
integrations : [
services: [
objectStoreV2: [
enabled: true

]
]
],
"vCores" : VCoresSize.vCore1GB.vCoresSize
],
target : [
targetId : null,
provider : "MC",
deploymentSettings: [
clustered : true,
updateStrategy : UpdateStrategy.rolling,
enforceDeployingReplicasAcrossNodes: true,
disableAmLogForwarding : false,
generateDefaultPublicUrl : true,
http : [
inbound: [
publicUrl : null,
pathRewrite : null,
lastMileSecurity : false,
forwardSslSession: false
]
],
jvm : [:],
outbound : [:],
runtime : [
version : '4.2.2',
releaseChannel: 'LTS',
java : '8'
],
tracingEnabled : false,
persistentObjectStore : false
],
replicas : 1
]]
))
}

// @Test
void test_deploymentRequest_getCloudhubAppInfo_ok() {

def request = new CloudhubV2DeploymentRequest('DEV', null,
new WorkerSpecRequest('us-west-2',
'4.2.2',
true,
true,
true,
UpdateStrategy.recreate,
true,
true,
VCoresSize.vCore15GB,
13,
true,
false,
20,
700,
"testUrl",
"testpath",
"EDGE",
"17",
true),
'theKey', null,
'theClientId',
'theSecret',
new ApplicationName('new-app', 'prefix', null),
'1.2.3',
'new-group-id',
["prop1": "value1", "prop2": "value2"],
["secureProp1": "secureValue1", "secureProp2": "secureValue2"])

request.setAutoDiscoveryId("apiId", "123")

def appInfo = request.getCloudhubAppInfo()

assertThat appInfo,
is(equalTo([
name : 'prefix-new-app',
application: [
ref : [
groupId : 'new-group-id',
artifactId: 'new-app',
version : '1.2.3',
packaging : "jar"
],
desiredState : "STARTED",
configuration: [
"mule.agent.application.properties.service": [
applicationName : 'new-app',
properties : [
apiId: '123',
prop1: 'value1',
prop2: 'value2'
],
secureProperties: [
secureProp1: 'secureValue1',
secureProp2: 'secureValue2'
]
]
],
integrations : [
services: [
objectStoreV2: [
enabled: true
]
]
],
"vCores" : VCoresSize.vCore15GB.vCoresSize
],
target : [
targetId : null,
provider : "MC",
deploymentSettings: [
persistentObjectStore : false,
clustered : true,
updateStrategy : UpdateStrategy.recreate,
enforceDeployingReplicasAcrossNodes: true,
disableAmLogForwarding : false,
generateDefaultPublicUrl : true,
http : [
inbound: [
publicUrl : 'testUrl',
pathRewrite : 'testpath',
forwardSslSession: true,
lastMileSecurity : true
]
],
jvm : [:],
outbound : [:],
runtime : [
version : '4.2.2',
releaseChannel: 'EDGE',
java : '17'
],
tracingEnabled : true
],
replicas : 13
]]))
}

/**
* This case validates that the name of application to deploy is not larger that the maximum required of 42 characters.
* however, this validation happens after build the final appName (normalizedAppName) like this: ${cloudhubAppprefix}-${appName}-${env} length should not larger than 42 characters.
* example: ApplicationName{ baseName=myVeryVeryVeryLargeApplicationName, prefix=someprefix, suffix=prod -> someprefix-myVeryVeryLargeApplicationName-prod is larger than 42 characters, it's not a valid name
*/
@Test
void test_deploymentRequest_appName_should_not_larger_than_required() {

def appName = 'app-myVeryVeryVeryLargeApplicationName'
def prefix = 'client'
def environment = 'DEV'
def exception = shouldFail {
new CloudhubV2DeploymentRequest(environment, null,
new WorkerSpecRequest('us-west-2',
'4.2.2', null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null),
'theKey', null,
'theClientId',
'theSecret',
new ApplicationName(appName, prefix, environment),
'4.2.2',
'f2ea2cb4-c600-4bb5-88e8-e952ff5591ee')
}

MatcherAssert.assertThat exception.message,
is(equalTo("Maximum size of application name is 42 and the provided name has 49 characters"))
}

@Test
void test_deploymentRequest_appName_empty() {

def appName = null
def environment = 'DEV'
def exception = shouldFail {
new CloudhubV2DeploymentRequest(environment, null,
new WorkerSpecRequest('us-west-2',
'4.2.2', null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null, null),
'theKey', null,
'theClientId',
'theSecret',
new ApplicationName(appName, null, null),
'4.2.2',
'f2ea2cb4-c600-4bb5-88e8-e952ff5591ee')
}

MatcherAssert.assertThat exception.message,
is(equalTo("Property applicationName.baseAppName is required for CloudHub 2.0 and RTF applications"))
}

}
}
Loading

0 comments on commit 846077f

Please sign in to comment.