Introduce support for Ruby

.github/workflows/publish-ruby.yml

@@ -0,0 +1,40 @@
+name: Publish Ruby Layers
+
+on:
+  push:
+    tags:
+      - v**_ruby
+
+jobs:
+  publish-ruby:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [3.2, 3.3]
+    steps:
+      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # tag v4.1.2
+      - name: Use Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@1198b074305f9356bd56dd4b311757cc0dab2f1c # tag v1.175.1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Check Tag
+        id: ruby-check-tag
+        run: |
+          if [[ ${{ github.event.ref }} =~ ^refs/tags/v[0-9]+(\.[0-9]+)*_ruby$ ]]; then
+              echo "match=true" >> $GITHUB_OUTPUT
+          fi
+      - name: Install Ruby Dependencies
+        run: bundle
+        working-directory: ruby
+      - name: Obtain Ruby version without the dot
+        id: ruby-version-without-dot
+        run: >-
+          echo "::set-output name=VERSION::$(
+            echo ${{ matrix.ruby-version }} | sed 's/\.//'
+          )"
+      - name: Publish layer
+        if: steps.ruby-check-tag.outputs.match == 'true'
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        run: make publish-ruby${{ steps.ruby-version-without-dot.outputs.VERSION }}-ci

.github/workflows/ruby.yml

@@ -0,0 +1,50 @@
+name: Ruby Layer CI
+
+on:
+  push:
+    branches: [master]
+    paths:
+        - 'ruby/**'
+  pull_request:
+    paths:
+        - 'ruby/**'
+  workflow_dispatch:
+    branches: [master]
+    paths:
+      - 'ruby/**'
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # tag v4.1.2
+      - uses: ruby/setup-ruby@1198b074305f9356bd56dd4b311757cc0dab2f1c # tag v1.175.1
+        with:
+          ruby-version: '3.3'
+      - run: bundle
+        working-directory: ruby
+      - run: rubocop
+        working-directory: ruby
+
+  unit:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # tag v4.1.2
+      - uses: ruby/setup-ruby@1198b074305f9356bd56dd4b311757cc0dab2f1c # tag v1.175.1
+        with:
+          ruby-version: '3.3'
+      # Node.js powers serverless-offline, used for unit tests
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+      - name: Install Node.js Dependencies
+        run: npm install
+        working-directory: ruby/test/support
+      - name: Install Ruby Depedencies
+        run: bundle
+        working-directory: ruby
+      - name: Run Unit Tests
+        run: bundle exec rake test
+        working-directory: ruby

Makefile

@@ -130,3 +130,41 @@ publish-nodejs20x-local: build-nodejs20x
 		-e AWS_PROFILE \
 		-v "${HOME}/.aws:/home/newrelic-lambda-layers/.aws" \
 		newrelic-lambda-layers-nodejs20x
+
+build-ruby32:
+	docker build \
+		--no-cache \
+		-t newrelic-lambda-layers-ruby32 \
+		-f ./dockerfiles/Dockerfile.ruby32 \
+		.
+
+publish-ruby32-ci: build-ruby32
+	docker run \
+		-e AWS_ACCESS_KEY_ID \
+		-e AWS_SECRET_ACCESS_KEY \
+		newrelic-lambda-layers-ruby32
+
+publish-ruby32-local: build-ruby32
+	docker run \
+		-e AWS_PROFILE \
+		-v "${HOME}/.aws:/home/newrelic-lambda-layers/.aws" \
+		newrelic-lambda-layers-ruby32
+
+build-ruby33:
+	docker build \
+		--no-cache \
+		-t newrelic-lambda-layers-ruby33 \
+		-f ./dockerfiles/Dockerfile.ruby33 \
+		.
+
+publish-ruby33-ci: build-ruby33
+	docker run \
+		-e AWS_ACCESS_KEY_ID \
+		-e AWS_SECRET_ACCESS_KEY \
+		newrelic-lambda-layers-ruby33
+
+publish-ruby33-local: build-ruby33
+	docker run \
+		-e AWS_PROFILE \
+		-v "${HOME}/.aws:/home/newrelic-lambda-layers/.aws" \
+		newrelic-lambda-layers-ruby33

