serverless/test/unit/lib/plugins/aws/invoke-local/index.test.js

'use strict'

const chai = require('chai')
const sinon = require('sinon')
const path = require('path')
const EventEmitter = require('events')
const fse = require('fs-extra')
const log = require('log').get('serverless:test')
const proxyquire = require('proxyquire')
const overrideEnv = require('process-utils/override-env')
const AwsProvider = require('../../../../../../lib/plugins/aws/provider')
const Serverless = require('../../../../../../lib/serverless')
const CLI = require('../../../../../../lib/classes/cli')
const { getTmpDirPath } = require('../../../../../utils/fs')
const skipWithNotice = require('@serverless/test/skip-with-notice')
const runServerless = require('../../../../../utils/run-serverless')
const spawnExt = require('child-process-ext/spawn')

const tmpServicePath = __dirname

chai.use(require('chai-as-promised'))

chai.should()

const expect = chai.expect

describe('AwsInvokeLocal', () => {
  let AwsInvokeLocal
  let awsInvokeLocal
  let options
  let serverless
  let provider
  let stdinStub
  let spawnExtStub
  let spawnStub
  let writeChildStub
  let endChildStub

  beforeEach(() => {
    options = {
      stage: 'dev',
      region: 'us-east-1',
      function: 'first',
    }
    spawnStub = sinon.stub()
    endChildStub = sinon.stub()
    writeChildStub = sinon.stub()
    spawnExtStub = sinon.stub().resolves({
      stdoutBuffer: Buffer.from('Mocked output'),
    })
    spawnStub = sinon.stub().returns({
      stderr: new EventEmitter().on('data', () => {}),
      stdout: new EventEmitter().on('data', () => {}),
      stdin: {
        write: writeChildStub,
        end: endChildStub,
      },
      on: (key, callback) => {
        if (key === 'close') process.nextTick(callback)
      },
    })

    stdinStub = sinon.stub().resolves('')
    AwsInvokeLocal = proxyquire(
      '../../../../../../lib/plugins/aws/invoke-local/index',
      {
        'get-stdin': stdinStub,
        'child-process-ext/spawn': spawnExtStub,
      },
    )
    serverless = new Serverless({ commands: [], options: {} })
    serverless.serviceDir = 'servicePath'
    serverless.cli = new CLI(serverless)
    serverless.processedInput = { commands: ['invoke'] }
    provider = new AwsProvider(serverless, options)
    provider.cachedCredentials = {
      credentials: { accessKeyId: 'foo', secretAccessKey: 'bar' },
    }
    serverless.setProvider('aws', provider)
    awsInvokeLocal = new AwsInvokeLocal(serverless, options)
    awsInvokeLocal.provider = provider
  })

  describe('#extendedValidate()', () => {
    let backupIsTTY
    beforeEach(() => {
      serverless.serviceDir = true
      serverless.service.environment = {
        vars: {},
        stages: {
          dev: {
            vars: {},
            regions: {
              'us-east-1': {
                vars: {},
              },
            },
          },
        },
      }
      serverless.service.functions = {
        first: {
          handler: true,
        },
      }
      awsInvokeLocal.options.data = null
      awsInvokeLocal.options.path = false

      // Ensure there's no attempt to read path from stdin
      backupIsTTY = process.stdin.isTTY
      process.stdin.isTTY = true
    })

    afterEach(() => {
      if (backupIsTTY) process.stdin.isTTY = backupIsTTY
      else delete process.stdin.isTTY
    })

    it('should not throw error when there are no input data', async () => {
      awsInvokeLocal.options.data = undefined

      await expect(awsInvokeLocal.extendedValidate()).to.be.fulfilled
      expect(awsInvokeLocal.options.data).to.equal('')
    })

    it('it should throw error if function is not provided', () => {
      serverless.service.functions = null
      return expect(awsInvokeLocal.extendedValidate()).to.be.rejected
    })

    it('should keep data if it is a simple string', async () => {
      awsInvokeLocal.options.data = 'simple-string'

      await expect(awsInvokeLocal.extendedValidate()).to.be.fulfilled
      expect(awsInvokeLocal.options.data).to.equal('simple-string')
    })

    it('should parse data if it is a json string', async () => {
      awsInvokeLocal.options.data = '{"key": "value"}'

      await expect(awsInvokeLocal.extendedValidate()).to.be.fulfilled
      expect(awsInvokeLocal.options.data).to.deep.equal({ key: 'value' })
    })

    it('should skip parsing data if "raw" requested', async () => {
      awsInvokeLocal.options.data = '{"key": "value"}'
      awsInvokeLocal.options.raw = true

      await expect(awsInvokeLocal.extendedValidate()).to.be.fulfilled
      expect(awsInvokeLocal.options.data).to.deep.equal('{"key": "value"}')
    })

    it('should parse context if it is a json string', async () => {
      awsInvokeLocal.options.context = '{"key": "value"}'

      await expect(awsInvokeLocal.extendedValidate()).to.be.fulfilled
      expect(awsInvokeLocal.options.context).to.deep.equal({ key: 'value' })
    })

    it('should skip parsing context if "raw" requested', async () => {
      awsInvokeLocal.options.context = '{"key": "value"}'
      awsInvokeLocal.options.raw = true

      await expect(awsInvokeLocal.extendedValidate()).to.be.fulfilled
      expect(awsInvokeLocal.options.context).to.deep.equal('{"key": "value"}')
    })

    it('it should parse file if relative file path is provided', async () => {
      serverless.serviceDir = getTmpDirPath()
      const data = {
        testProp: 'testValue',
      }
      serverless.utils.writeFileSync(
        path.join(serverless.serviceDir, 'data.json'),
        JSON.stringify(data),
      )
      awsInvokeLocal.options.contextPath = 'data.json'

      await expect(awsInvokeLocal.extendedValidate()).to.be.fulfilled
      expect(awsInvokeLocal.options.context).to.deep.equal(data)
    })

    it('it should parse file if absolute file path is provided', async () => {
      serverless.serviceDir = getTmpDirPath()
      const data = {
        event: {
          testProp: 'testValue',
        },
      }
      const dataFile = path.join(serverless.serviceDir, 'data.json')
      serverless.utils.writeFileSync(dataFile, JSON.stringify(data))
      awsInvokeLocal.options.path = dataFile
      awsInvokeLocal.options.contextPath = false

      await expect(awsInvokeLocal.extendedValidate()).to.be.fulfilled
      expect(awsInvokeLocal.options.data).to.deep.equal(data)
    })

    it('it should parse a yaml file if file path is provided', async () => {
      serverless.serviceDir = getTmpDirPath()
      const yamlContent = 'event: data'

      serverless.utils.writeFileSync(
        path.join(serverless.serviceDir, 'data.yml'),
        yamlContent,
      )
      awsInvokeLocal.options.path = 'data.yml'

      await expect(awsInvokeLocal.extendedValidate()).to.be.fulfilled
      expect(awsInvokeLocal.options.data).to.deep.equal({ event: 'data' })
    })

    it('it should require a js file if file path is provided', async () => {
      serverless.serviceDir = getTmpDirPath()
      const jsContent = [
        'module.exports = {',
        '  headers: { "Content-Type" : "application/json" },',
        '  body: JSON.stringify([100, 200]),',
        '}',
      ].join('\n')

      serverless.utils.writeFileSync(
        path.join(serverless.serviceDir, 'data.js'),
        jsContent,
      )
      awsInvokeLocal.options.path = 'data.js'

      await expect(awsInvokeLocal.extendedValidate()).to.be.fulfilled
      expect(awsInvokeLocal.options.data).to.deep.equal({
        headers: { 'Content-Type': 'application/json' },
        body: '[100,200]',
      })
    })

    it('it should reject error if file path does not exist', () => {
      serverless.serviceDir = getTmpDirPath()
      awsInvokeLocal.options.path = 'some/path'

      return expect(awsInvokeLocal.extendedValidate()).to.be.rejected
    })
  })

  describe('#getCredentialEnvVars()', () => {
    it('returns empty object when credentials is not set', () => {
      provider.cachedCredentials = null

      const credentialEnvVars = awsInvokeLocal.getCredentialEnvVars()

      expect(credentialEnvVars).to.be.eql({})
    })

    it('returns credential env vars from cached credentials', () => {
      provider.cachedCredentials = {
        credentials: {
          accessKeyId: 'ID',
          secretAccessKey: 'SECRET',
          sessionToken: 'TOKEN',
        },
      }

      const credentialEnvVars = awsInvokeLocal.getCredentialEnvVars()

      expect(credentialEnvVars).to.be.eql({
        AWS_ACCESS_KEY_ID: 'ID',
        AWS_SECRET_ACCESS_KEY: 'SECRET',
        AWS_SESSION_TOKEN: 'TOKEN',
      })
    })
  })

  describe('#loadEnvVars()', () => {
    let restoreEnv
    beforeEach(() => {
      ;({ restoreEnv } = overrideEnv())
      serverless.serviceDir = true
      serverless.service.provider = {
        environment: {
          providerVar: 'providerValue',
        },
      }

      awsInvokeLocal.provider.options.region = 'us-east-1'
      awsInvokeLocal.options = {
        functionObj: {
          name: 'serviceName-dev-hello',
          environment: {
            functionVar: 'functionValue',
          },
        },
      }
    })

    afterEach(() => restoreEnv())

    it('it should load provider env vars', async () => {
      await awsInvokeLocal.loadEnvVars()
      expect(process.env.providerVar).to.be.equal('providerValue')
    })

    it('it should load provider profile env', async () => {
      serverless.service.provider.profile = 'jdoe'
      await awsInvokeLocal.loadEnvVars()
      expect(process.env.AWS_PROFILE).to.be.equal('jdoe')
    })

    it('it should load function env vars', async () => {
      await awsInvokeLocal.loadEnvVars()
      expect(process.env.functionVar).to.be.equal('functionValue')
    })

    it('it should load default lambda env vars', async () => {
      await awsInvokeLocal.loadEnvVars()
      expect(process.env.LANG).to.equal('en_US.UTF-8')
      expect(process.env.LD_LIBRARY_PATH).to.equal(
        '/usr/local/lib64/node-v4.3.x/lib:/lib64:/usr/lib64:/var/runtime:/var/runtime/lib:/var/task:/var/task/lib',
      )
      expect(process.env.LAMBDA_TASK_ROOT).to.equal('/var/task')
      expect(process.env.LAMBDA_RUNTIME_DIR).to.equal('/var/runtime')
      expect(process.env.AWS_REGION).to.equal('us-east-1')
      expect(process.env.AWS_DEFAULT_REGION).to.equal('us-east-1')
      expect(process.env.AWS_LAMBDA_LOG_GROUP_NAME).to.equal(
        '/aws/lambda/serviceName-dev-hello',
      )
      expect(process.env.AWS_LAMBDA_LOG_STREAM_NAME).to.equal(
        '2016/12/02/[$LATEST]f77ff5e4026c45bda9a9ebcec6bc9cad',
      )
      expect(process.env.AWS_LAMBDA_FUNCTION_NAME).to.equal(
        'serviceName-dev-hello',
      )
      expect(process.env.AWS_LAMBDA_FUNCTION_MEMORY_SIZE).to.equal('1024')
      expect(process.env.AWS_LAMBDA_FUNCTION_VERSION).to.equal('$LATEST')
      expect(process.env.NODE_PATH).to.equal(
        '/var/runtime:/var/task:/var/runtime/node_modules',
      )
    })

    it('it should set credential env vars #1', async () => {
      provider.cachedCredentials = {
        credentials: {
          accessKeyId: 'ID',
          secretAccessKey: 'SECRET',
        },
      }

      await awsInvokeLocal.loadEnvVars()
      expect(process.env.AWS_ACCESS_KEY_ID).to.equal('ID')
      expect(process.env.AWS_SECRET_ACCESS_KEY).to.equal('SECRET')
      expect('AWS_SESSION_TOKEN' in process.env).to.equal(false)
    })

    it('it should set credential env vars #2', async () => {
      provider.cachedCredentials = {
        credentials: {
          sessionToken: 'TOKEN',
        },
      }
      await awsInvokeLocal.loadEnvVars()

      expect(process.env.AWS_SESSION_TOKEN).to.equal('TOKEN')
      expect('AWS_ACCESS_KEY_ID' in process.env).to.equal(false)
      expect('AWS_SECRET_ACCESS_KEY' in process.env).to.equal(false)
    })

    it('it should work without cached credentials set', async () => {
      provider.cachedCredentials = null
      await awsInvokeLocal.loadEnvVars()

      expect('AWS_SESSION_TOKEN' in process.env).to.equal(false)
      expect('AWS_ACCESS_KEY_ID' in process.env).to.equal(false)
      expect('AWS_SECRET_ACCESS_KEY' in process.env).to.equal(false)
    })

    it('should fallback to service provider configuration when options are not available', async () => {
      awsInvokeLocal.provider.options.region = null
      awsInvokeLocal.serverless.service.provider.region = 'us-west-1'

      await awsInvokeLocal.loadEnvVars()
      expect(process.env.AWS_REGION).to.equal('us-west-1')
      expect(process.env.AWS_DEFAULT_REGION).to.equal('us-west-1')
    })

    it('it should overwrite provider env vars', async () => {
      awsInvokeLocal.options.functionObj.environment.providerVar =
        'providerValueOverwritten'

      await awsInvokeLocal.loadEnvVars()
      expect(process.env.providerVar).to.be.equal('providerValueOverwritten')
    })
  })

  describe('#invokeLocal()', () => {
    let invokeLocalNodeJsStub
    let invokeLocalPythonStub
    let invokeLocalJavaStub
    let invokeLocalRubyStub
    let invokeLocalDockerStub

    beforeEach(() => {
      invokeLocalNodeJsStub = sinon
        .stub(awsInvokeLocal, 'invokeLocalNodeJs')
        .resolves()
      invokeLocalPythonStub = sinon
        .stub(awsInvokeLocal, 'invokeLocalPython')
        .resolves()
      invokeLocalJavaStub = sinon
        .stub(awsInvokeLocal, 'invokeLocalJava')
        .resolves()
      invokeLocalRubyStub = sinon
        .stub(awsInvokeLocal, 'invokeLocalRuby')
        .resolves()
      invokeLocalDockerStub = sinon
        .stub(awsInvokeLocal, 'invokeLocalDocker')
        .resolves()

      awsInvokeLocal.serverless.service.service = 'new-service'
      awsInvokeLocal.provider.options.stage = 'dev'
      awsInvokeLocal.options = {
        function: 'first',
        functionObj: {
          handler: 'handler.hello',
          name: 'hello',
        },
        data: {},
      }
    })

    afterEach(() => {
      awsInvokeLocal.invokeLocalNodeJs.restore()
      awsInvokeLocal.invokeLocalPython.restore()
      awsInvokeLocal.invokeLocalJava.restore()
      awsInvokeLocal.invokeLocalRuby.restore()
    })

    it('should call invokeLocalNodeJs when no runtime is set', async () => {
      await awsInvokeLocal.invokeLocal()
      expect(invokeLocalNodeJsStub.calledOnce).to.be.equal(true)
      expect(
        invokeLocalNodeJsStub.calledWithExactly(
          'handler',
          'hello',
          {},
          undefined,
        ),
      ).to.be.equal(true)
    })

    describe('for different handler paths', () => {
      ;[
        { path: 'handler.hello', expected: 'handler' },
        { path: '.build/handler.hello', expected: '.build/handler' },
      ].forEach((item) => {
        it(`should call invokeLocalNodeJs for any node.js runtime version for ${item.path}`, async () => {
          awsInvokeLocal.options.functionObj.handler = item.path

          awsInvokeLocal.options.functionObj.runtime = 'nodejs16.x'
          await awsInvokeLocal.invokeLocal()
          expect(invokeLocalNodeJsStub.calledOnce).to.be.equal(true)
          expect(
            invokeLocalNodeJsStub.calledWithExactly(
              item.expected,
              'hello',
              {},
              undefined,
            ),
          ).to.be.equal(true)
        })
      })
    })

    it('should call invokeLocalNodeJs with custom context if provided', async () => {
      awsInvokeLocal.options.context = 'custom context'
      await awsInvokeLocal.invokeLocal()
      expect(invokeLocalNodeJsStub.calledOnce).to.be.equal(true)
      expect(
        invokeLocalNodeJsStub.calledWithExactly(
          'handler',
          'hello',
          {},
          'custom context',
        ),
      ).to.be.equal(true)
    })

    it('should call invokeLocalPython when python3.11 runtime is set', async () => {
      awsInvokeLocal.options.functionObj.runtime = 'python3.11'
      await awsInvokeLocal.invokeLocal()
      // NOTE: this is important so that tests on Windows won't fail
      const runtime = process.platform === 'win32' ? 'python.exe' : 'python3.11'
      expect(invokeLocalPythonStub.calledOnce).to.be.equal(true)
      expect(
        invokeLocalPythonStub.calledWithExactly(
          runtime,
          'handler',
          'hello',
          {},
          undefined,
        ),
      ).to.be.equal(true)
    })

    it('should call invokeLocalJava when java8 runtime is set', async () => {
      awsInvokeLocal.options.functionObj.runtime = 'java8'
      await awsInvokeLocal.invokeLocal()
      expect(invokeLocalJavaStub.calledOnce).to.be.equal(true)
      expect(
        invokeLocalJavaStub.calledWithExactly(
          'java',
          'handler.hello',
          'handleRequest',
          undefined,
          {},
          undefined,
        ),
      ).to.be.equal(true)
    })

    it('should call invokeLocalRuby when ruby2.7 runtime is set', async () => {
      awsInvokeLocal.options.functionObj.runtime = 'ruby2.7'
      await awsInvokeLocal.invokeLocal()
      // NOTE: this is important so that tests on Windows won't fail
      const runtime = process.platform === 'win32' ? 'ruby.exe' : 'ruby'
      expect(invokeLocalRubyStub.calledOnce).to.be.equal(true)
      expect(
        invokeLocalRubyStub.calledWithExactly(
          runtime,
          'handler',
          'hello',
          {},
          undefined,
        ),
      ).to.be.equal(true)
    })

    it('should call invokeLocalRuby when ruby3.2 runtime is set', async () => {
      awsInvokeLocal.options.functionObj.runtime = 'ruby3.2'
      await awsInvokeLocal.invokeLocal()
      // NOTE: this is important so that tests on Windows won't fail
      const runtime = process.platform === 'win32' ? 'ruby.exe' : 'ruby'
      expect(invokeLocalRubyStub.calledOnce).to.be.equal(true)
      expect(
        invokeLocalRubyStub.calledWithExactly(
          runtime,
          'handler',
          'hello',
          {},
          undefined,
        ),
      ).to.be.equal(true)
    })

    it('should call invokeLocalDocker if using runtime provided', async () => {
      awsInvokeLocal.options.functionObj.runtime = 'provided'
      awsInvokeLocal.options.functionObj.handler = 'handler.foobar'
      await awsInvokeLocal.invokeLocal()
      expect(invokeLocalDockerStub.calledOnce).to.be.equal(true)
      expect(invokeLocalDockerStub.calledWithExactly()).to.be.equal(true)
    })

    it('should call invokeLocalDocker if using --docker option with nodejs16.x', async () => {
      awsInvokeLocal.options.functionObj.runtime = 'nodejs16.x'
      awsInvokeLocal.options.functionObj.handler = 'handler.foobar'
      awsInvokeLocal.options.docker = true
      await awsInvokeLocal.invokeLocal()
      expect(invokeLocalDockerStub.calledOnce).to.be.equal(true)
      expect(invokeLocalDockerStub.calledWithExactly()).to.be.equal(true)
    })
  })

  describe('#callJavaBridge()', () => {
    let invokeLocalSpawnStubbed
    beforeEach(() => {
      AwsInvokeLocal = proxyquire(
        '../../../../../../lib/plugins/aws/invoke-local/index',
        {
          'get-stdin': stdinStub,
          'child-process-ext/spawn': spawnExtStub,
          child_process: {
            spawn: spawnStub,
          },
        },
      )
      invokeLocalSpawnStubbed = new AwsInvokeLocal(serverless, {
        stage: 'dev',
        function: 'first',
        functionObj: {
          handler: 'handler.hello',
          name: 'hello',
          timeout: 4,
        },
        data: {},
      })
    })

    it('spawns java process with correct arguments', async () => {
      await invokeLocalSpawnStubbed.callJavaBridge(
        tmpServicePath,
        'com.serverless.Handler',
        'handleRequest',
        '{}',
      )
      expect(writeChildStub.calledOnce).to.be.equal(true)
      expect(endChildStub.calledOnce).to.be.equal(true)
      expect(writeChildStub.calledWithExactly('{}')).to.be.equal(true)
    })
  })

  describe('#invokeLocalJava()', () => {
    let callJavaBridgeStub
    let bridgePath

    beforeEach(async () => {
      const wrapperPath =
        await awsInvokeLocal.resolveRuntimeWrapperPath('java/target')

      bridgePath = wrapperPath
      fse.mkdirsSync(bridgePath)
      callJavaBridgeStub = sinon
        .stub(awsInvokeLocal, 'callJavaBridge')
        .resolves()
      awsInvokeLocal.provider.options.stage = 'dev'
      awsInvokeLocal.options = {
        function: 'first',
        functionObj: {
          handler: 'handler.hello',
          name: 'hello',
          timeout: 4,
        },
        data: {},
      }
    })

    afterEach(() => {
      awsInvokeLocal.callJavaBridge.restore()
      fse.removeSync(bridgePath)
    })

    it('should invoke callJavaBridge when bridge is built', async () => {
      await awsInvokeLocal.invokeLocalJava(
        'java',
        'com.serverless.Handler',
        'handleRequest',
        tmpServicePath,
        {},
      )

      expect(callJavaBridgeStub.calledOnce).to.be.equal(true)
      expect(
        callJavaBridgeStub.calledWithExactly(
          tmpServicePath,
          'com.serverless.Handler',
          'handleRequest',
          JSON.stringify({
            event: {},
            context: {
              name: 'hello',
              version: 'LATEST',
              logGroupName: '/aws/lambda/hello',
              timeout: 4,
            },
          }),
        ),
      ).to.be.equal(true)
    })

    describe('when attempting to build the Java bridge', () => {
      it("if it's not present yet", async () => {
        await awsInvokeLocal.invokeLocalJava(
          'java',
          'com.serverless.Handler',
          'handleRequest',
          tmpServicePath,
          {},
        )

        expect(callJavaBridgeStub.calledOnce).to.be.equal(true)
        expect(
          callJavaBridgeStub.calledWithExactly(
            tmpServicePath,
            'com.serverless.Handler',
            'handleRequest',
            JSON.stringify({
              event: {},
              context: {
                name: 'hello',
                version: 'LATEST',
                logGroupName: '/aws/lambda/hello',
                timeout: 4,
              },
            }),
          ),
        ).to.be.equal(true)
      })
    })
  })

  describe('#invokeLocalDocker()', () => {
    let pluginMangerSpawnStub
    let pluginMangerSpawnPackageStub
    beforeEach(() => {
      awsInvokeLocal.provider.options.stage = 'dev'
      awsInvokeLocal.options = {
        stage: 'dev',
        function: 'first',
        functionObj: {
          handler: 'handler.hello',
          name: 'hello',
          timeout: 4,
          runtime: 'nodejs16.x',
          environment: {
            functionVar: 'functionValue',
          },
        },
        data: {},
        env: 'commandLineEnvVar=commandLineEnvVarValue',
        'docker-arg': '-p 9292:9292',
      }
      serverless.service.provider.environment = {
        providerVar: 'providerValue',
      }
      pluginMangerSpawnStub = sinon.stub(serverless.pluginManager, 'spawn')
      pluginMangerSpawnPackageStub = pluginMangerSpawnStub
        .withArgs('package')
        .resolves()
    })

    afterEach(() => {
      serverless.pluginManager.spawn.restore()
      fse.removeSync('.serverless')
    })

    it('calls docker with packaged artifact', async () => {
      await awsInvokeLocal.invokeLocalDocker()

      expect(pluginMangerSpawnPackageStub.calledOnce).to.equal(true)
      expect(spawnExtStub.getCall(0).args).to.deep.equal([
        'docker',
        ['version'],
      ])
      expect(spawnExtStub.getCall(1).args).to.deep.equal([
        'docker',
        ['images', '-q', 'lambci/lambda:nodejs16.x'],
      ])
      expect(spawnExtStub.getCall(3).args).to.deep.equal([
        'docker',
        [
          'run',
          '--rm',
          '-v',
          'servicePath:/var/task:ro,delegated',
          '--env',
          'AWS_REGION=us-east-1',
          '--env',
          'AWS_DEFAULT_REGION=us-east-1',
          '--env',
          'AWS_LAMBDA_LOG_GROUP_NAME=/aws/lambda/hello',
          '--env',
          'AWS_LAMBDA_FUNCTION_NAME=hello',
          '--env',
          'AWS_LAMBDA_FUNCTION_MEMORY_SIZE=1024',
          '--env',
          'AWS_ACCESS_KEY_ID=foo',
          '--env',
          'AWS_SECRET_ACCESS_KEY=bar',
          '--env',
          'providerVar=providerValue',
          '--env',
          'functionVar=functionValue',
          '--env',
          'commandLineEnvVar=commandLineEnvVarValue',
          '-p',
          '9292:9292',
          'sls-docker-nodejs16.x',
          'handler.hello',
          '{}',
        ],
      ])
    })
  })

  describe('#getEnvVarsFromOptions', () => {
    it('returns empty object when env option is not set', () => {
      delete awsInvokeLocal.options.env

      const envVarsFromOptions = awsInvokeLocal.getEnvVarsFromOptions()

      expect(envVarsFromOptions).to.be.eql({})
    })

    it('returns empty object when env option empty', () => {
      awsInvokeLocal.options.env = ''

      const envVarsFromOptions = awsInvokeLocal.getEnvVarsFromOptions()

      expect(envVarsFromOptions).to.be.eql({})
    })

    it('returns key value for option separated by =', () => {
      awsInvokeLocal.options.env = 'SOME_ENV_VAR=some-value'

      const envVarsFromOptions = awsInvokeLocal.getEnvVarsFromOptions()

      expect(envVarsFromOptions).to.be.eql({ SOME_ENV_VAR: 'some-value' })
    })

    it('returns key with empty value for option without =', () => {
      awsInvokeLocal.options.env = 'SOME_ENV_VAR'

      const envVarsFromOptions = awsInvokeLocal.getEnvVarsFromOptions()

      expect(envVarsFromOptions).to.be.eql({ SOME_ENV_VAR: '' })
    })

    it('returns key with single value for option multiple =s', () => {
      awsInvokeLocal.options.env = 'SOME_ENV_VAR=value1=value2'

      const envVarsFromOptions = awsInvokeLocal.getEnvVarsFromOptions()

      expect(envVarsFromOptions).to.be.eql({ SOME_ENV_VAR: 'value1=value2' })
    })
  })

  describe('#getDockerArgsFromOptions', () => {
    it('returns empty list when docker-arg option is absent', () => {
      delete awsInvokeLocal.options['docker-arg']

      const dockerArgsFromOptions = awsInvokeLocal.getDockerArgsFromOptions()

      expect(dockerArgsFromOptions).to.eql([])
    })

    it('returns arg split by space when single docker-arg option is present', () => {
      awsInvokeLocal.options['docker-arg'] = '-p 9229:9229'

      const dockerArgsFromOptions = awsInvokeLocal.getDockerArgsFromOptions()

      expect(dockerArgsFromOptions).to.eql(['-p', '9229:9229'])
    })

    it('returns args split by space when multiple docker-arg options are present', () => {
      awsInvokeLocal.options['docker-arg'] = [
        '-p 9229:9229',
        '-v /var/logs:/host-var-logs',
      ]

      const dockerArgsFromOptions = awsInvokeLocal.getDockerArgsFromOptions()

      expect(dockerArgsFromOptions).to.eql([
        '-p',
        '9229:9229',
        '-v',
        '/var/logs:/host-var-logs',
      ])
    })

    it('returns arg split only by first space when docker-arg option has multiple space', () => {
      awsInvokeLocal.options['docker-arg'] = '-v /My Docs:/docs'

      const dockerArgsFromOptions = awsInvokeLocal.getDockerArgsFromOptions()

      expect(dockerArgsFromOptions).to.eql(['-v', '/My Docs:/docs'])
    })
  })
})

