Add Ruby to Supported Runtime Enum (#866)

* Add Ruby to Supported Runtime Enum

* Ruby Project Template Changes

WIP: Unit tests may have a notion of a central Gemfile that isn't
compatible with per-function Gemfile pattern that `sam build` expects.

* Tweaks

Global Gemfile for tests. Gemfile in the function for use in tests.

Hat tip to lauratpa and her PR #860 which is the core of this part of
the change set.

* Ruby Init App in Working State

* fix: add integration tests for sam build - ruby

* bump: version bump aws-lambda-builders to 0.0.5

* fix: requests version pin and imports

* fix: string paths on Pathlib for py2

* fix: README - add references to build

requirements/base.txt

@@ -11,6 +11,6 @@ docker>=3.3.0
 dateparser~=0.7
 python-dateutil~=2.6
 pathlib2~=2.3.2; python_version<"3.4"
-requests~=2.20.0
-aws_lambda_builders==0.0.4
+requests==2.20.1
+aws_lambda_builders==0.0.5
 serverlessrepo==0.1.5

requirements/dev.txt

@@ -10,7 +10,6 @@ pylint==1.7.2
 pytest==3.0.7
 py==1.4.33
 mock==2.0.0
-requests==2.20.0
 parameterized==0.6.1
 pathlib2==2.3.2; python_version<"3.4"
 futures==3.2.0; python_version<"3.2.3"

samcli/lib/build/app_builder.py

@@ -57,6 +57,12 @@ def _get_workflow_config(runtime):
             dependency_manager="npm",
             application_framework=None,
             manifest_name="package.json")
+    elif runtime.startswith("ruby"):
+        return config(
+            language="ruby",
+            dependency_manager="bundler",
+            application_framework=None,
+            manifest_name="Gemfile")
     else:
         raise UnsupportedRuntimeException("'{}' runtime is not supported".format(runtime))
 

samcli/local/init/templates/cookiecutter-aws-sam-hello-ruby/README.md

@@ -1,6 +1,6 @@
 # Cookiecutter SAM for Ruby Lambda functions
 
