ruby2.7 / pg shared libs, update readme instructions (#89)

* add postgres required shared lib, update readme instructions * fix: update to ruby2.7 runtime * update run steps * chore: add additional pg deps, updates yarn deps
pact-foundation · May 5, 2022 · 25c1e77 · 25c1e77
1 parent 70d6396
commit 25c1e77
Show file tree

Hide file tree

Showing 20 changed files with 2,724 additions and 2,964 deletions.
diff --git a/.gitignore b/.gitignore
@@ -7,4 +7,4 @@ vendor/bundle
 .DS_Store
 .bundle/config
 .env
-lib/
+pact_broker
diff --git a/.slsignore b/.slsignore
@@ -1,6 +1,5 @@
 rubypg_layer/**
 node_modules/**
-.serverless/**
 .circleci/**
 .bundle/**
 .gitignore

diff --git a/Dockerfile b/Dockerfile
@@ -1,9 +1,9 @@
-FROM lambci/lambda:build-ruby2.5
+FROM lambci/lambda:build-ruby2.7
 
-RUN yum install -y postgresql postgresql-devel 
-RUN yum install -y postgresql postgresql-devel mysql-devel
+RUN yum install -y postgresql postgresql-devel mysql-devel sqlite-devel
 
 ADD pact_broker/Gemfile /var/task/Gemfile
 ADD pact_broker/Gemfile.lock /var/task/Gemfile.lock
-
+# hack because pg isnt pinned
+RUN sed -i 's/gem "pg", "~>1.0"/gem "pg", "1.2.3"/g' /var/task/Gemfile
 RUN bundle install && bundle install --deployment
diff --git a/Makefile b/Makefile
@@ -14,10 +14,10 @@ buildpglayer:
 	cd rubypg_layer && ./build.sh
 
 deploypglayer:
-	cd rubypg_layer && sls deploy -v
+	cd rubypg_layer && npm run deploy -v
 
 logs:
 	awslogs get /aws/lambda/pact-broker-serverless-dev-api --profile=${AWS_PROFILE_NAME} 
 
 deploy:
-	sls deploy -v
+	npm run deploy
diff --git a/README.md b/README.md
@@ -7,9 +7,9 @@ _Caveat_ - This was an experimental POC and there are several open [issues](http
 
 ## Prerequisites
 
-* A running postgresql database and the ability to connect to it (see [POSTGRESQL.md][postgres]).
+* A running postgresql database and the ability to connect to it (instructions for that are outside of scope).
 * An AWS account
-* A custom domain in route 53 with a certificate
+* A custom domain in route 53 with a certificate (not required if using standard api gateway supplied endpoint)
 
 ## Getting Started
 
@@ -48,6 +48,7 @@ plugins:
 ## Running with Serverless
 
 1. Run `make downloadpb` which will download the latest version of the `pact_broker` folder from `pact-foundation/pact-broker-docker` _note_ this command will remove the old folder without futher warning.
+   1. MacOS user? : Run `make downloadpbmac` instead
 2. Run `make packagewithpg` to build the pact broker bundle dependencies and postgres dependencies in a docker container, and copy them to your `vendor` and `lib` folders.
    Alternatively you can run `make package` to build the pact broker bundle dependencies. You will need a custom aws layer with the postgres dependencies satisfied to run your function successfully. See the next section
 3. Run `yarn install` or delete the `.lock` file and run `npm install` if you prefer. This will install serverless, along with serverless-rack, serverless-ignore & serverless-domain-manager.

diff --git a/build-withpg.sh b/build-withpg.sh
@@ -5,13 +5,29 @@ set -e
 rm -rf lib && mkdir -p lib
 rm -rf vendor
 
-docker build -t ruby25-pg-builder -f Dockerfile .
+docker build -t ruby27-pg-builder -f Dockerfile .
 
-CONTAINER=$(docker run -d ruby25-pg-builder false)
+CONTAINER=$(docker run -d ruby27-pg-builder false)
 
 docker cp \
     $CONTAINER:/usr/lib64/libpq.so.5.5 \
     lib/libpq.so.5
+docker cp \
+    $CONTAINER:/usr/lib64/libpq.so.5.5 lib/libpq.so.5
+docker cp \
+    $CONTAINER:/usr/lib64/libldap_r-2.4.so.2.10.7 lib/libldap_r-2.4.so.2
+docker cp \
+    $CONTAINER:/usr/lib64/liblber-2.4.so.2.10.7 lib/liblber-2.4.so.2
+docker cp \
+    $CONTAINER:/usr/lib64/libsasl2.so.3.0.0 lib/libsasl2.so.3
+docker cp \
+    $CONTAINER:/usr/lib64/libssl3.so lib/
+docker cp \
+    $CONTAINER:/usr/lib64/libsmime3.so lib/
+docker cp \
+    $CONTAINER:/usr/lib64/libnss3.so lib/
+docker cp \
+    $CONTAINER:/usr/lib64/libnssutil3.so lib/
 
 docker cp \
     $CONTAINER:/var/task/vendor \

diff --git a/build-withpglayer.sh b/build-withpglayer.sh
@@ -4,9 +4,9 @@ set -e
 
 rm -rf vendor
 
-docker build -t ruby25-pg-builder -f Dockerfile .
+docker build -t ruby27-pg-builder -f Dockerfile .
 
-CONTAINER=$(docker run -d ruby25-pg-builder false)
+CONTAINER=$(docker run -d ruby27-pg-builder false)
 
 docker cp \
     $CONTAINER:/var/task/vendor \

diff --git a/lib/liblber-2.4.so.2 b/lib/liblber-2.4.so.2
diff --git a/lib/libldap_r-2.4.so.2 b/lib/libldap_r-2.4.so.2
diff --git a/lib/libnss3.so b/lib/libnss3.so
diff --git a/lib/libnssutil3.so b/lib/libnssutil3.so
diff --git a/lib/libpq.so.5 b/lib/libpq.so.5
diff --git a/lib/libsasl2.so.3 b/lib/libsasl2.so.3
diff --git a/lib/libsmime3.so b/lib/libsmime3.so
diff --git a/lib/libssl3.so b/lib/libssl3.so
diff --git a/package.json b/package.json
@@ -1,12 +1,12 @@
 {
   "name": "pact_broker-serverless",
   "version": "1.0.0",
-  "description": "Running the pact_broker application on AWS Lambda. It is tested with Ruby 2.5.x and bundler-1.17.x.",
+  "description": "Running the pact_broker application on AWS Lambda. It is tested with Ruby 2.7.x and bundler-1.17.x.",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "create-domain": "sls create_domain",
-    "deploy": "sls deploy"
+    "deploy": "sls deploy -v"
   },
   "repository": {
     "type": "git",
@@ -16,11 +16,12 @@
   "license": "ISC",
   "homepage": "https://github.com/you54f/pact_broker-serverless#readme",
   "devDependencies": {
-    "serverless": "1.74.1",
+    "serverless": "^2.72.3",
     "serverless-apigw-binary": "0.4.4",
-    "serverless-domain-manager": "4.1.1",
-    "serverless-ignore": "0.1.5",
-    "serverless-rack": "1.0.5"
+    "serverless-domain-manager": "6.0.3",
+    "serverless-ignore": "0.2.1",
+    "serverless-rack": "1.0.7",
+    "serverless-offline": "8.7.0"
   },
   "dependencies": {
   }

diff --git a/rubypg_layer/Dockerfile b/rubypg_layer/Dockerfile
@@ -1,4 +1,4 @@
-FROM lambci/lambda:build-ruby2.5
+FROM lambci/lambda:build-ruby2.7
 
 RUN yum install -y postgresql postgresql-devel
 

diff --git a/rubypg_layer/serverless.yml b/rubypg_layer/serverless.yml
@@ -5,8 +5,8 @@ provider:
   region: ${env:AWS_REGION}
 
 layers:
-  pgRuby25:
+  pgRuby27:
     path: layer
-    description: A Layer to fix postgres support in Ruby 2.5 Lambda functions
+    description: A Layer to fix postgres support in Ruby 2.7 Lambda functions
     compatibleRuntimes:
-      - ruby2.5
+      - ruby2.7
diff --git a/serverless.yml b/serverless.yml
@@ -2,7 +2,7 @@ service: pact-broker-serverless
 
 provider:
   name: aws
-  runtime: ruby2.5
+  runtime: ruby2.7
   region: ${env:AWS_REGION}
   environment:
     # API_GATEWAY_BASE_PATH: ${self:custom.customDomain.basePath}
@@ -11,7 +11,7 @@ provider:
     PACT_BROKER_DATABASE_HOST: ${env:PACT_BROKER_DATABASE_HOST}
     PACT_BROKER_DATABASE_NAME: ${env:PACT_BROKER_DATABASE_NAME}
     PACT_BROKER_LOG_LEVEL: ${env:PACT_BROKER_LOG_LEVEL}
-    PACT_BROKER_BASE_URL: ${env:PACT_BROKER_BASE_URL}
+    # PACT_BROKER_BASE_URL: ${env:PACT_BROKER_BASE_URL}
     RACK_ENV: production
     # PACT_BROKER_BASIC_AUTH_USERNAME: ${env:PACT_BROKER_BASIC_AUTH_USERNAME}
     # PACT_BROKER_BASIC_AUTH_PASSWORD: ${env:PACT_BROKER_BASIC_AUTH_PASSWORD}
@@ -21,18 +21,19 @@ provider:
 plugins:
   - serverless-rack
   - serverless-ignore
-  - serverless-domain-manager
+  # - serverless-domain-manager
   - serverless-apigw-binary
+  - serverless-offline
 
 functions:
   api:
     timeout: 30
     handler: rack_adapter.handler
-    layers:
-      - ${env:PG_RUBY_LAYER_ARN}
+    # layers:
+    #   - ${env:PG_RUBY_LAYER_ARN}
     events:
       - http: ANY /
-      - http: ANY {proxy+} 
+      - http: ANY /{proxy+} 
 
 custom:
   ignore: true
@@ -59,9 +60,9 @@ custom:
       - 'application/json'
       - 'application/hal+json'
       - 'application/xhtml+xml'
-  customDomain:
-    # basePath: pactbroker
-    domainName: ${env:SERVERLESS_DOMAIN_NAME}
-    certificateName: ${env:SERVERLESS_CERTIFICATE_NAME}
-    stage: dev
-    createRoute53Record: true
+  # customDomain:
+  #   # basePath: pactbroker
+  #   domainName: ${env:SERVERLESS_DOMAIN_NAME}
+  #   certificateName: ${env:SERVERLESS_CERTIFICATE_NAME}
+  #   stage: dev
+  #   createRoute53Record: true