Remove claims about electron working.

Revert to only supporting chromium.

Add basic SAM template for deployment.

Author: magJ

.gitignore

@@ -1,3 +1,5 @@
 node_modules
 .idea
 /cypress/
+samconfig.toml
+.aws-sam/

Dockerfile

@@ -13,7 +13,7 @@ RUN yum install -y \
     binutils && \
     yum clean all
 
-# Install chromium, not nessesary if using cypress's embedded electron
+# Install chromium
 RUN yum install -y \
     amazon-linux-extras && \
     amazon-linux-extras install epel -y && \
@@ -36,7 +36,8 @@ COPY tests ./tests
 COPY src ./src
 RUN npx cypress verify
 RUN npx tsc
-RUN rm cypress.config.js
+
+ENV ELECTRON_EXTRA_LAUNCH_ARGS="--no-zygote --disable-gpu --single-process"
 
 # Only used for local testing of unprivleged users, lambda will create it's own user
 RUN /sbin/adduser testuser

README.md

@@ -1,6 +1,6 @@
 # Cypress on AWS lambda example
 
-A demonstration of how to run cypress on AWS lambda, using electron and/or chromium.
+A demonstration of how to run cypress on AWS lambda, using chromium.
 
 I've tried to make this as minimal as possible, but there might be some ways this could be simplified further.
 
@@ -9,12 +9,17 @@ I've tried to make this as minimal as possible, but there might be some ways thi
 similar(although not identical) to how it would be run from lambda.
 
 Once the image is built you will have to push it to an ECR repo, and create your lambda function.
-
 A lambda with 2GB of ram seems to work ok.
 
+### Using SAM
+A basic SAM template is included, with which you can deploy the lambda
+```bash
+# Build image
+sam build
+# Interactive deployment wizard
+sam deploy --guided
+```
+
 ## Things of note
 If you want to save screenshots or video, you may need to run the project from the tmp dir, 
 see the initial commit for an example of this.
-
-If you don't want to use electron, you can avoid patching it's binary, although you will still need to set some environment variables
-See the documentation in the `patch-cypress.sh` file.

patch-cypress.sh

@@ -7,10 +7,8 @@ for cypress_version_dir in "$cypress_cache_dir"/*; do
   cypress_electron_binary_location="$cypress_version_dir/Cypress/Cypress"
   # Patches cypress's electron binary to replace references to /dev/shm to /tmp/shm, as /dev/shm isn't writable on lambda
   #
-  # If this is too hacky for you, and you want to use another browser like chromium.
-  # You will need still to set ELECTRON_EXTRA_LAUNCH_ARGS="--no-zygote --disable-gpu --single-process"
-  # Because electron is still invoked in the cypress initialization process, regardless of if you intent to use it or not
-  # The above environment variables will be enough for the electron initialization to proceed, and avoid the need to patch
+  # Alternatively setting ELECTRON_EXTRA_LAUNCH_ARGS="--no-zygote --disable-gpu --single-process", seems to be enough for
+  # cypress to make it past initialisation, and start chromium, but it still seems to occasionally crash
   position=$(strings -t d $cypress_electron_binary_location | grep "/dev/shm" | cut -d" " -f1)
   for i in $position; do
     echo -n "/tmp/shm/" | dd bs=1 of=$cypress_electron_binary_location seek="$i" conv=notrunc

src/lambdaHandler.ts

@@ -1,10 +1,6 @@
 import * as cypress from "cypress";
 
 export const handler = async () => {
-  console.log("Running cypress tests with electron");
-  await cypress.run({
-    headless: true,
-  });
   console.log("Running cypress tests with chromium");
   await cypress.run({
     headless: true,

template.yaml

@@ -0,0 +1,16 @@
+AWSTemplateFormatVersion: '2010-09-09'
+Transform: AWS::Serverless-2016-10-31
+
+Resources:
+  CypressLambda:
+    Type: AWS::Serverless::Function
+    Properties:
+      Timeout: 300
+      MemorySize: 2048
+      PackageType: Image
+      Architectures:
+        - x86_64
+    Metadata:
+      DockerTag: sam-cypress-lambda-example
+      DockerContext: .
+      Dockerfile: Dockerfile

tsconfig.json

@@ -21,5 +21,6 @@
     "strictPropertyInitialization": false,
     "typeRoots": ["./node_modules/@types"]
   },
-  "exclude": ["node_modules"]
+  "exclude": ["node_modules"],
+  "include": ["src"]
 }