node-lambda 0.20.0 → 0.21.0

package/.github/workflows/workflow.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [10.x, 12.x, 14.x, 16.x]
+        node-version: [12.x, 14.x, 16.x, 17.x]
         os: [ubuntu-latest, windows-latest, macos-latest]
     steps:
     - uses: actions/checkout@v2

package/CHANGELOG.md

@@ -440,3 +440,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - fix(_uploadExisting): fix function update errors [#575](https://github.com/motdotla/node-lambda/pull/575)
 - test: fix npm install test failing in some cases [#569](https://github.com/motdotla/node-lambda/pull/569)
 - Clean the tmp dir during `_archivePrebuilt` to match `_buildAndArchive` behavior [#518](https://github.com/motdotla/node-lambda/pull/518)
+
+## [0.21.0] - 2021-11-10
+### Features
+- feat: support for yarn [#581](https://github.com/motdotla/node-lambda/pull/581)

package/README.md

@@ -64,6 +64,7 @@ $ echo -e ".env\ndeploy.env\nevent.json\n.lambda" >> .gitignore
 ##### Deploy env variables
 
 ```
+PACKAGE_MANAGER            // (default: 'npm')
 AWS_ENVIRONMENT            // (default: '')
 AWS_ENDPOINT               // (default: '')
 CONFIG_FILE                // (default: '')
@@ -109,23 +110,21 @@ Runs your Amazon Lambda index.js file locally. Passes `event.json` data to the A
 
 ```
 $ node-lambda run --help
-
-Usage: run|execute [options]
+Usage: node-lambda run|execute [options]
 
 Run your Amazon Lambda application locally
 
-
 Options:
-  -h, --help                            output usage information
-  -H, --handler [index.handler]         Lambda Handler {index.handler}
-  -j, --eventFile [event.json]          Event JSON File
-  -u, --runtime [nodejs14.x]            Lambda Runtime
-  -t, --timeout [3]                     Lambda Timeout
-  -f, --configFile []                   Path to file holding secret environment variables (e.g. "deploy.env")
-  -x, --contextFile [context.json]      Context JSON File
-  -M, --enableRunMultipleEvents [true]  Enable run multiple events
-  -y, --proxy []                        Proxy server
-  --apiGateway                          Convert to API Gateway events
+  -H, --handler [AWS_HANDLER]                                 Lambda Handler {index.handler} (default: "index.handler")
+  -j, --eventFile [EVENT_FILE]                                Event JSON File (default: "event.json")
+  -u, --runtime [AWS_RUNTIME]                                 Lambda Runtime (default: "nodejs14.x")
+  -t, --timeout [AWS_RUN_TIMEOUT]                             Lambda Timeout (default: 3)
+  -f, --configFile [CONFIG_FILE]                              Path to file holding secret environment variables (e.g. "deploy.env") (default: "")
+  -x, --contextFile [CONTEXT_FILE]                            Context JSON File (default: "context.json")
+  -M, --enableRunMultipleEvents [ENABLE_RUN_MULTIPLE_EVENTS]  Enable run multiple events (default: true)
+  -y, --proxy [PROXY]                                         Proxy server (default: "")
+  --apiGateway                                                Convert to API Gateway events (default: false)
+  -h, --help                                                  display help for command
 ```
 
 #### package
@@ -134,24 +133,26 @@ Bundles your application into a local zip file.
 
 ```
 $ node-lambda package --help
-
-Usage: package|zip [options]
+Usage: node-lambda package|zip [options]
 
 Create zipped package for Amazon Lambda deployment
 
-
 Options:
-  -h, --help                        output usage information
-  -A, --packageDirectory [build]    Local Package Directory
-  -I, --dockerImage []              Docker image for npm install
-  -n, --functionName [node-lambda]  Lambda FunctionName
-  -H, --handler [index.handler]     Lambda Handler {index.handler}
-  -e, --environment [development]   Choose environment {dev, staging, production}
-  -x, --excludeGlobs [event.json]   Space-separated glob pattern(s) for additional exclude files (e.g. "event.json dotenv.sample")
-  -D, --prebuiltDirectory []        Prebuilt directory
-  -m, --keepNodeModules [false]     Keep the current node_modules and skip the npm install step
-  -v, --dockerVolumes []            Additional docker volumes to mount. Each volume definition has to be separated by a space (e.g. "$HOME/.gitconfig:/etc/gitconfig $HOME/.ssh:/root/.ssh"
-  --no-optionalDependencies         Run `npm install` with `--no-optional`
+  --packageManager [PACKAGE_MANAGER]            Package manager used to install dependencies (default: "npm", options: "npm", "yarn")
+  -A, --packageDirectory [PACKAGE_DIRECTORY]    Local Package Directory
+  -I, --dockerImage [DOCKER_IMAGE]              Docker image for npm ci (default: "")
+  -n, --functionName [AWS_FUNCTION_NAME]        Lambda FunctionName (default: "node-lambda")
+  -H, --handler [AWS_HANDLER]                   Lambda Handler {index.handler} (default: "index.handler")
+  -e, --environment [AWS_ENVIRONMENT]           Choose environment {dev, staging, production} (default: "")
+  -x, --excludeGlobs [EXCLUDE_GLOBS]            Space-separated glob pattern(s) for additional exclude files (e.g.
+                                                "event.json dotenv.sample") (default: "")
+  -D, --prebuiltDirectory [PREBUILT_DIRECTORY]  Prebuilt directory (default: "")
+  -m, --keepNodeModules [KEEP_NODE_MODULES]     Keep the current node_modules directory. (default: false)
+  -v, --dockerVolumes [DOCKER_VOLUMES]          Additional docker volumes to mount. Each volume definition has to be
+                                                separated by a space (e.g. "$HOME/.gitconfig:/etc/gitconfig
+                                                $HOME/.ssh:/root/.ssh") (default: "")
+  --no-optionalDependencies                     Run `npm install` with `--no-optional`
+  -h, --help                                    display help for command
 ```
 
 #### deploy
@@ -160,51 +161,50 @@ Bundles and deploys your application up to Amazon Lambda.
 
 ```
 $ node-lambda deploy --help
-
-Usage: deploy [options]
+Usage: node-lambda deploy [options]
 
 Deploy your application to Amazon Lambda
 
-
 Options:
-  -h, --help                          output usage information
-  -e, --environment [development]     Choose environment {dev, staging, production}
-  -E, --endpoint [AWS_ENDPOINT]       Choose endpoint (e.g. localstack, "http://127.0.0.1:4574") (default: "")
-  -a, --accessKey [your_key]          AWS Access Key
-  -s, --secretKey [your_secret]       AWS Secret Key
-  -P, --profile []                    AWS Profile
-  -k, --sessionToken []               AWS Session Token
-  -r, --region [us-east-1]            AWS Region
-  -n, --functionName [node-lambda]    Lambda FunctionName
-  -H, --handler [index.handler]       Lambda Handler {index.handler}
-  -o, --role [your_amazon_role]       Amazon Role ARN
-  -m, --memorySize [128]              Lambda Memory Size
-  -t, --timeout [3]                   Lambda Timeout
-  -d, --description [missing]         Lambda Description
-  -u, --runtime [nodejs14.x]          Lambda Runtime
-  -p, --publish [false]               Lambda Publish
-  -L, --lambdaVersion []              Lambda Function Version
-  -b, --vpcSubnets []                 Lambda Function VPC Subnet IDs (comma delimited)
-  -g, --vpcSecurityGroups []          Lambda VPC Security Group IDs (comma delimited)
-  -K, --kmsKeyArn []                  Lambda KMS Key ARN
-  -Q, --deadLetterConfigTargetArn []  Lambda DLQ resource
-  -c, --tracingConfig []              Lambda tracing settings
-  -l, --layers []                     Lambda Layers settings (e.g. "ARN1,ARN2[,..])" (default: "")
-  -R, --retentionInDays []            CloudWatchLogs retentionInDays settings
-  -G, --sourceDirectory []            Path to lambda source Directory (e.g. "./some-lambda")
-  -I, --dockerImage []                Docker image for npm install
-  -f, --configFile []                 Path to file holding secret environment variables (e.g. "deploy.env")
-  -S, --eventSourceFile []            Path to file holding event source mapping variables (e.g. "event_sources.json")
-  -x, --excludeGlobs [event.json]     Space-separated glob pattern(s) for additional exclude files (e.g. "event.json dotenv.sample")
-  -D, --prebuiltDirectory []          Prebuilt directory
-  -T, --deployTimeout [120000]        Deploy Timeout
-  -z, --deployZipfile []              Deploy zipfile
-  -B, --deployUseS3 []                Use S3 to deploy.
-  -i, --imageUri []                   URI of a container image in the Amazon ECR registry. (default: "")
-  -y, --proxy []                      Proxy server
-  -A, --tags []                       Tags as key value pairs (e.g. "tagname1=tagvalue1,tagname2=tagvalue2") (default: "")
-  --silent                            Silent  or  quiet mode (default: false)
-  --no-optionalDependencies           Run `npm install` with `--no-optional`
+  --packageManager [PACKAGE_MANAGER]                    Package manager used to install dependencies (default: "npm", options: "npm", "yarn")
+  -e, --environment [AWS_ENVIRONMENT]                   Choose environment {dev, staging, production} (default: "")
+  -E, --endpoint [AWS_ENDPOINT]                         Choose endpoint (e.g. localstack, "http://127.0.0.1:4574") (default: "")
+  -a, --accessKey [AWS_ACCESS_KEY_ID]                   AWS Access Key
+  -s, --secretKey [AWS_SECRET_ACCESS_KEY]               AWS Secret Key
+  -P, --profile [AWS_PROFILE]                           AWS Profile (default: "")
+  -k, --sessionToken [AWS_SESSION_TOKEN]                AWS Session Token (default: "")
+  -r, --region [AWS_REGION]                             AWS Region (default: "us-east-1,us-west-2,eu-west-1")
+  -n, --functionName [AWS_FUNCTION_NAME]                Lambda FunctionName (default: "node-lambda")
+  -H, --handler [AWS_HANDLER]                           Lambda Handler {index.handler} (default: "index.handler")
+  -o, --role [AWS_ROLE]                                 Amazon Role ARN (default: "missing")
+  -m, --memorySize [AWS_MEMORY_SIZE]                    Lambda Memory Size (default: 128)
+  -t, --timeout [AWS_TIMEOUT]                           Lambda Timeout (default: 60)
+  -d, --description [AWS_DESCRIPTION]                   Lambda Description (default: "Command line tool for locally running and remotely deploying your node.js applications to Amazon Lambda.")
+  -u, --runtime [AWS_RUNTIME]                           Lambda Runtime (default: "nodejs14.x")
+  -p, --publish [AWS_PUBLISH]                           Lambda Publish (default: false)
+  -L, --lambdaVersion [AWS_FUNCTION_VERSION]            Lambda Function Version (default: "")
+  -b, --vpcSubnets [AWS_VPC_SUBNETS]                    Lambda Function VPC Subnet IDs (comma delimited) (default: "")
+  -g, --vpcSecurityGroups [AWS_VPC_SECURITY_GROUPS]     Lambda VPC Security Group IDs (comma delimited) (default: "")
+  -K, --kmsKeyArn [AWS_KMS_KEY_ARN]                     Lambda KMS Key ARN (default: "")
+  -Q, --deadLetterConfigTargetArn [AWS_DLQ_TARGET_ARN]  Lambda DLQ resource
+  -c, --tracingConfig [AWS_TRACING_CONFIG]              Lambda tracing settings (default: "")
+  -l, --layers [AWS_LAYERS]                             Lambda Layers settings (e.g. "ARN1,ARN2[,..])" (default: "")
+  -R, --retentionInDays [AWS_LOGS_RETENTION_IN_DAYS]    CloudWatchLogs retentionInDays settings (default: "")
+  -G, --sourceDirectory [SRC_DIRECTORY]                 Path to lambda source Directory (e.g. "./some-lambda") (default: "")
+  -I, --dockerImage [DOCKER_IMAGE]                      Docker image for npm ci (default: "")
+  -f, --configFile [CONFIG_FILE]                        Path to file holding secret environment variables (e.g. "deploy.env") (default: "")
+  -S, --eventSourceFile [EVENT_SOURCE_FILE]             Path to file holding event source mapping variables (e.g. "event_sources.json") (default: "")
+  -x, --excludeGlobs [EXCLUDE_GLOBS]                    Space-separated glob pattern(s) for additional exclude files (e.g. "event.json dotenv.sample") (default: "")
+  -D, --prebuiltDirectory [PREBUILT_DIRECTORY]          Prebuilt directory (default: "")
+  -T, --deployTimeout [DEPLOY_TIMEOUT]                  Deploy Timeout (default: 120000)
+  -z, --deployZipfile [DEPLOY_ZIPFILE]                  Deploy zipfile (default: "")
+  -B, --deployUseS3 [DEPLOY_USE_S3]                     Use S3 to deploy. (default: false)
+  -i, --imageUri [IMAGE_URI]                            URI of a container image in the Amazon ECR registry. (default: "")
+  -y, --proxy [PROXY]                                   Proxy server (default: "")
+  -A, --tags [AWS_TAGS]                                 Tags as key value pairs (e.g. "tagname1=tagvalue1,tagname2=tagvalue2)" (default: "")
+  --silent                                              Silent  or  quiet mode (default: false)
+  --no-optionalDependencies                             Run `npm install` with `--no-optional`
+  -h, --help                                            display help for command
 ```
 
 If you are deploying to a custom endpoint you may also need to pass in an access key/secret. For localstack these can be anything, but cannot be blank:

package/bin/node-lambda

@@ -11,6 +11,7 @@ const fs = require('fs')
 const packageJson = fs.existsSync(path.join(process.cwd(), 'package.json')) ? require(path.join(process.cwd(), 'package.json')) : {}
 const packageJsonName = packageJson.name || 'UnnamedFunction'
 
+const PACKAGE_MANAGER = process.env.PACKAGE_MANAGER || 'npm'
 const AWS_ENVIRONMENT = process.env.AWS_ENVIRONMENT || ''
 const AWS_ENDPOINT = process.env.AWS_ENDPOINT || ''
 const CONFIG_FILE = process.env.CONFIG_FILE || ''
@@ -66,6 +67,7 @@ program.showSuggestionAfterError()
 program
   .command('deploy')
   .description('Deploy your application to Amazon Lambda')
+  .option('--packageManager [PACKAGE_MANAGER]', 'Package manager used to install dependencies', PACKAGE_MANAGER)
   .option('-e, --environment [AWS_ENVIRONMENT]', 'Choose environment {dev, staging, production}',
     AWS_ENVIRONMENT)
   .option('-E, --endpoint [AWS_ENDPOINT]', 'Choose endpoint (e.g. localstack, "http://127.0.0.1:4574")',
@@ -123,6 +125,7 @@ program
   .command('package')
   .alias('zip')
   .description('Create zipped package for Amazon Lambda deployment')
+  .option('--packageManager [PACKAGE_MANAGER]', 'Package manager used to install dependencies', PACKAGE_MANAGER)
   .option('-A, --packageDirectory [PACKAGE_DIRECTORY]', 'Local Package Directory', PACKAGE_DIRECTORY)
   .option('-I, --dockerImage [DOCKER_IMAGE]', 'Docker image for npm ci', DOCKER_IMAGE)
   .option('-n, --functionName [AWS_FUNCTION_NAME]', 'Lambda FunctionName', AWS_FUNCTION_NAME)

package/lib/main.js

@@ -385,31 +385,68 @@ Emulate only the body of the API Gateway event.
     return fs.existsSync(path.join(codeDirectory, 'package-lock.json'))
   }
 
-  _npmInstall (program, codeDirectory) {
-    // Run on windows:
-    // https://nodejs.org/api/child_process.html#child_process_spawning_bat_and_cmd_files_on_windows
-
-    const installCommand = this._shouldUseNpmCi(codeDirectory)
-      ? 'ci'
-      : 'install'
-    const npmInstallBaseOptions = [
+  _getNpmInstallCommand (program, codeDirectory) {
+    const installOptions = [
       '-s',
-      installCommand,
+      this._shouldUseNpmCi(codeDirectory) ? 'ci' : 'install',
       '--production',
       '--no-audit'
     ]
 
     if (program.optionalDependencies === false) {
-      npmInstallBaseOptions.push('--no-optional')
+      installOptions.push('--no-optional')
+    }
+
+    if (!program.dockerImage) {
+      installOptions.push('--prefix', codeDirectory)
+    }
+
+    return {
+      packageManager: 'npm',
+      installOptions
+    }
+  }
+
+  _getYarnInstallCommand (program, codeDirectory) {
+    const installOptions = [
+      '-s',
+      'install',
+      '--production'
+    ]
+
+    if (program.optionalDependencies === false) {
+      installOptions.push('--ignore-optional')
+    }
+
+    if (!program.dockerImage) {
+      installOptions.push('--cwd', codeDirectory)
     }
 
+    return {
+      packageManager: 'yarn',
+      installOptions
+    }
+  }
+
+  _packageInstall (program, codeDirectory) {
+    // Run on windows:
+    // https://nodejs.org/api/child_process.html#child_process_spawning_bat_and_cmd_files_on_windows
+
+    const { packageManager, installOptions } = (() => {
+      // default npm
+      if (program.packageManager === 'yarn') {
+        return this._getYarnInstallCommand(program, codeDirectory)
+      }
+      return this._getNpmInstallCommand(program, codeDirectory)
+    })()
+
     const paramsOnContainer = (() => {
       // with docker
       let dockerVolumesOptions = []
       program.dockerVolumes && program.dockerVolumes.split(' ').forEach((volume) => {
         dockerVolumesOptions = dockerVolumesOptions.concat(['-v', volume])
       })
-      const dockerCommand = [program.dockerImage, 'npm'].concat(npmInstallBaseOptions)
+      const dockerCommand = [program.dockerImage, packageManager].concat(installOptions)
       const dockerBaseOptions = [
         'run', '--rm',
         '-v', `${fs.realpathSync(codeDirectory)}:/var/task`,
@@ -429,17 +466,16 @@ Emulate only the body of the API Gateway event.
     })()
 
     const paramsOnHost = (() => {
-      // simple npm install
-      const options = npmInstallBaseOptions.concat(['--prefix', codeDirectory])
+      // simple install
       if (process.platform === 'win32') {
         return {
           command: 'cmd.exe',
-          options: ['/c', 'npm'].concat(options)
+          options: ['/c', packageManager].concat(installOptions)
         }
       }
       return {
-        command: 'npm',
-        options
+        command: packageManager,
+        options: installOptions
       }
     })()
 
@@ -450,7 +486,7 @@ Emulate only the body of the API Gateway event.
         env: process.env
       }, (err) => {
         if (err) return reject(err)
-        resolve()
+        resolve(packageManager)
       })
     })
   }
@@ -518,7 +554,7 @@ Emulate only the body of the API Gateway event.
 
   _codeDirectory () {
     // Why realpathSync?:
-    // If tmpdir is symbolic link and npm>=7, `this._npmInstall()` may not work properly.
+    // If tmpdir is symbolic link and npm>=7, `this._packageInstall()` may not work properly.
     return path.join(fs.realpathSync(os.tmpdir()), `${path.basename(path.resolve('.'))}-lambda`)
   }
 
@@ -691,8 +727,9 @@ they may not work as expected in the Lambda environment.
     console.log('=> Moving files to temporary directory')
     await this._fileCopy(program, lambdaSrcDirectory, codeDirectory, true)
     if (!program.keepNodeModules) {
-      console.log(`=> Running npm ${this._shouldUseNpmCi(codeDirectory) ? 'ci' : 'install'} --production`)
-      await this._npmInstall(program, codeDirectory)
+      console.log('=> Running package install')
+      const usedPackageManager = await this._packageInstall(program, codeDirectory)
+      console.log(`(Package manager used was '${usedPackageManager}'.)`)
     }
     await this._postInstallScript(program, codeDirectory)
     console.log('=> Zipping deployment package')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-lambda",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "Command line tool for locally running and remotely deploying your node.js applications to Amazon Lambda.",
   "main": "lib/main.js",
   "directories": {

package/test/main.js

@@ -10,6 +10,7 @@ const awsMock = require('aws-sdk-mock')
 awsMock.setSDK(path.resolve('node_modules/aws-sdk'))
 
 const originalProgram = {
+  packageManager: 'npm',
   environment: 'development',
   accessKey: 'key',
   secretKey: 'secret',
@@ -149,7 +150,7 @@ describe('lib/main', function () {
   })
 
   it('version should be set', () => {
-    assert.equal(lambda.version, '0.20.0')
+    assert.equal(lambda.version, '0.21.0')
   })
 
   describe('_codeDirectory', () => {
@@ -590,91 +591,251 @@ describe('lib/main', function () {
     })
   })
 
-  describe('_npmInstall', function () {
+  describe('_getNpmInstallCommand', () => {
+    describe('when package-lock.json exists', () => {
+      const codeDirectory = '.'
+
+      it('npm ci', () => {
+        const { packageManager, installOptions } = lambda._getNpmInstallCommand(program, codeDirectory)
+        assert.equal(packageManager, 'npm')
+        assert.deepEqual(installOptions, ['-s', 'ci', '--production', '--no-audit', '--prefix', codeDirectory])
+      })
+
+      it('npm ci with "--no-optional"', () => {
+        const { packageManager, installOptions } = lambda._getNpmInstallCommand(
+          {
+            ...program,
+            optionalDependencies: false
+          },
+          codeDirectory
+        )
+        assert.equal(packageManager, 'npm')
+        assert.deepEqual(
+          installOptions,
+          ['-s', 'ci', '--production', '--no-audit', '--no-optional', '--prefix', codeDirectory]
+        )
+      })
+
+      it('npm ci on docker', () => {
+        const { packageManager, installOptions } = lambda._getNpmInstallCommand(
+          {
+            ...program,
+            dockerImage: 'test'
+          },
+          codeDirectory
+        )
+        assert.equal(packageManager, 'npm')
+        assert.deepEqual(installOptions, ['-s', 'ci', '--production', '--no-audit'])
+      })
+    })
+
+    describe('when package-lock.json does not exist', () => {
+      const codeDirectory = './test'
+
+      it('npm install', () => {
+        const { packageManager, installOptions } = lambda._getNpmInstallCommand(program, './test')
+        assert.equal(packageManager, 'npm')
+        assert.deepEqual(installOptions, ['-s', 'install', '--production', '--no-audit', '--prefix', './test'])
+      })
+
+      it('npm install with "--no-optional"', () => {
+        const { packageManager, installOptions } = lambda._getNpmInstallCommand(
+          {
+            ...program,
+            optionalDependencies: false
+          },
+          codeDirectory
+        )
+        assert.equal(packageManager, 'npm')
+        assert.deepEqual(
+          installOptions,
+          ['-s', 'install', '--production', '--no-audit', '--no-optional', '--prefix', codeDirectory]
+        )
+      })
+
+      it('npm install on docker', () => {
+        const { packageManager, installOptions } = lambda._getNpmInstallCommand(
+          {
+            ...program,
+            dockerImage: 'test'
+          },
+          codeDirectory
+        )
+        assert.equal(packageManager, 'npm')
+        assert.deepEqual(installOptions, ['-s', 'install', '--production', '--no-audit'])
+      })
+    })
+  })
+
+  describe('_getYarnInstallCommand', () => {
+    const codeDirectory = '.'
+
+    it('yarn install', () => {
+      const { packageManager, installOptions } = lambda._getYarnInstallCommand(program, codeDirectory)
+      assert.equal(packageManager, 'yarn')
+      assert.deepEqual(installOptions, ['-s', 'install', '--production', '--cwd', codeDirectory])
+    })
+
+    it('yarn install with "--no-optional"', () => {
+      const { packageManager, installOptions } = lambda._getYarnInstallCommand(
+        {
+          ...program,
+          optionalDependencies: false
+        },
+        codeDirectory
+      )
+      assert.equal(packageManager, 'yarn')
+      assert.deepEqual(
+        installOptions,
+        ['-s', 'install', '--production', '--ignore-optional', '--cwd', codeDirectory]
+      )
+    })
+
+    it('yarn install on docker', () => {
+      const { packageManager, installOptions } = lambda._getYarnInstallCommand(
+        {
+          ...program,
+          dockerImage: 'test'
+        },
+        codeDirectory
+      )
+      assert.equal(packageManager, 'yarn')
+      assert.deepEqual(installOptions, ['-s', 'install', '--production'])
+    })
+  })
+
+  describe('_packageInstall', function () {
     _timeout({ this: this, sec: 60 }) // ci should be faster than install
 
     // npm treats files as packages when installing, and so removes them.
     // Test with `devDependencies` packages that are not installed with the `--production` option.
     const nodeModulesMocha = path.join(codeDirectory, 'node_modules', 'mocha')
 
+    const testCleanAndInstall = async (packageManager) => {
+      const beforeAwsSdkStat = fs.statSync(path.join(codeDirectory, 'node_modules', 'aws-sdk'))
+
+      const usedPackageManager = await lambda._packageInstall(
+        {
+          ...program,
+          packageManager
+        },
+        codeDirectory
+      )
+      assert.equal(usedPackageManager, packageManager)
+
+      const contents = fs.readdirSync(path.join(codeDirectory, 'node_modules'))
+      assert.include(contents, 'dotenv')
+
+      // To remove and then install.
+      // beforeAwsSdkStat.ctimeMs < afterAwsSdkStat.ctimeMs
+      const afterAwsSdkStat = fs.statSync(path.join(codeDirectory, 'node_modules', 'aws-sdk'))
+      assert.isBelow(beforeAwsSdkStat.ctimeMs, afterAwsSdkStat.ctimeMs)
+
+      // Not installed with the `--production` option.
+      assert.isFalse(fs.existsSync(nodeModulesMocha))
+    }
+
+    const beforeEachOptionalDependencies = () => {
+      const packageJsonPath = path.join(codeDirectory, 'package.json')
+      const packageJson = require(packageJsonPath)
+      packageJson.optionalDependencies = { npm: '*' }
+      fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson))
+    }
+
+    const testOptionalDependenciesIsInstalled = async (packageManager) => {
+      const usedPackageManager = await lambda._packageInstall(
+        {
+          ...program,
+          packageManager
+        },
+        codeDirectory
+      )
+      assert.equal(usedPackageManager, packageManager)
+
+      const contents = fs.readdirSync(path.join(codeDirectory, 'node_modules'))
+      assert.include(contents, 'npm')
+    }
+
+    const testOptionalDependenciesIsNotInstalled = async (packageManager) => {
+      const params = {
+        ...program,
+        packageManager,
+        optionalDependencies: false
+      }
+      const usedPackageManager = await lambda._packageInstall(params, codeDirectory)
+      assert.equal(usedPackageManager, packageManager)
+
+      const contents = fs.readdirSync(path.join(codeDirectory, 'node_modules'))
+      assert.notInclude(contents, 'npm')
+    }
+
     beforeEach(async () => {
       await lambda._cleanDirectory(codeDirectory)
       await lambda._fileCopy(program, '.', codeDirectory, false)
     })
 
-    describe('when package-lock.json does exist', () => {
-      it('should use "npm ci"', () => {
-        const beforeAwsSdkStat = fs.statSync(path.join(codeDirectory, 'node_modules', 'aws-sdk'))
-        return lambda._npmInstall(program, codeDirectory).then(() => {
-          const contents = fs.readdirSync(path.join(codeDirectory, 'node_modules'))
-          assert.include(contents, 'dotenv')
-
-          // To remove and then install.
-          // beforeAwsSdkStat.ctimeMs < afterAwsSdkStat.ctimeMs
-          const afterAwsSdkStat = fs.statSync(path.join(codeDirectory, 'node_modules', 'aws-sdk'))
-          assert.isBelow(beforeAwsSdkStat.ctimeMs, afterAwsSdkStat.ctimeMs)
+    describe('Use npm', () => {
+      describe('when package-lock.json does exist', () => {
+        it('should use "npm ci"', () => testCleanAndInstall('npm'))
+      })
 
-          // Not installed with the `--production` option.
-          assert.isFalse(fs.existsSync(nodeModulesMocha))
+      describe('when package-lock.json does not exist', () => {
+        beforeEach(() => {
+          return fs.removeSync(path.join(codeDirectory, 'package-lock.json'))
         })
-      })
-    })
 
-    describe('when package-lock.json does not exist', () => {
-      beforeEach(() => {
-        return fs.removeSync(path.join(codeDirectory, 'package-lock.json'))
+        it('should use "npm install"', () => {
+          const beforeAwsSdkStat = fs.statSync(path.join(codeDirectory, 'node_modules', 'aws-sdk'))
+          return lambda._packageInstall(program, codeDirectory).then((usedPackageManager) => {
+            assert.equal(usedPackageManager, 'npm')
+
+            const contents = fs.readdirSync(path.join(codeDirectory, 'node_modules'))
+            assert.include(contents, 'dotenv')
+
+            // Installed packages will remain intact.
+            // beforeAwsSdkStat.ctimeMs === afterAwsSdkStat.ctimeMs
+            const afterAwsSdkStat = fs.statSync(path.join(codeDirectory, 'node_modules', 'aws-sdk'))
+            assert.equal(beforeAwsSdkStat.ctimeMs, afterAwsSdkStat.ctimeMs)
+
+            // Not installed with the `--production` option.
+            assert.isFalse(fs.existsSync(nodeModulesMocha))
+          })
+        })
       })
 
-      it('should use "npm install"', () => {
-        const beforeAwsSdkStat = fs.statSync(path.join(codeDirectory, 'node_modules', 'aws-sdk'))
-        return lambda._npmInstall(program, codeDirectory).then(() => {
-          const contents = fs.readdirSync(path.join(codeDirectory, 'node_modules'))
-          assert.include(contents, 'dotenv')
+      describe('optionalDependencies', () => {
+        beforeEach(beforeEachOptionalDependencies)
 
-          // Installed packages will remain intact.
-          // beforeAwsSdkStat.ctimeMs === afterAwsSdkStat.ctimeMs
-          const afterAwsSdkStat = fs.statSync(path.join(codeDirectory, 'node_modules', 'aws-sdk'))
-          assert.equal(beforeAwsSdkStat.ctimeMs, afterAwsSdkStat.ctimeMs)
+        describe('No `--no-optionalDependencies`', () => {
+          it('optionalDependencies is installed', () => testOptionalDependenciesIsInstalled('npm'))
+        })
 
-          // Not installed with the `--production` option.
-          assert.isFalse(fs.existsSync(nodeModulesMocha))
+        describe('With `--no-optionalDependencies`', () => {
+          it('optionalDependency is NOT installed', () => testOptionalDependenciesIsNotInstalled('npm'))
         })
       })
     })
 
-    describe('optionalDependencies', () => {
-      beforeEach(() => {
-        const packageJsonPath = path.join(codeDirectory, 'package.json')
-        const packageJson = require(packageJsonPath)
-        packageJson.optionalDependencies = { npm: '*' }
-        fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson))
-      })
+    describe('Use yarn', () => {
+      it('should use "yarn install"', () => testCleanAndInstall('yarn'))
 
-      describe('No `--no-optionalDependencies`', () => {
-        it('optionalDependencies is installed', () => {
-          return lambda._npmInstall(program, codeDirectory).then(() => {
-            const contents = fs.readdirSync(path.join(codeDirectory, 'node_modules'))
-            assert.include(contents, 'npm')
-          })
+      describe('optionalDependencies', () => {
+        beforeEach(beforeEachOptionalDependencies)
+
+        describe('No `--ignore-optionalDependencies`', () => {
+          it('optionalDependencies is installed', () => testOptionalDependenciesIsInstalled('yarn'))
         })
-      })
 
-      describe('With `--no-optionalDependencies`', () => {
-        it('optionalDependency is NOT installed', () => {
-          const params = {
-            ...program,
-            optionalDependencies: false
-          }
-          return lambda._npmInstall(params, codeDirectory).then(() => {
-            const contents = fs.readdirSync(path.join(codeDirectory, 'node_modules'))
-            assert.notInclude(contents, 'npm')
-          })
+        describe('With `--ignore-optionalDependencies`', () => {
+          it('optionalDependency is NOT installed', () => testOptionalDependenciesIsNotInstalled('yarn'))
         })
       })
     })
   })
 
-  describe('_npmInstall (When codeDirectory contains characters to be escaped)', () => {
+  describe('_packageInstall (When codeDirectory contains characters to be escaped)', function () {
+    _timeout({ this: this, sec: 30 }) // give it time to build the node modules
+
     beforeEach(() => {
       // Since '\' can not be included in the file or directory name in Windows
       const directoryName = process.platform === 'win32'
@@ -691,14 +852,21 @@ describe('lib/main', function () {
       codeDirectory = lambda._codeDirectory()
     })
 
-    it('_npm adds node_modules', function () {
-      _timeout({ this: this, sec: 30 }) // give it time to build the node modules
+    const testFunc = async (packageManager) => {
+      const usedPackageManager = await lambda._packageInstall(
+        {
+          ...program,
+          packageManager
+        },
+        codeDirectory
+      )
+      assert.equal(usedPackageManager, packageManager)
+      const contents = fs.readdirSync(codeDirectory)
+      assert.include(contents, 'node_modules')
+    }
 
-      return lambda._npmInstall(program, codeDirectory).then(() => {
-        const contents = fs.readdirSync(codeDirectory)
-        assert.include(contents, 'node_modules')
-      })
-    })
+    it('npm adds node_modules', () => testFunc('npm'))
+    it('yarn adds node_modules', () => testFunc('yarn'))
   })
 
   describe('_postInstallScript', () => {
@@ -768,53 +936,70 @@ describe('lib/main', function () {
     })
   })
 
-  describe('_zip', () => {
-    beforeEach(function () {
-      _timeout({ this: this, sec: 30 }) // give it time to build the node modules
-      return Promise.resolve().then(() => {
-        return lambda._cleanDirectory(codeDirectory)
-      }).then(() => {
-        return lambda._fileCopy(program, '.', codeDirectory, true)
-      }).then(() => {
-        return lambda._npmInstall(program, codeDirectory)
-      }).then(() => {
-        if (process.platform !== 'win32') {
-          fs.symlinkSync(
-            path.join(__dirname, '..', 'bin', 'node-lambda'),
-            path.join(codeDirectory, 'node-lambda-link')
-          )
-        }
-      })
-    })
+  describe('_zip', function () {
+    _timeout({ this: this, sec: 60 }) // give it time to zip
 
-    it('Compress the file. `index.js` and `bin/node-lambda` are included and the permission is also preserved.', function () {
-      _timeout({ this: this, sec: 30 }) // give it time to zip
+    const beforeTask = async (packageManager) => {
+      await lambda._cleanDirectory(codeDirectory)
+      await lambda._fileCopy(program, '.', codeDirectory, true)
+      const usedPackageManager = await lambda._packageInstall(
+        {
+          ...program,
+          packageManager
+        },
+        codeDirectory
+      )
+      assert.equal(usedPackageManager, packageManager)
+      if (process.platform !== 'win32') {
+        fs.symlinkSync(
+          path.join(__dirname, '..', 'bin', 'node-lambda'),
+          path.join(codeDirectory, 'node-lambda-link')
+        )
+      }
+    }
 
-      return lambda._zip(program, codeDirectory).then((data) => {
-        const archive = new Zip(data)
-        assert.include(archive.files['index.js'].name, 'index.js')
-        assert.include(archive.files['bin/node-lambda'].name, 'bin/node-lambda')
-
-        if (process.platform !== 'win32') {
-          const indexJsStat = fs.lstatSync('index.js')
-          const binNodeLambdaStat = fs.lstatSync(path.join('bin', 'node-lambda'))
-          assert.equal(
-            archive.files['index.js'].unixPermissions,
-            indexJsStat.mode
-          )
-          assert.equal(
-            archive.files['bin/node-lambda'].unixPermissions,
-            binNodeLambdaStat.mode
-          )
-
-          // isSymbolicLink
-          assert.include(archive.files['node-lambda-link'].name, 'node-lambda-link')
-          assert.equal(
-            archive.files['node-lambda-link'].unixPermissions & fs.constants.S_IFMT,
-            fs.constants.S_IFLNK
-          )
-        }
-      })
+    const testFunc = async (packageManager) => {
+      // setup
+      await beforeTask(packageManager)
+
+      // tests
+      const data = await lambda._zip(program, codeDirectory)
+      const archive = new Zip(data)
+      assert.include(archive.files['index.js'].name, 'index.js')
+      assert.include(archive.files['bin/node-lambda'].name, 'bin/node-lambda')
+
+      if (process.platform !== 'win32') {
+        const indexJsStat = fs.lstatSync('index.js')
+        const binNodeLambdaStat = fs.lstatSync(path.join('bin', 'node-lambda'))
+        assert.equal(
+          archive.files['index.js'].unixPermissions,
+          indexJsStat.mode
+        )
+        assert.equal(
+          archive.files['bin/node-lambda'].unixPermissions,
+          binNodeLambdaStat.mode
+        )
+
+        // isSymbolicLink
+        assert.include(archive.files['node-lambda-link'].name, 'node-lambda-link')
+        assert.equal(
+          archive.files['node-lambda-link'].unixPermissions & fs.constants.S_IFMT,
+          fs.constants.S_IFLNK
+        )
+      }
+    }
+
+    describe('Use npm', () => {
+      it(
+        'Compress the file. `index.js` and `bin/node-lambda` are included and the permission is also preserved.',
+        () => testFunc('npm')
+      )
+    })
+    describe('Use yarn', () => {
+      it(
+        'Compress the file. `index.js` and `bin/node-lambda` are included and the permission is also preserved.',
+        () => testFunc('yarn')
+      )
     })
   })