describe('test/unit/lib/plugins/aws/invokeLocal/index.test.js', () => {
  const testRuntime = (functionName, options = {}) => {
    describe.skip('Input resolution', () => {
      // All tested with individual runServerless run
      it('TODO: should accept no data', async () => {
        // Confirm outcome on { stdout }
        await runServerless({
          fixture: 'invocation',
          command: 'invoke local',
          options: {
            ...options,
            function: functionName,
          },
        })

        // Replaces
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L149-L154
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L476-L482
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L489-L498
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L511-L547
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L567-L582
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L627-L637
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L671-L680
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L1076-L1086
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L1116-L1173
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L1208-L1256
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L1301-L1334
      })

      it('TODO: should should support plain string data', async () => {
        // Confirm outcome on { stdout }
        await runServerless({
          fixture: 'invocation',
          command: 'invoke local',
          options: {
            ...options,
            function: functionName,
            data: 'inputData',
          },
        })

        // Replaces
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L161-L166
      })

      describe('Automated JSON parsing', () => {
        before(async () => {
          // Confirm outcome on { stdout }
          await runServerless({
            fixture: 'invocation',
            command: 'invoke local',
            options: {
              ...options,
              function: functionName,
              data: '{"inputKey":"inputValue"}',
            },
          })
        })

        it('TODO: should support JSON string data', () => {
          // Replaces
          // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L168-L173
        })
        it('TODO: should support JSON string client context', () => {
          // Replaces
          // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L183-L188
          // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L502-L509
        })
      })

      describe('"--raw" option', () => {
        before(async () => {
          // Confirm outcome on { stdout }
          await runServerless({
            fixture: 'invocation',
            command: 'invoke local',
            options: {
              ...options,
              function: functionName,
              data: '{"inputKey":"inputValue"}',
              raw: true,
            },
          })
        })

        it('TODO: should should not attempt to parse data with raw option', () => {
          // Replaces
          // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L175-L181
        })
        it('TODO: should should not attempt to parse client context with raw option', () => {
          // Replaces
          // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L190-L196
        })
      })

      describe('JSON file input', () => {
        before(async () => {
          // Confirm outcome on { stdout }
          await runServerless({
            fixture: 'invocation',
            command: 'invoke local',
            options: {
              ...options,
              function: functionName,
              path: 'payload.json',
            },
          })
        })
        // Single runServerless run
        it('TODO: should support JSON file path as data', () => {
          // Replaces
          // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L198-L211
        })
        it('TODO: should support JSON file path as client context', () => {})
      })

      it('TODO: should support YAML file path as data', async () => {
        await runServerless({
          fixture: 'invocation',
          command: 'invoke local',
          options: {
            ...options,
            function: functionName,
            path: 'payload.yaml',
          },
        })

        // Replaces
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L229-L241
      })

      it('TODO: should support JS file path for data', async () => {
        await runServerless({
          fixture: 'invocation',
          command: 'invoke local',
          options: {
            ...options,
            function: functionName,
            path: 'payload.js',
          },
        })

        // Replaces
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L243-L263
      })

      it('TODO: should support absolute file path as data', async () => {
        await runServerless({
          fixture: 'invocation',
          command: 'invoke local',
          options: {
            ...options,
            function: functionName,
            path: '' /* TODO: Pass absolute path to payload.json in fixture */,
          },
        })
        // Replaces
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L213-L227
      })

      it('TODO: should throw error if data file path does not exist', async () => {
        await expect(
          runServerless({
            fixture: 'invocation',
            command: 'invoke local',
            options: {
              ...options,
              function: functionName,
              path: 'not-existing.yaml',
            },
          }),
        ).to.eventually.be.rejected.and.have.property('code', 'TODO')
        // Replaces
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L270-L275
      })

      it('TODO: should throw error if function does not exist', async () => {
        await expect(
          runServerless({
            fixture: 'invocation',
            command: 'invoke local',
            options: {
              ...options,
              function: 'notExisting',
            },
          }),
        ).to.eventually.be.rejected.and.have.property('code', 'TODO')
        // Replaces
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L156-L159
      })
    })

    describe('Environment variables', () => {
      let responseBody
      before(async () => {
        process.env.AWS_ACCESS_KEY_ID = 'AAKIXXX'
        process.env.AWS_SECRET_ACCESS_KEY = 'ASAKXXX'

        // Confirm outcome on { output }
        const response = await runServerless({
          fixture: 'invocation',
          command: 'invoke local',
          options: {
            ...options,
            function: functionName,
            env: 'PARAM_ENV_VAR=-Dblart=snort',
          },
          configExt: {
            provider: {
              runtime: 'nodejs14.x',
              environment: {
                PROVIDER_LEVEL_VAR: 'PROVIDER_LEVEL_VAR_VALUE',
                NULL_VAR: null,
              },
              region: 'us-east-2',
            },
            functions: {
              fn: {
                environment: {
                  FUNCTION_LEVEL_VAR: 'FUNCTION_LEVEL_VAR_VALUE',
                },
              },
            },
          },
        })
        const outputAsJson = (() => {
          try {
            return JSON.parse(response.output)
          } catch (error) {
            log.error('Unexpected response output: %s', response.output)
            throw error
          }
        })()
        responseBody = JSON.parse(outputAsJson.body)
      })

      after(() => {
        delete process.env.AWS_ACCESS_KEY_ID
        delete process.env.AWS_SECRET_ACCESS_KEY
      })

      xit('TODO: should expose eventual AWS credentials in environment variables', () => {
        // Replaces
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L284-L327
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L390-L402
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L404-L415
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L417-L424
      })
      xit('TODO: should expose `provider.env` in environment variables', () => {
        // Replaces
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L354-L357
      })
      xit('TODO: should expose `provider.profile` in environment variables', () => {
        // Replaces
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L359-L363
      })
      xit('TODO: should expose `functions[].env` in environment variables', () => {
        // Replaces
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L365-L368
      })
      it('should expose `--env` vars in environment variables', async () =>
        expect(responseBody.env.PARAM_ENV_VAR).to.equal('-Dblart=snort'))

      xit('TODO: should expose default lambda environment variables', () => {
        // Replaces
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L370-L388
      })
      xit('TODO: should resolve region from `service.provider` if not provided via option', () => {
        // Replaces
        // https://github.com/serverless/serverless/blob/95c0bc09421b869ae1d8fc5dea42a2fce1c2023e/test/unit/lib/plugins/aws/invokeLocal/index.test.js#L426-L441
      })

      it('should not expose null environment variables', async () =>
        expect(responseBody.env).to.not.have.property('NULL_VAR'))
    })
  }

  describe('Node.js', () => {
    testRuntime('callback')

    it('should support success resolution via async function', async () => {
      const { output } = await runServerless({
        fixture: 'invocation',
        command: 'invoke local',
        options: { function: 'async' },
      })

      expect(output).to.include('Invoked')
    })

    it('should support success resolution via context.done', async () => {
      const { output } = await runServerless({
        fixture: 'invocation',
        command: 'invoke local',
        options: { function: 'contextDone' },
      })

      expect(output).to.include('Invoked')
    })

    it('should support success resolution via context.succeed', async () => {
      const { output } = await runServerless({
        fixture: 'invocation',
        command: 'invoke local',
        options: { function: 'contextSucceed' },
      })

      expect(output).to.include('Invoked')
    })

    it('should support immediate failure at initialization', async () => {
      await expect(
        runServerless({
          fixture: 'invocation',
          command: 'invoke local',
          options: { function: 'initFail' },
        }),
      ).to.eventually.be.rejected.and.have.property(
        'code',
        'INVOKE_LOCAL_LAMBDA_INITIALIZATION_FAILED',
      )
    })

    it('should support immediate failure at invocation', async () => {
      await expect(
        runServerless({
          fixture: 'invocation',
          command: 'invoke local',
          options: { function: 'invocationFail' },
        }),
      ).to.eventually.be.rejectedWith('Invocation fail')
    })

    it('should support failure resolution via async function', async () => {
      const { output } = await runServerless({
        fixture: 'invocation',
        command: 'invoke local',
        options: { function: 'async', data: '{"shouldFail":true}' },
      })

      expect(output).to.include('Failed on request')
    })

    it('should support failure resolution via callback', async () => {
      const { output } = await runServerless({
        fixture: 'invocation',
        command: 'invoke local',
        options: { function: 'callback', data: '{"shouldFail":true}' },
      })

      expect(output).to.include('Failed on request')
    })

    it('should support failure resolution via context.done', async () => {
      const { output } = await runServerless({
        fixture: 'invocation',
        command: 'invoke local',
        options: { function: 'contextDone', data: '{"shouldFail":true}' },
      })

      expect(output).to.include('Failed on request')
    })

    it('should support failure resolution via context.fail', async () => {
      const { output } = await runServerless({
        fixture: 'invocation',
        command: 'invoke local',
        options: { function: 'contextSucceed', data: '{"shouldFail":true}' },
      })

      expect(output).to.include('Failed on request')
    })

    it('should recognize first resolution', async () => {
      const { output: firstRunOutput } = await runServerless({
        fixture: 'invocation',
        command: 'invoke local',
        options: { function: 'doubledResolutionCallbackFirst' },
      })
      const { output: secondRunOutput } = await runServerless({
        fixture: 'invocation',
        command: 'invoke local',
        options: { function: 'doubledResolutionPromiseFirst' },
      })

      expect(firstRunOutput).to.include('callback')
      expect(secondRunOutput).to.include('promise')
    })

    it('should support context.remainingTimeInMillis()', async () => {
      const { output } = await runServerless({
        fixture: 'invocation',
        command: 'invoke local',
        options: { function: 'remainingTime' },
      })

      const body = JSON.parse(output).body
      const [firstRemainingMs, secondRemainingMs, thirdRemainingMs] =
        JSON.parse(body).data
      expect(firstRemainingMs).to.be.lte(3000)
      expect(secondRemainingMs).to.be.lte(2910)
      expect(thirdRemainingMs).to.be.lte(secondRemainingMs)
    })

    it('should support handlers with `.cjs` extension', async () => {
      const { output } = await runServerless({
        fixture: 'invocation',
        command: 'invoke local',
        options: { function: 'asyncCjs' },
      })

      expect(output).to.include('Invoked')
    })
    it('should support handlers that are ES modules', async () => {
      const { output } = await runServerless({
        fixture: 'invocation',
        command: 'invoke local',
        options: { function: 'asyncEsm' },
      })

      expect(output).to.include('Invoked')
    })
  })

  describe('Python', () => {
    before(async function () {
      const executable = process.platform === 'win32' ? 'python.exe' : 'python'
      try {
        await spawnExt(executable, ['--version'])
      } catch (err) {
        skipWithNotice(this, 'Python runtime is not installed')
      }
    })

    testRuntime('python')
    describe('context.remainingTimeInMillis', () => {
      it('should support context.get_remaining_time_in_millis()', async () => {
        const { output } = await runServerless({
          fixture: 'invocation',
          command: 'invoke local',
          options: { function: 'pythonRemainingTime' },
        })

        const { start, stop } = JSON.parse(output)
        expect(start).to.lte(3000)
        expect(stop).to.lte(2910)
      })
    })
  })

  describe('Ruby', () => {
    before(async function () {
      const executable = process.platform === 'win32' ? 'ruby.exe' : 'ruby'
      try {
        await spawnExt(executable, ['--version'])
      } catch (err) {
        skipWithNotice(this, 'Ruby runtime is not installed')
      }
    })

    testRuntime('ruby')

    it('should support class/module address in handler for "ruby*" runtime', async () => {
      const { output } = await runServerless({
        fixture: 'invocation',
        command: 'invoke local',
        options: { function: 'rubyClass' },
      })

      expect(output).to.include('rubyclass')
    })
    it('should support context.get_remaining_time_in_millis()', async () => {
      const { output } = await runServerless({
        fixture: 'invocation',
        command: 'invoke local',
        options: { function: 'rubyRemainingTime' },
      })

      const { start, stop } = JSON.parse(output)
      expect(start).to.lte(6000)
      expect(stop).to.lte(5910)
    })
    it('should support context.deadline_ms', async () => {
      const { output } = await runServerless({
        fixture: 'invocation',
        command: 'invoke local',
        options: { function: 'rubyDeadline' },
      })

      const { deadlineMs } = JSON.parse(output)
      expect(deadlineMs).to.be.gt(Date.now())
    })
  })

  describe.skip('Java', () => {
    // If Java runtime is not installed, skip below tests by:
    // - Invoke skip with notice as here;
    // https://github.com/serverless/serverless/blob/2d6824cde531ba56758f441b39b5ab018702e866/lib/plugins/aws/invokeLocal/index.test.js#L1043-L1045
    // - Ensure all other tests are skipped
    testRuntime('java') // TODO: Configure java handler
  })

  describe.skip('Docker', () => {
    // If Docker is not installed, skip below tests by:
    // - Invoke skip with notice as here;
    // https://github.com/serverless/serverless/blob/2d6824cde531ba56758f441b39b5ab018702e866/lib/plugins/aws/invokeLocal/index.test.js#L1043-L1045
    // - Ensure all other tests are skipped

    testRuntime('callback', ['--docker'])
    it('TODO: should support "provided" runtime in docker invocation', () => {})
  })
})