chore(codebuild): added validation when using Windows Image #27946

sakurai-ryo · 2023-11-11T11:45:42Z

When using WINDOWS_SERVER_2019_CONTAINER, only MEDIUM and LARGE computeType is supported.
https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html

However, currently only ComputeType SMALL is validated.
This PR modified to generate an error when ComputeType is specified as X2_LARGE in WindowsBuildImage.

    new codebuild.Project(this, 'CodeBuildCdk', {
      source: codebuild.Source.codeCommit({ repository: codecommit.Repository.fromRepositoryName(this, "Repo", "sample") }),
      environment: {
        computeType: codebuild.ComputeType.X2_LARGE, // generate error in synth stage
        buildImage:  codebuild.WindowsBuildImage.WINDOWS_BASE_2_0
      }
    });

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

…tion

sakurai-ryo · 2023-11-11T12:07:21Z

packages/aws-cdk-lib/aws-codebuild/lib/project.ts

@@ -1965,6 +1965,8 @@ export class WindowsBuildImage implements IBuildImage {
  /**
   * The standard CodeBuild image `aws/codebuild/windows-base:2.0`, which is
   * based off Windows Server Core 2016.
+   *
+   * @deprecated `WindowsBuildImage.WIN_SERVER_CORE_2019_BASE_2_0` should be used instead.


Added @deprecated to WINDOWS_BASE_2_0.
Since WINDOWS_CONTAINER type is already deprecated, a new deployment of WINDOWS_BASE_2_0 will result in the following error.
The environment type WINDOWS_CONTAINER is deprecated for new projects or existing project environment updates. Please consider using Windows Server 2019 instead.

I could not find any mention of deprecation in the documentation, but Terraform has already deprecated it.
https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/codebuild_project#environment

This is not the main topic of this PR, so if it should be a separate PR, I will do so.

lpizzinidev

Thanks 👍
Just a small adjustment in my opinion.
Also, the deprecation message for WIN_SERVER_CORE_2016_BASE should be updated as well.

lpizzinidev · 2023-11-17T15:44:57Z

packages/aws-cdk-lib/aws-codebuild/lib/project.ts

    if (buildEnvironment.computeType === ComputeType.SMALL) {
      ret.push('Windows images do not support the Small ComputeType');
    }
+    if (buildEnvironment.computeType === ComputeType.X2_LARGE) {
+      ret.push('Windows images do not support the 2xLarge ComputeType');
+    }


Suggested change

if (buildEnvironment.computeType === ComputeType.SMALL) {

ret.push('Windows images do not support the Small ComputeType');

}

if (buildEnvironment.computeType === ComputeType.X2_LARGE) {

ret.push('Windows images do not support the 2xLarge ComputeType');

}

if (buildEnvironment.computeType === ComputeType.SMALL || buildEnvironment.computeType === ComputeType.X2_LARGE) {

ret.push(`Windows images do not support the '${buildEnvironment.computeType}' compute type`);

}

A bit cleaner.

sakurai-ryo · 2023-11-17T17:46:14Z

@lpizzinidev
Thank you for the correction!
Fixed them.

lpizzinidev

Thanks 👍

vinayak-kukreja

Hey, this is great! Thank you for your contribution.

mergify · 2023-11-27T22:42:33Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify · 2023-11-27T22:46:18Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

vinayak-kukreja · 2023-11-28T21:23:26Z

@Mergifyio update

mergify · 2023-11-28T21:23:32Z

update

✅ Branch has been successfully updated

…Type

aws-cdk-automation · 2023-11-28T21:50:44Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: fee4003
Result: SUCCEEDED
Build Logs (available for 30 days)

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

mergify · 2023-11-28T21:51:04Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

When using `WINDOWS_SERVER_2019_CONTAINER`, only MEDIUM and LARGE computeType is supported. https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html However, currently only ComputeType `SMALL` is validated. This PR modified to generate an error when ComputeType is specified as X2_LARGE in WindowsBuildImage. ```ts new codebuild.Project(this, 'CodeBuildCdk', { source: codebuild.Source.codeCommit({ repository: codecommit.Repository.fromRepositoryName(this, "Repo", "sample") }), environment: { computeType: codebuild.ComputeType.X2_LARGE, // generate error in synth stage buildImage: codebuild.WindowsBuildImage.WINDOWS_BASE_2_0 } }); ``` ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

sakurai-ryo added 3 commits November 11, 2023 19:38

chore(codebuild): add validation windows container computeType valida…

1f38355

…tion

chore(codebuild): changed WINDOWS_BASE_2_0 to deprecated

693e759

chore(codebuild): fixed to match existing test

a05397b

github-actions bot added p2 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK labels Nov 11, 2023

aws-cdk-automation requested a review from a team November 11, 2023 11:45

sakurai-ryo commented Nov 11, 2023

View reviewed changes

sakurai-ryo marked this pull request as ready for review November 11, 2023 12:44

sakurai-ryo changed the title ~~chore(codebuild): Added validation when using Windows Image~~ chore(codebuild): added validation when using Windows Image Nov 17, 2023

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Nov 17, 2023

lpizzinidev suggested changes Nov 17, 2023

View reviewed changes

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Nov 17, 2023

chore(codebuild): fixed for the review

4778351

lpizzinidev approved these changes Nov 18, 2023

View reviewed changes

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Nov 18, 2023

vinayak-kukreja approved these changes Nov 27, 2023

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Nov 27, 2023

Merge branch 'main' into add-validation-for-windows-container-compute…

fee4003

…Type

mergify bot merged commit 640817b into aws:main Nov 28, 2023
10 checks passed

github-actions bot mentioned this pull request Dec 1, 2023

Monthly PR metrics report - November 2023 #28212

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(codebuild): added validation when using Windows Image #27946

chore(codebuild): added validation when using Windows Image #27946

sakurai-ryo commented Nov 11, 2023

sakurai-ryo Nov 11, 2023 •

edited

Loading

lpizzinidev left a comment

lpizzinidev Nov 17, 2023

sakurai-ryo commented Nov 17, 2023

lpizzinidev left a comment

vinayak-kukreja left a comment

mergify bot commented Nov 27, 2023

mergify bot commented Nov 27, 2023

vinayak-kukreja commented Nov 28, 2023

mergify bot commented Nov 28, 2023

aws-cdk-automation commented Nov 28, 2023

mergify bot commented Nov 28, 2023

chore(codebuild): added validation when using Windows Image #27946

chore(codebuild): added validation when using Windows Image #27946

Conversation

sakurai-ryo commented Nov 11, 2023

sakurai-ryo Nov 11, 2023 • edited Loading

Choose a reason for hiding this comment

lpizzinidev left a comment

Choose a reason for hiding this comment

lpizzinidev Nov 17, 2023

Choose a reason for hiding this comment

sakurai-ryo commented Nov 17, 2023

lpizzinidev left a comment

Choose a reason for hiding this comment

vinayak-kukreja left a comment

Choose a reason for hiding this comment

mergify bot commented Nov 27, 2023

mergify bot commented Nov 27, 2023

vinayak-kukreja commented Nov 28, 2023

mergify bot commented Nov 28, 2023

✅ Branch has been successfully updated

aws-cdk-automation commented Nov 28, 2023

AWS CodeBuild CI Report

mergify bot commented Nov 28, 2023

sakurai-ryo Nov 11, 2023 •

edited

Loading