fix(lambda): erroneous inline code support for ruby

[nija-at]

Commit Message

fix(lambda): erroneous inline code support for ruby (#6365)

See https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lambda-function-code.html#cfn-lambda-function-code-zipfile

fixes #6302

---

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

[rix0rrr]

In the CHANGELOG this will read as:

FIXES

• lambda: no inline code support for ruby

Which might be interpreted as "there used to be no inline support for Ruby but we fixed that". I'd prefer a clearer phrasing.

Maybe "Ruby erroneously advertises inline code support"

[iliapolo]

@nija-at Can we add some kind of test?

https://github.com/aws/aws-cdk/pull/6365/checks?check_run_id=455627583

I would imagine the following code should fail on instantiation, right?

new lambda.Function(stack, 'foobar', {
  code: new lambda.InlineCode('def handler(event:, context:) ; "success" ; end'),
  handler: 'index.handler',
  timeout: cdk.Duration.seconds(15),
  runtime: lambda.Runtime.RUBY_2_5
});

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
• Commit ID: a4cb7a4
• Result: FAILED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[nija-at]

I would imagine the following code should fail on instantiation, right?

Yes, this would previously fail on cdk deploy but would now fail earlier. No one should have a working CDK code with ruby and InlineCode.

can we add some kind of test?

There's no 'useful' test I can think of. Suggestions?

[iliapolo]

There's no 'useful' test I can think of. Suggestions?

I guess that depends where exactly the code will fail. But my suggestion is to add a validation in the lambda.Function constructor:

if (props.code instanceof InlineCode && !props.runtime.supportsInlineCode) {
  throw new ...
}

And then simply add a test to test.function.ts.

WDYT?

[iliapolo]

@nija-at I guess an even simpler test would be:

const rubyRuntime = lambda.Runtime.RUBY_2_5;
assert !rubyRuntime.supportsInlineCode 

That is assuming we have a test further down the line that validates we fail when defining inline code with an unsupported runtime.

[nija-at]

@iliapolo - sorry, but I don't find these to be useful tests. They are not testing any cyclomatic complexity, which is what unit tests should cover.
How would such a test have prevented this in the first place? The person who did this erroneously, would also erroneously add the test.

The only valuable test would be an integration test that attempts to deploy a stack and checks that the deployment succeeds. Unfortunately, we don't have a mechanism in place to do this during PR or pipeline builds.

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
• Commit ID: 854d6ae
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[mergify]

Thank you for contributing! Your pull request is now being automatically merged.

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
• Commit ID: 14a0ab4
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[mergify]

Thank you for contributing! Your pull request is now being automatically merged.