Menu
AWS CodeBuild
User Guide (API Version 2016-10-06)

Node.js Hello World Sample for AWS CodeBuild

This Node.js sample tests whether an internal variable in code starts with the string Hello. It produces as build output a single file named HelloWorld.js.

Important

Running this sample may result in charges to your AWS account. These include possible charges for AWS CodeBuild and for AWS resources and actions related to Amazon S3, AWS KMS, and CloudWatch Logs. For more information, see AWS CodeBuild Pricing, Amazon S3 Pricing, AWS Key Management Service Pricing, and Amazon CloudWatch Pricing.

Running the Sample

To run this sample:

  1. On your local computer or instance, create the files as described in the Directory Structure and Files sections of this topic, and then upload them to an Amazon S3 input bucket or an AWS CodeCommit, GitHub, or Bitbucket repository.

    Important

    Do not upload (root directory name), just the files inside of (root directory name).

    If you are using an Amazon S3 input bucket, be sure to create a ZIP file that contains the files, and then upload it to the input bucket. Do not add (root directory name) to the ZIP file, just the files inside of (root directory name).

  2. Create a build project, run the build, and view related build information by following the steps in Run AWS CodeBuild Directly.

    If you use the AWS CLI to create the build project, the JSON-formatted input to the start-build command might look similar to this. (Replace the placeholders with your own values.)

    Copy
    { "name": "sample-nodejs-project", "source": { "type": "S3", "location": "codebuild-region-ID-account-ID-input-bucket/NodeJSSample.zip" }, "artifacts": { "type": "S3", "location": "codebuild-region-ID-account-ID-output-bucket", "packaging": "ZIP", "name": "NodeJSOutputArtifact.zip" }, "environment": { "type": "LINUX_CONTAINER", "image": "aws/codebuild/nodejs:6.3.1", "computeType": "BUILD_GENERAL1_SMALL" }, "serviceRole": "arn:aws:iam::account-ID:role/role-name", "encryptionKey": "arn:aws:kms:region-ID:account-ID:key/key-ID" }
  3. To get the build output artifact, open your Amazon S3 output bucket.

  4. Download the NodeJSOutputArtifact.zip file to your local computer or instance, and then extract the contents of the file. In the extracted contents, get the HelloWorld.js file.

Directory Structure

This sample assumes this directory structure.

Copy
(root directory name) |-- buildspec.yml `-- HelloWorld.js

Files

This sample uses these files.

buildspec.yml (in (root directory name))

Copy
version: 0.2 phases: install: commands: - echo Installing Mocha... - npm install -g mocha pre_build: commands: - echo Installing source NPM dependencies... - npm install unit.js build: commands: - echo Build started on `date` - echo Compiling the Node.js code - mocha HelloWorld.js post_build: commands: - echo Build completed on `date` artifacts: files: - HelloWorld.js

HelloWorld.js (in (root directory name))

Copy
var test = require('unit.js'); var str = 'Hello, world!'; test.string(str).startsWith('Hello'); if (test.string(str).startsWith('Hello')) { console.log('Passed'); }

Related Resources