-This is a [Cookiecutter](https://github.com/audreyr/cookiecutter) template to create a Serverless Hello World App based on Serverless Application Model (SAM) and Python.
+This is a [Cookiecutter](https://github.com/audreyr/cookiecutter) template to create a Serverless Hello World App based on Serverless Application Model (SAM) and Ruby.
 
 ## Recommendations
 

samcli/local/init/templates/cookiecutter-aws-sam-hello-ruby/{{cookiecutter.project_name}}/Gemfile

@@ -1,3 +1,8 @@
 source "https://rubygems.org"
 
 gem "httparty"
+
+group :test do
+  gem "test-unit"
+  gem "mocha"
+end

samcli/local/init/templates/cookiecutter-aws-sam-hello-ruby/{{cookiecutter.project_name}}/README.md

@@ -7,7 +7,8 @@ This is a sample template for {{ cookiecutter.project_name }} - Below is a brief
 ├── README.md                   <-- This instructions file
 ├── hello_world                 <-- Source code for a lambda function
 │   ├── app.rb                  <-- Lambda function code
-├── Gemfile                     <-- Ruby dependencies
+│   ├── Gemfile                 <-- Ruby function dependencies
+├── Gemfile                     <-- Ruby test/documentation dependencies
 ├── template.yaml               <-- SAM template
 └── tests                       <-- Unit tests
     └── unit
@@ -31,27 +32,27 @@ Setup Ruby Version Manager from [Ruby Version Manager](http://rvm.io/)
 Run following commands
 
 ```bash
-rvm install ruby-2.5.0
-rvm use ruby-2.5.0
-rvm --default use 2.5.0
+rvm install ruby-2.5.3
+rvm use ruby-2.5.3
+rvm --default use 2.5.3
 ```
 
+### Building the Project
 
-### Installing dependencies
+```sam-app``` comes with a Gemfile that defines the requirements and manages installing them. The `sam build` command will install the dependencies in your function Gemfile and vendor it for deployment.
 
-```sam-app``` comes with a Gemfile that defines the requirements and manages installing them.
-
-```bash
-gem install bundler
-bundle install
-bundle install --deployment --path hello_world/vendor/bundle
+```
+sam build
 ```
 
-* Step 1 installs ```bundler```which provides a consistent environment for Ruby projects by tracking and installing the exact gems and versions that are needed.
-* Step 2 creates a Gemfile.lock that locks down the versions and creates the full dependency closure.
-* Step 3 installs the gems to ```hello_world/vendor/bundle```.
+If your dependencies contain native modules that need to be compiled specifically for the operating system running on AWS Lambda, use this command to build inside a Lambda-like Docker container instead:
 
-**NOTE:** As you change your dependencies during development you'll need to make sure these steps are repeated in order to execute your Lambda and/or API Gateway locally.
+```
+sam build --use-container
+```
+By default, this command writes built artifacts to .aws-sam/build folder.
+
+**NOTE:** As you change your dependencies during development you'll need to run `sam build` again in order to execute your Lambda and/or API Gateway locally.
 
 ### Local development
 
@@ -124,20 +125,18 @@ aws cloudformation describe-stacks \
 
 ## Testing
 
-We use [Mocha](http://gofreerange.com/mocha/docs) for testing our code and you can install it using gem: ``gem install mocha`` 
-
-Next, we run our initial unit tests:
+Run our initial unit tests:
 
 ```bash
-ruby tests/unit/test_hello.rb
+ruby tests/unit/test_handler.rb
 ```
 
 **NOTE**: It is recommended to use a Ruby Version Manager to manage, and work with multiple ruby environments from interpreters to sets of gems
 # Appendix
 
 ## AWS CLI commands
 
-AWS CLI commands to package, deploy and describe outputs defined within the cloudformation stack:
+AWS CLI commands to package, deploy and describe outputs defined within the cloudformation stack after building:
 
 ```bash
 sam package \

samcli/local/init/templates/cookiecutter-aws-sam-hello-ruby/{{cookiecutter.project_name}}/hello_world/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "httparty"

samcli/local/init/templates/cookiecutter-aws-sam-hello-ruby/{{cookiecutter.project_name}}/hello_world/app.rb

@@ -73,11 +73,11 @@ def lambda_handler(event:, context:)
     raise error
   end
 
-  return {
-    :statusCode => response.code,
-    :body => {
-      :message => "Hello World!",
-      :location => response.body
+  {
+    statusCode: response.code,
+    body: {
+      message: "Hello World!",
+      location: response.body
     }.to_json
   }
 end

samcli/local/init/templates/cookiecutter-aws-sam-hello-ruby/{{cookiecutter.project_name}}/template.yaml

@@ -4,7 +4,7 @@ Description: >
     {{ cookiecutter.project_name }}
 
     Sample SAM Template for {{ cookiecutter.project_name }}
-    
+
 # More info about Globals: https://github.com/awslabs/serverless-application-model/blob/master/docs/globals.rst
 Globals:
     Function:

samcli/local/init/templates/cookiecutter-aws-sam-hello-ruby/{{cookiecutter.project_name}}/tests/unit/test_handler.rb

@@ -1,12 +1,12 @@
 require 'json'
 require 'test/unit'
 require 'mocha/test_unit'
+
 require_relative '../../hello_world/app'
 
 class HelloWorldTest < Test::Unit::TestCase
-
-  def setup
-    @event = { 
+  def event
+    {
       body: 'eyJ0ZXN0IjoiYm9keSJ9',
       resource: '/{proxy+}',
       path: '/path/to/resource',
@@ -22,24 +22,24 @@ def setup
         baz: 'qux'
       },
       headers: {
-        Accept: 'text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8',
-        Accept-Encoding: 'gzip, deflate, sdch',
-        Accept-Language: 'en-US,en;q=0.8',
-        Cache-Control: 'max-age=0',
-        CloudFront-Forwarded-Proto: 'https',
-        CloudFront-Is-Desktop-Viewer: 'true',
-        CloudFront-Is-Mobile-Viewer: 'false',
-        CloudFront-Is-SmartTV-Viewer: 'false',
-        CloudFront-Is-Tablet-Viewer: 'false',
-        CloudFront-Viewer-Country: 'US',
-        Host: '1234567890.execute-api.us-east-1.amazonaws.com',
-        Upgrade-Insecure-Requests: '1',
-        User-Agent: 'Custom User Agent String',
-        Via: '1.1 08f323deadbeefa7af34d5feb414ce27.cloudfront.net (CloudFront)',
-        X-Amz-Cf-Id: 'cDehVQoZnx43VYQb9j2-nvCh-9z396Uhbp027Y2JvkCPNLmGJHqlaA==',
-        X-Forwarded-For: '127.0.0.1, 127.0.0.2',
-        X-Forwarded-Port: '443',
-        X-Forwarded-Proto: 'https'
+        'Accept' => 'text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8',
+        'Accept-Encoding' => 'gzip, deflate, sdch',
+        'Accept-Language' => 'en-US,en;q=0.8',
+        'Cache-Control' => 'max-age=0',
+        'CloudFront-Forwarded-Proto' => 'https',
+        'CloudFront-Is-Desktop-Viewer' => 'true',
+        'CloudFront-Is-Mobile-Viewer' => 'false',
+        'CloudFront-Is-SmartTV-Viewer' => 'false',
+        'CloudFront-Is-Tablet-Viewer' => 'false',
+        'CloudFront-Viewer-Country' => 'US',
+        'Host' => '1234567890.execute-api.us-east-1.amazonaws.com',
+        'Upgrade-Insecure-Requests' => '1',
+        'User-Agent' => 'Custom User Agent String',
+        'Via' => '1.1 08f323deadbeefa7af34d5feb414ce27.cloudfront.net (CloudFront)',
+        'X-Amz-Cf-Id' => 'cDehVQoZnx43VYQb9j2-nvCh-9z396Uhbp027Y2JvkCPNLmGJHqlaA==',
+        'X-Forwarded-For' => '127.0.0.1, 127.0.0.2',
+        'X-Forwarded-Port' => '443',
+        'X-Forwarded-Proto' => 'https'
       },
       requestContext: {
         accountId: '123456789012',
@@ -49,17 +49,17 @@ def setup
         requestTime: '09/Apr/2015:12:34:56 +0000',
         requestTimeEpoch: 1428582896000,
         identity: {
-          cognitoIdentityPoolId: "null",
-          accountId: "null",
-          cognitoIdentityId: "null",
-          caller: "null",
-          accessKey: "null",
+          cognitoIdentityPoolId: 'null',
+          accountId: 'null',
+          cognitoIdentityId: 'null',
+          caller: 'null',
+          accessKey: 'null',
           sourceIp: '127.0.0.1',
-          cognitoAuthenticationType: "null",
-          cognitoAuthenticationProvider: "null",
-          userArn: "null",
+          cognitoAuthenticationType: 'null',
+          cognitoAuthenticationProvider: 'null',
+          userArn: 'null',
           userAgent: 'Custom User Agent String',
-          user: "null"
+          user: 'null'
         },
         path: '/prod/path/to/resource',
         resourcePath: '/{proxy+}',
@@ -68,24 +68,27 @@ def setup
         protocol: 'HTTP/1.1'
       }
     }
+  end
 
-    @mock_response = {
-      :statusCode => 200,
-      :body => {
-        message: "Hello World!",
-        location: "1.1.1.1"
+  def mock_response
+    Object.new.tap do |mock|
+      mock.expects(:code).returns(200)
+      mock.expects(:body).returns('1.1.1.1')
+    end
+  end
+
+  def expected_result
+    {
+      statusCode: 200,
+      body: {
+        message: 'Hello World!',
+        location: '1.1.1.1'
       }.to_json
     }
-
   end
 
   def test_lambda_handler
-    expects(:lambda_handler).with(event:@event, context:"").returns(@mock_response)
-    response = lambda_handler(event:@event, context:"")
-    json_body = JSON.parse(response[:body])
-
-    assert_equal(200, response[:statusCode])
-    assert_equal("Hello World!", json_body["message"])
-    assert_equal("1.1.1.1", json_body["location"])
+    HTTParty.expects(:get).with('http://checkip.amazonaws.com/').returns(mock_response)
+    assert_equal(lambda_handler(event: event, context: ''), expected_result)
   end
 end

tests/functional/local/apigw/test_local_apigw_service.py

@@ -630,7 +630,7 @@ def make_service(list_of_routes, function_provider, cwd):
 
 def make_service_response(port, method, scheme, resourcePath, resolvedResourcePath, pathParameters=None,
                           body=None, headers=None, queryParams=None, isBase64Encoded=False):
-    response_str = '{"httpMethod": "GET", "body": null, "resource": "/something/{event}", "requestContext": {"resourceId": "123456", "apiId": "1234567890", "resourcePath": "/something/{event}", "httpMethod": "GET", "requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef", "accountId": "123456789012", "stage": "prod", "identity": {"apiKey": null, "userArn": null, "cognitoAuthenticationType": null, "caller": null, "userAgent": "Custom User Agent String", "user": null, "cognitoIdentityPoolId": null, "cognitoAuthenticationProvider": null, "sourceIp": "127.0.0.1", "accountId": null}, "extendedRequestId": null, "path": "/something/{event}"}, "queryStringParameters": null, "headers": {"Host": "0.0.0.0:33651", "User-Agent": "python-requests/2.20.0", "Accept-Encoding": "gzip, deflate", "Accept": "*/*", "Connection": "keep-alive"}, "pathParameters": {"event": "event1"}, "stageVariables": null, "path": "/something/event1", "isBase64Encoded": false}' # NOQA
+    response_str = '{"httpMethod": "GET", "body": null, "resource": "/something/{event}", "requestContext": {"resourceId": "123456", "apiId": "1234567890", "resourcePath": "/something/{event}", "httpMethod": "GET", "requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef", "accountId": "123456789012", "stage": "prod", "identity": {"apiKey": null, "userArn": null, "cognitoAuthenticationType": null, "caller": null, "userAgent": "Custom User Agent String", "user": null, "cognitoIdentityPoolId": null, "cognitoAuthenticationProvider": null, "sourceIp": "127.0.0.1", "accountId": null}, "extendedRequestId": null, "path": "/something/{event}"}, "queryStringParameters": null, "headers": {"Host": "0.0.0.0:33651", "User-Agent": "python-requests/2.20.1", "Accept-Encoding": "gzip, deflate", "Accept": "*/*", "Connection": "keep-alive"}, "pathParameters": {"event": "event1"}, "stageVariables": null, "path": "/something/event1", "isBase64Encoded": false}' # NOQA
     response = json.loads(response_str)
 
     if body:

tests/integration/buildcmd/test_build_cmd.py

@@ -4,6 +4,10 @@
 import json
 import logging
 
+try:
+    from pathlib import Path
+except ImportError:
+    from pathlib2 import Path
 from parameterized import parameterized
 
 from samcli.yamlhelper import yaml_parse
@@ -192,3 +196,75 @@ def _verify_resource_property(self, template_path, logical_id, property, expecte
         with open(template_path, 'r') as fp:
             template_dict = yaml_parse(fp.read())
             self.assertEquals(expected_value, template_dict["Resources"][logical_id]["Properties"][property])
+
+
+class TestBuildCommand_RubyFunctions(BuildIntegBase):
+
+    EXPECTED_FILES_GLOBAL_MANIFEST = set()
+    EXPECTED_FILES_PROJECT_MANIFEST = {'app.rb'}
+    EXPECTED_RUBY_GEM = 'httparty'
+
+    FUNCTION_LOGICAL_ID = "Function"
+
+    @parameterized.expand([
+        ("ruby2.5", False),
+        ("ruby2.5", "use_container")
+    ])
+    def test_with_default_gemfile(self, runtime, use_container):
+        overrides = {"Runtime": runtime, "CodeUri": "Ruby"}
+        cmdlist = self.get_command_list(use_container=use_container,
+                                        parameter_overrides=overrides)
+
+        LOG.info("Running Command: {}".format(cmdlist))
+        process = subprocess.Popen(cmdlist, cwd=self.working_dir)
+        process.wait()
+
+        self._verify_built_artifact(self.default_build_dir, self.FUNCTION_LOGICAL_ID,
+                                    self.EXPECTED_FILES_PROJECT_MANIFEST, self.EXPECTED_RUBY_GEM)
+
+        self._verify_resource_property(str(self.built_template),
+                                       "OtherRelativePathResource",
+                                       "BodyS3Location",
+                                       os.path.relpath(
+                                           os.path.normpath(os.path.join(str(self.test_data_path), "SomeRelativePath")),
+                                           str(self.default_build_dir))
+                                       )
+
+    def _verify_built_artifact(self, build_dir, function_logical_id, expected_files, expected_modules):
+
+        self.assertTrue(build_dir.exists(), "Build directory should be created")
+
+        build_dir_files = os.listdir(str(build_dir))
+        self.assertIn("template.yaml", build_dir_files)
+        self.assertIn(function_logical_id, build_dir_files)
+
+        template_path = build_dir.joinpath("template.yaml")
+        resource_artifact_dir = build_dir.joinpath(function_logical_id)
+
+        # Make sure the template has correct CodeUri for resource
+        self._verify_resource_property(str(template_path),
+                                       function_logical_id,
+                                       "CodeUri",
+                                       function_logical_id)
+
+        all_artifacts = set(os.listdir(str(resource_artifact_dir)))
+        actual_files = all_artifacts.intersection(expected_files)
+        self.assertEquals(actual_files, expected_files)
+
+        ruby_version = None
+        ruby_bundled_path = None
+
+        # Walk through ruby version to get to the gem path
+        for dirpath, dirname, _ in os.walk(str(resource_artifact_dir.joinpath('vendor', 'bundle', 'ruby'))):
+            ruby_version = dirname
+            ruby_bundled_path = Path(dirpath)
+            break
+        gem_path = ruby_bundled_path.joinpath(ruby_version[0], 'gems')
+
+        self.assertTrue(any([True if self.EXPECTED_RUBY_GEM in gem else False for gem in os.listdir(str(gem_path))]))
+
+    def _verify_resource_property(self, template_path, logical_id, property, expected_value):
+
+        with open(template_path, 'r') as fp:
+            template_dict = yaml_parse(fp.read())
+            self.assertEquals(expected_value, template_dict["Resources"][logical_id]["Properties"][property])

tests/integration/testdata/buildcmd/Ruby/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "httparty"