README.md

@@ -26,19 +26,25 @@ cd ..
 ```
 
 ```
-cd nodejs;
+cd nodejs
 ./publish-layers.sh
 cd ..
 ```
 
 ```
-cd java;
+cd ruby
 ./publish-layers.sh
 cd ..
 ```
 
 ```
-cd extension;
+cd java
+./publish-layers.sh
+cd ..
+```
+
+```
+cd extension
 ./publish-layer.sh
 cd ..
 ```
@@ -68,6 +74,7 @@ These steps will help you configure the layers correctly:
 3. Update your functions handler to point to the newly attached layer in the console for your function:
   * Python: `newrelic_lambda_wrapper.handler`
   * Node: `newrelic-lambda-wrapper.handler`
+  * Ruby: `newrelic_lambda_wrapper.handler`
   * Java:
     * RequestHandler implementation: `com.newrelic.java.HandlerWrapper::handleRequest`
     * RequestStreamHandlerWrapper implementation: `com.newrelic.java.HandlerWrapper::handleStreamsRequest`

dockerfiles/Dockerfile.ruby32

@@ -0,0 +1,28 @@
+FROM ruby:3.2
+
+RUN apt update 
+
+# curl - downloads the prebuilt NR Lambda extension
+# python3/pip3 - for the AWS CLI
+# zip/unzip - for building AWS Lambda layers .zip files
+RUN apt install -y curl python3 python3-pip unzip zip
+
+RUN useradd -m newrelic-lambda-layers
+USER newrelic-lambda-layers
+WORKDIR /home/newrelic-lambda-layers
+RUN pip3 install -U awscli --user --no-cache-dir --break-system-packages
+ENV PATH /home/newrelic-lambda-layers/.local/bin/:$PATH
+
+# Ruby layer building depends on the shared `libBuild.sh` script but is
+# otherwise independent. Copy over only what we need to build Ruby layers.
+COPY --chown=newrelic-lambda-layers libBuild.sh .
+COPY --chown=newrelic-lambda-layers ruby ruby/
+
+WORKDIR ruby
+
+# Run ruby/bin/clean just in case Docker is being ran from a developer's
+# workstation and their git clone directory has some stray files that could
+# conflict.
+RUN ./bin/clean
+
+CMD ./publish-layers.sh ruby3.2

dockerfiles/Dockerfile.ruby33

@@ -0,0 +1,28 @@
+FROM ruby:3.3
+
+RUN apt update 
+
+# curl - downloads the prebuilt NR Lambda extension
+# python3/pip3 - for the AWS CLI
+# zip/unzip - for building AWS Lambda layers .zip files
+RUN apt install -y curl python3 python3-pip unzip zip
+
+RUN useradd -m newrelic-lambda-layers
+USER newrelic-lambda-layers
+WORKDIR /home/newrelic-lambda-layers
+RUN pip3 install -U awscli --user --no-cache-dir --break-system-packages
+ENV PATH /home/newrelic-lambda-layers/.local/bin/:$PATH
+
+# Ruby layer building depends on the shared `libBuild.sh` script but is
+# otherwise independent. Copy over only what we need to build Ruby layers.
+COPY --chown=newrelic-lambda-layers libBuild.sh .
+COPY --chown=newrelic-lambda-layers ruby ruby/
+
+WORKDIR ruby
+
+# Run ruby/bin/clean just in case Docker is being ran from a developer's
+# workstation and their git clone directory has some stray files that could
+# conflict.
+RUN ./bin/clean
+
+CMD ./publish-layers.sh ruby3.3

libBuild.sh

@@ -128,6 +128,12 @@ function layer_name_str() {
     "nodejs20.x")
       rt_part="NodeJS20X"
       ;;
+    "ruby3.2")
+      rt_part="Ruby32"
+      ;;
+    "ruby3.3")
+      rt_part="Ruby33"
+      ;;
     esac
 
     case $2 in
@@ -179,6 +185,9 @@ function s3_prefix() {
     "nodejs20.x")
       name="nr-nodejs20.x"
       ;;
+    "ruby3.3")
+      name="nr-ruby3.3"
+      ;;
     esac
 
     echo $name

ruby/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+dist/
+log/
+support/node_modules/
+support/log/
+Gemfile.lock

ruby/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2
+  Exclude:
+    - 'test/support/node_modules/**/*'
+
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'test/support/src/handler.rb'

ruby/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'newrelic_rpm'
+
+group :development do
+  gem 'minitest', '~> 5.22'
+  gem 'rake'
+  gem 'rubocop', '~> 1.60'
+end

ruby/README.md

@@ -0,0 +1,58 @@
+# New Relic AWS Lambda layer for wrapping Ruby Lambda functions
+
+## Overview
+
+This 'ruby' subdirectory contains content for building and publishing a
+New Relic's AWS Lambda layer for use with Ruby Lambda functions.
+
+The layer will include the latest stable version of the New Relic Ruby agent gem,
+`newrelic_rpm`, the latest New Relic Lambda
+[extension](https://github.com/newrelic/newrelic-lambda-extension),
+and the lightweight `newrelic_lambda_wrapper.rb` that wraps untouched customer
+Lambda functions for observability.
+
+A layer is created for every region, architecture, and Ruby runtime combination.
+
+
+## Layer building and publishing
+
+With Ruby v3.2 or v3.3 `bundle` binary in your path:
+
+```shell
+./publish_layers.sh ruby3.2
+
+# or
+
+./publish_layers.sh ruby3.3
+```
+
+
+## Developer instructions
+
+- Clone the repository and change to the 'ruby' directory
+- Run `bin/setup`
+- Run `bundle exec rake test` to run the unit tests
+
+NOTES:
+
+- To test Ruby agent changes that are available locally or on GitHub, alter
+  `Gemfile` accordingly.
+- `Gemfile.lock` is Git ignored so that the latest stable agent version is
+  always fetched
+- For alignment with the Node.js and Python content in this repository, the
+  [Serverless](https://www.serverless.com/) Node.js module and the
+  [serverless-offline](https://github.com/dherault/serverless-offline) plugin
+  are used for simulated AWS Lambda testing.
+- All Serverless related content can be found at `test/support`
+- A simple representation of a customer Lambda function is available at
+  `test/support/src/handler.rb`.
+- The customer Lambda function is referenced via the `NEW_RELIC_LAMBDA_HANDLER`
+  environment variable defined in `test/support/serverless.yml. That variable
+  is formatted as `<PATH_TO_RUBY_FILE>.<LAMBDA_HANDLER_RUBY_METHOD_NAME>`,
+  with the path part of the string optionally including the `.rb` file extension
+  part of the path.
+- While it is recommended that the system building new layers be set up to run
+  the same Ruby version as the layer is targetting, a simple `mv` hack currently
+  exists in `publish-layers.sh` that would allow say an instance of Ruby 3.3 to
+  build a Ruby 3.2 layer.
+- By default, the `ruby/publish-layers.sh` script will use the prebuilt extension version defined at `libBuild.sh` for the `EXTENSION_VERSION` variable. That variable can be changed to use other extension versions. To instead build a new extension from scratch, edit `ruby/publish-layers.sh` and point to a local git clone of the extension.

ruby/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'minitest/test_task'
+
+Minitest::TestTask.create(:test) do |t|
+  t.libs << 'test'
+  t.test_globs = ['test/**/*_test.rb']
+end
+
+task default: :test

ruby/bin/clean

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -Eeuo pipefail
+
+# for cleanup when conducting manual .zip file creation
+
+rm -rf .bundle dist ruby Gemfile.lock extensions preview-extensions*

ruby/bin/setup

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+set -Eeuo pipefail
+
+bin/clean
+
+if (command -v bundle >/dev/null); then
+  rm -rf .bundle
+  bundle install
+else
+  echo "'bundle' command not found!"
+  exit -1
+fi
+
+cd test/support
+npm install
+
+echo 'Setup complete'