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

Ruby Hello World Sample for AWS CodeBuild

This Ruby sample tests whether an internal variable in code contains the string Hello, world!. It produces as build output a single file named HelloWorld.rb.


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. 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.


    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 create-project command might look similar to this. (Replace the placeholders with your own values.)

    { "name": "sample-ruby-project", "source": { "type": "S3", "location": "codebuild-region-ID-account-ID-input-bucket/" }, "artifacts": { "type": "S3", "location": "codebuild-region-ID-account-ID-output-bucket", "packaging": "ZIP", "name": "" }, "environment": { "type": "LINUX_CONTAINER", "image": "aws/codebuild/ruby:2.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 file to your local computer or instance, and then extract the contents of the file. In the extracted contents, get the HelloWorld.rb file.

Directory Structure

This sample assumes this directory structure.

(root directory name) |-- buildspec.yml |-- HelloWorld.rb `-- HelloWorld_spec.rb


This sample uses these files.

buildspec.yml (in (root directory name))

version: 0.2 phases: install: commands: - echo Installing RSpec... - gem install rspec build: commands: - echo Build started on `date` - echo Compiling the Ruby code... - rspec HelloWorld_spec.rb post_build: commands: - echo Build completed on `date` artifacts: files: - HelloWorld.rb

HelloWorld.rb (in (root directory name))

class HelloWorld def say_hello() return 'Hello, world!' end end

HelloWorld_spec.rb (in (root directory name))

require './HelloWorld' describe HelloWorld do context "When testing the HelloWorld class" do it "The say_hello method should return 'Hello World'" do hw = message = hw.say_hello puts 'Succeed' if expect(message).to eq "Hello, world!" end end end

Related Resources