| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You under the Apache License, Version 2.0 |
| * (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package runtime.actionContainers |
| |
| import java.io.File |
| |
| import common.WskActorSystem |
| import actionContainers.{ActionContainer, BasicActionRunnerTests, ResourceHelpers} |
| import actionContainers.ActionContainer.withContainer |
| import actionContainers.ResourceHelpers.ZipBuilder |
| import spray.json._ |
| |
| abstract class NodeJsActionContainerTests extends BasicActionRunnerTests with WskActorSystem { |
| |
| val nodejsContainerImageName: String |
| val nodejsTestDockerImageName: String |
| |
| override def withActionContainer(env: Map[String, String] = Map.empty)(code: ActionContainer => Unit) = { |
| withContainer(nodejsContainerImageName, env)(code) |
| } |
| |
| def withNodeJsContainer(code: ActionContainer => Unit) = withActionContainer()(code) |
| |
| behavior of nodejsContainerImageName |
| |
| override val testNoSourceOrExec = { |
| TestConfig("") |
| } |
| |
| override val testNotReturningJson = { |
| TestConfig( |
| """ |
| |function main(args) { |
| | return "not a json object" |
| |} |
| """.stripMargin, |
| enforceEmptyErrorStream = false) |
| } |
| |
| override val testEcho = { |
| TestConfig(""" |
| |function main(args) { |
| | console.log('hello stdout') |
| | console.error('hello stderr') |
| | return args |
| |} |
| """.stripMargin) |
| } |
| |
| override val testUnicode = { |
| TestConfig(""" |
| |function main(args) { |
| | var str = args.delimiter + " ☃ " + args.delimiter; |
| | console.log(str); |
| | return { "winter": str }; |
| |} |
| """.stripMargin.trim) |
| } |
| |
| override val testEnv = { |
| TestConfig(""" |
| |function main(args) { |
| | return { |
| | "api_host": process.env['__OW_API_HOST'], |
| | "api_key": process.env['__OW_API_KEY'], |
| | "namespace": process.env['__OW_NAMESPACE'], |
| | "action_name": process.env['__OW_ACTION_NAME'], |
| | "activation_id": process.env['__OW_ACTIVATION_ID'], |
| | "deadline": process.env['__OW_DEADLINE'] |
| | } |
| |} |
| """.stripMargin.trim) |
| } |
| |
| override val testEnvParameters = { |
| // the environment variables are ready at load time to ensure |
| // variables are already available in the runtime |
| TestConfig(""" |
| |const envargs = { |
| | "SOME_VAR": process.env.SOME_VAR, |
| | "ANOTHER_VAR": process.env.ANOTHER_VAR |
| |} |
| | |
| |function main(args) { |
| | return envargs |
| |} |
| """.stripMargin.trim) |
| } |
| |
| override val testInitCannotBeCalledMoreThanOnce = { |
| TestConfig(""" |
| |function main(args) { |
| | return args |
| |} |
| """.stripMargin) |
| } |
| |
| override val testEntryPointOtherThanMain = { |
| TestConfig( |
| """ |
| | function niam(args) { |
| | return args; |
| | } |
| """.stripMargin, |
| main = "niam") |
| } |
| |
| override val testLargeInput = { |
| TestConfig(""" |
| |function main(args) { |
| | return args |
| |} |
| """.stripMargin) |
| } |
| |
| it should "fail to initialize with bad code" in { |
| val (out, err) = withNodeJsContainer { c => |
| val code = |
| """ |
| | 10 PRINT "Hello world!" |
| | 20 GOTO 10 |
| """.stripMargin |
| |
| val (initCode, _) = c.init(initPayload(code)) |
| |
| initCode should not be (200) |
| } |
| |
| // Somewhere, the logs should mention an error occurred. |
| checkStreams(out, err, { |
| case (o, e) => |
| (o + e).toLowerCase should include("error") |
| (o + e).toLowerCase should include("syntax") |
| }) |
| } |
| |
| it should "fail to initialize with no code" in { |
| val (out, err) = withNodeJsContainer { c => |
| val code = "" |
| |
| val (initCode, error) = c.init(initPayload(code)) |
| |
| initCode should not be (200) |
| error shouldBe a[Some[_]] |
| error.get shouldBe a[JsObject] |
| error.get.fields("error").toString should include("no code to execute") |
| } |
| } |
| |
| it should "return some error on action error" in { |
| withNodeJsContainer { c => |
| val code = |
| """ |
| | function main(args) { |
| | throw "nooooo"; |
| | } |
| """.stripMargin |
| |
| val (initCode, _) = c.init(initPayload(code)) |
| initCode should be(200) |
| |
| val (runCode, runRes) = c.run(runPayload(JsObject())) |
| runCode should not be (200) |
| |
| runRes shouldBe defined |
| runRes.get.fields.get("error") shouldBe defined |
| runRes.get.fields("error").toString.toLowerCase should include("nooooo") |
| } |
| } |
| |
| it should "support application errors" in { |
| withNodeJsContainer { c => |
| val code = |
| """ |
| | function main(args) { |
| | return { "error" : "sorry" }; |
| | } |
| """.stripMargin; |
| |
| val (initCode, _) = c.init(initPayload(code)) |
| initCode should be(200) |
| |
| val (runCode, runRes) = c.run(runPayload(JsObject())) |
| runCode should be(200) // action writer returning an error is OK |
| |
| runRes shouldBe defined |
| runRes.get.fields.get("error") shouldBe defined |
| } |
| } |
| |
| it should "support the documentation examples (1)" in { |
| val (out, err) = withNodeJsContainer { c => |
| val code = |
| """ |
| | // an action in which each path results in a synchronous activation |
| | function main(params) { |
| | if (params.payload == 0) { |
| | return; |
| | } else if (params.payload == 1) { |
| | return {payload: 'Hello, World!'} // indicates normal completion |
| | } else if (params.payload == 2) { |
| | return {error: 'payload must be 0 or 1'} // indicates abnormal completion |
| | } |
| | } |
| """.stripMargin |
| |
| c.init(initPayload(code))._1 should be(200) |
| |
| val (c1, r1) = c.run(runPayload(JsObject("payload" -> JsNumber(0)))) |
| val (c2, r2) = c.run(runPayload(JsObject("payload" -> JsNumber(1)))) |
| val (c3, r3) = c.run(runPayload(JsObject("payload" -> JsNumber(2)))) |
| |
| c1 should be(200) |
| r1 should be(Some(JsObject())) |
| |
| c2 should be(200) |
| r2 should be(Some(JsObject("payload" -> JsString("Hello, World!")))) |
| |
| c3 should be(200) // application error, not container or system |
| r3.get.fields.get("error") shouldBe Some(JsString("payload must be 0 or 1")) |
| } |
| |
| checkStreams(out, err, { |
| case (o, e) => |
| o shouldBe empty |
| e shouldBe empty |
| }, 3) |
| |
| } |
| |
| it should "support the documentation examples (2)" in { |
| val (out, err) = withNodeJsContainer { c => |
| val code = |
| """ |
| | function main(params) { |
| | if (params.payload) { |
| | // asynchronous activation |
| | return new Promise(function(resolve, reject) { |
| | setTimeout(function() { |
| | resolve({ done: true }); |
| | }, 100); |
| | }) |
| | } else { |
| | // synchronous activation |
| | return {done: true}; |
| | } |
| | } |
| """.stripMargin |
| |
| c.init(initPayload(code))._1 should be(200) |
| |
| val (c1, r1) = c.run(runPayload(JsObject())) |
| val (c2, r2) = c.run(runPayload(JsObject("payload" -> JsBoolean(true)))) |
| |
| c1 should be(200) |
| r1 should be(Some(JsObject("done" -> JsBoolean(true)))) |
| |
| c2 should be(200) |
| r2 should be(Some(JsObject("done" -> JsBoolean(true)))) |
| } |
| |
| checkStreams(out, err, { |
| case (o, e) => |
| o shouldBe empty |
| e shouldBe empty |
| }, 2) |
| } |
| |
| it should "support variables with no var declaration" in { |
| val (out, err) = withNodeJsContainer { c => |
| val code = |
| """ |
| | function main(params) { |
| | greeting = 'hello, ' + params.payload + '!' |
| | console.log(greeting); |
| | return {payload: greeting} |
| | } |
| """.stripMargin |
| |
| c.init(initPayload(code))._1 should be(200) |
| |
| val (runCode, result) = c.run(runPayload(JsObject("payload" -> JsString("test")))) |
| runCode should be(200) |
| result should be(Some(JsObject("payload" -> JsString("hello, test!")))) |
| } |
| |
| checkStreams(out, err, { |
| case (o, e) => |
| o shouldBe "hello, test!" |
| e shouldBe empty |
| }) |
| } |
| |
| it should "support webpacked function" in { |
| val (out, err) = withNodeJsContainer { c => |
| val code = |
| """ |
| |function foo() { |
| | return { bar: true } |
| |} |
| |global.main = foo |
| """.stripMargin |
| |
| c.init(initPayload(code))._1 should be(200) |
| |
| val (runCode, result) = c.run(JsObject.empty) |
| runCode should be(200) |
| result should be(Some(JsObject("bar" -> JsTrue))) |
| } |
| |
| checkStreams(out, err, { |
| case (o, e) => |
| o shouldBe empty |
| e shouldBe empty |
| }) |
| } |
| |
| it should "error when requiring a non-existent package" in { |
| // NPM package names cannot start with a dot, and so there is no danger |
| // of the package below ever being valid. |
| // https://docs.npmjs.com/files/package.json |
| val (out, err) = withNodeJsContainer { c => |
| val code = |
| """ |
| | function main(args) { |
| | require('.mildlyinvalidnameofanonexistentpackage'); |
| | } |
| """.stripMargin |
| |
| val (initCode, _) = c.init(initPayload(code)) |
| |
| initCode should be(200) |
| |
| val (runCode, out) = c.run(runPayload(JsObject())) |
| |
| runCode should not be (200) |
| } |
| |
| // Somewhere, the logs should mention an error occurred. |
| checkStreams(out, err, { |
| case (o, e) => (o + e) should include("MODULE_NOT_FOUND") |
| }) |
| } |
| |
| it should "have openwhisk package available" in { |
| // GIVEN that it should "error when requiring a non-existent package" (see test above for this) |
| val (out, err) = withNodeJsContainer { c => |
| val code = |
| """ |
| | function main(args) { |
| | require('openwhisk'); |
| | } |
| """.stripMargin |
| |
| val (initCode, _) = c.init(initPayload(code)) |
| |
| initCode should be(200) |
| |
| // WHEN I run an action that requires ws and socket.io.client |
| val (runCode, out) = c.run(runPayload(JsObject())) |
| |
| // THEN it should pass only when these packages are available |
| runCode should be(200) |
| } |
| |
| checkStreams(out, err, { |
| case (o, e) => |
| o shouldBe empty |
| e shouldBe empty |
| }) |
| } |
| |
| it should "support resolved promises" in { |
| val (out, err) = withNodeJsContainer { c => |
| val code = |
| """ |
| | function main(args) { |
| | return new Promise(function(resolve, reject) { |
| | setTimeout(function() { |
| | resolve({ done: true }); |
| | }, 100); |
| | }) |
| | } |
| """.stripMargin |
| |
| c.init(initPayload(code))._1 should be(200) |
| |
| val (runCode, runRes) = c.run(runPayload(JsObject())) |
| runCode should be(200) |
| runRes should be(Some(JsObject("done" -> JsBoolean(true)))) |
| } |
| |
| checkStreams(out, err, { |
| case (o, e) => |
| o shouldBe empty |
| e shouldBe empty |
| }) |
| } |
| |
| it should "support rejected promises" in { |
| val (out, err) = withNodeJsContainer { c => |
| val code = |
| """ |
| | function main(args) { |
| | return new Promise(function(resolve, reject) { |
| | setTimeout(function() { |
| | reject({ done: true }); |
| | }, 100); |
| | }) |
| | } |
| """.stripMargin |
| |
| c.init(initPayload(code))._1 should be(200) |
| |
| val (runCode, runRes) = c.run(runPayload(JsObject())) |
| |
| runCode should be(200) |
| runRes.get.fields.get("error") shouldBe defined |
| } |
| |
| checkStreams(out, err, { |
| case (o, e) => |
| o shouldBe empty |
| e shouldBe empty |
| }) |
| } |
| |
| it should "support rejected promises with no message" in { |
| val (out, err) = withNodeJsContainer { c => |
| val code = |
| """ |
| | function main(args) { |
| | return new Promise(function (resolve, reject) { |
| | reject(); |
| | }); |
| | }""".stripMargin |
| |
| c.init(initPayload(code))._1 should be(200) |
| val (runCode, runRes) = c.run(runPayload(JsObject())) |
| runRes.get.fields.get("error") shouldBe defined |
| } |
| } |
| |
| it should "support large-ish actions" in { |
| val thought = " I took the one less traveled by, and that has made all the difference." |
| val assignment = " x = \"" + thought + "\";\n" |
| |
| val code = |
| """ |
| | function main(args) { |
| | var x = "hello"; |
| """.stripMargin + (assignment * 7000) + |
| """ |
| | x = "world"; |
| | return { "message" : x }; |
| | } |
| """.stripMargin |
| |
| // Lest someone should make it too easy. |
| code.length should be >= 500000 |
| |
| val (out, err) = withNodeJsContainer { c => |
| c.init(initPayload(code))._1 should be(200) |
| |
| val (runCode, runRes) = c.run(runPayload(JsObject())) |
| |
| runCode should be(200) |
| runRes.get.fields.get("message") shouldBe Some(JsString("world")) |
| } |
| |
| checkStreams(out, err, { |
| case (o, e) => |
| o shouldBe empty |
| e shouldBe empty |
| }) |
| } |
| |
| val examplePackageDotJson: String = |
| """ |
| | { |
| | "name": "wskaction", |
| | "version": "1.0.0", |
| | "description": "An OpenWhisk action as an npm package.", |
| | "main": "index.js", |
| | "author": "info@openwhisk.org", |
| | "license": "Apache-2.0" |
| | } |
| """.stripMargin |
| |
| it should "support zip-encoded npm package actions" in { |
| val srcs = Seq( |
| Seq("package.json") -> examplePackageDotJson, |
| Seq("index.js") -> |
| """ |
| | exports.main = function (args) { |
| | var name = typeof args["name"] === "string" ? args["name"] : "stranger"; |
| | |
| | return { |
| | greeting: "Hello " + name + ", from an npm package action." |
| | }; |
| | } |
| """.stripMargin) |
| |
| val code = ZipBuilder.mkBase64Zip(srcs) |
| |
| val (out, err) = withNodeJsContainer { c => |
| c.init(initPayload(code))._1 should be(200) |
| |
| val (runCode, runRes) = c.run(runPayload(JsObject())) |
| |
| runCode should be(200) |
| runRes.get.fields.get("greeting") shouldBe Some(JsString("Hello stranger, from an npm package action.")) |
| } |
| |
| checkStreams(out, err, { |
| case (o, e) => |
| o shouldBe empty |
| e shouldBe empty |
| }) |
| } |
| |
| it should "support zip-encoded npm package actions without a package.json file" in { |
| val srcs = Seq( |
| Seq("index.js") -> |
| """ |
| | exports.main = function (args) { |
| | var name = typeof args["name"] === "string" ? args["name"] : "stranger"; |
| | |
| | return { |
| | greeting: "Hello " + name + ", from an npm package action without a package.json." |
| | }; |
| | } |
| """.stripMargin) |
| |
| val code = ZipBuilder.mkBase64Zip(srcs) |
| |
| val (out, err) = withNodeJsContainer { c => |
| c.init(initPayload(code))._1 should be(200) |
| |
| val (runCode, runRes) = c.run(runPayload(JsObject())) |
| |
| runCode should be(200) |
| runRes.get.fields.get("greeting") shouldBe Some( |
| JsString("Hello stranger, from an npm package action without a package.json.")) |
| } |
| |
| checkStreams(out, err, { |
| case (o, e) => |
| o shouldBe empty |
| e shouldBe empty |
| }) |
| } |
| |
| it should "support zip-encoded npm package with main from file other than index.js" in { |
| val srcs = Seq( |
| Seq("other.js") -> |
| """ |
| | exports.niam = function (args) { |
| | var name = typeof args["name"] === "string" ? args["name"] : "stranger"; |
| | |
| | return { |
| | greeting: "Hello " + name + ", from other.niam." |
| | }; |
| | } |
| """.stripMargin) |
| |
| val code = ZipBuilder.mkBase64Zip(srcs) |
| |
| val (out, err) = withNodeJsContainer { c => |
| c.init(initPayload(code, "other.niam"))._1 should be(200) |
| |
| val (runCode, runRes) = c.run(runPayload(JsObject())) |
| runCode should be(200) |
| runRes.get.fields.get("greeting") shouldBe Some(JsString("Hello stranger, from other.niam.")) |
| } |
| |
| checkStreams(out, err, { |
| case (o, e) => |
| o shouldBe empty |
| e shouldBe empty |
| }) |
| } |
| |
| it should "support nested main" in { |
| val srcs = Seq( |
| Seq("other.js") -> |
| """ |
| | exports.niam = { xyz: function (args) { |
| | var name = typeof args["name"] === "string" ? args["name"] : "stranger"; |
| | |
| | return { |
| | greeting: "Hello " + name + ", from nested main." |
| | }; |
| | } } |
| """.stripMargin) |
| |
| val code = ZipBuilder.mkBase64Zip(srcs) |
| |
| val (out, err) = withNodeJsContainer { c => |
| c.init(initPayload(code, "other.niam.xyz"))._1 should be(200) |
| |
| val (runCode, runRes) = c.run(runPayload(JsObject())) |
| runCode should be(200) |
| runRes.get.fields.get("greeting") shouldBe Some(JsString("Hello stranger, from nested main.")) |
| } |
| |
| checkStreams(out, err, { |
| case (o, e) => |
| o shouldBe empty |
| e shouldBe empty |
| }) |
| } |
| |
| it should "allow zip-encoded npm package containing package.json and overriding entry point" in { |
| val srcs = Seq( |
| Seq("package.json") -> examplePackageDotJson, |
| Seq("index.js") -> |
| """ |
| | exports.main = function (args) { |
| | return { result: "it works" }; |
| | } |
| """, |
| Seq("other.js") -> |
| """ |
| | exports.niam = function (args) { |
| | return { result: "it should also work" }; |
| | } |
| """.stripMargin) |
| |
| val code = ZipBuilder.mkBase64Zip(srcs) |
| |
| val (out, err) = withNodeJsContainer { c => |
| c.init(initPayload(code, "other.niam"))._1 should be(200) |
| |
| val (runCode, runRes) = c.run(runPayload(JsObject())) |
| runCode should be(200) |
| runRes.get.fields.get("result") shouldBe Some(JsString("it should also work")) |
| } |
| |
| checkStreams(out, err, { |
| case (o, e) => |
| o shouldBe empty |
| e shouldBe empty |
| }) |
| } |
| |
| it should "fail gracefully on invalid zip files" in { |
| // Some text-file encoded to base64. |
| val code = "Q2VjaSBuJ2VzdCBwYXMgdW4gemlwLgo=" |
| |
| val (out, err) = withNodeJsContainer { c => |
| c.init(initPayload(code))._1 should not be (200) |
| } |
| |
| // Somewhere, the logs should mention the connection to the archive. |
| checkStreams(out, err, { |
| case (o, e) => |
| (o + e).toLowerCase should include("error") |
| (o + e).toLowerCase should include("uncompressing") |
| }) |
| } |
| |
| it should "fail gracefully on valid zip files that are not actions" in { |
| val srcs = Seq( |
| Seq("hello") -> |
| """ |
| | Hello world! |
| """.stripMargin) |
| |
| val code = ZipBuilder.mkBase64Zip(srcs) |
| |
| val (out, err) = withNodeJsContainer { c => |
| c.init(initPayload(code))._1 should not be (200) |
| } |
| |
| checkStreams(out, err, { |
| case (o, e) => |
| (o + e).toLowerCase should include("error") |
| (o + e).toLowerCase should include("zipped actions must contain either package.json or index.js at the root.") |
| }) |
| } |
| |
| it should "support zipped actions using non-default entry point" in { |
| val srcs = Seq( |
| Seq("package.json") -> examplePackageDotJson, |
| Seq("index.js") -> |
| """ |
| | exports.niam = function (args) { |
| | return { result: "it works" }; |
| | } |
| """.stripMargin) |
| |
| val code = ZipBuilder.mkBase64Zip(srcs) |
| |
| withNodeJsContainer { c => |
| c.init(initPayload(code, main = "niam"))._1 should be(200) |
| |
| val (runCode, runRes) = c.run(runPayload(JsObject())) |
| runRes.get.fields.get("result") shouldBe Some(JsString("it works")) |
| } |
| } |
| |
| it should "set correct cwd for zipped actions" in { |
| val srcs = Seq( |
| Seq("package.json") -> examplePackageDotJson, |
| Seq("test.txt") -> "test text", |
| Seq("index.js") -> |
| s""" |
| | const fs = require('fs'); |
| | exports.main = function (args) { |
| | const fileData = fs.readFileSync('./test.txt').toString(); |
| | return { result1: fileData, |
| | result2: __dirname === process.cwd() }; |
| | } |
| """.stripMargin) |
| |
| val code = ZipBuilder.mkBase64Zip(srcs) |
| |
| withNodeJsContainer { c => |
| c.init(initPayload(code))._1 should be(200) |
| |
| val (runCode, runRes) = c.run(runPayload(JsObject())) |
| runRes.get.fields.get("result1") shouldBe Some(JsString("test text")) |
| runRes.get.fields.get("result2") shouldBe Some(JsBoolean(true)) |
| } |
| } |
| |
| it should "support default function parameters" in { |
| val (out, err) = withNodeJsContainer { c => |
| val code = |
| """ |
| | function main(args) { |
| | let foo = 3; |
| | return {isValid: (function (a, b = 2) {return a === 3 && b === 2;}(foo))}; |
| | } |
| """.stripMargin |
| |
| val (initCode, _) = c.init(initPayload(code)) |
| initCode should be(200) |
| |
| val (runCode, runRes) = c.run(runPayload(JsObject())) |
| runCode should be(200) |
| runRes should be(Some(JsObject("isValid" -> JsBoolean(true)))) |
| |
| } |
| |
| checkStreams(out, err, { |
| case (o, e) => |
| o shouldBe empty |
| e shouldBe empty |
| }) |
| } |
| |
| it should "use user provided npm packages in a zip file" in { |
| val zipPath = new File("tests/dat/actions/nodejs-test.zip").toPath |
| val code = ResourceHelpers.readAsBase64(zipPath) |
| withNodeJsContainer { c => |
| c.init(initPayload(code))._1 should be(200) |
| |
| val (runCode, runRes) = c.run(runPayload(JsObject())) |
| runRes.get.fields.get("message") shouldBe Some(JsString("hello local library")) |
| } |
| } |
| |
| it should "use user provided packages in Docker Actions" in { |
| withContainer(nodejsTestDockerImageName) { c => |
| val code = |
| """ |
| | function main(args) { |
| | var ow = require('openwhisk'); |
| | // actions only exists on 2.* versions of openwhisk, not 3.*, so if this was 3.* it would throw an error, |
| | var actions = ow().actions; |
| | |
| | return { "message": "success" }; |
| |} |
| """.stripMargin |
| // Initialization of the code should be successful |
| val (initCode, err) = c.init(initPayload(code)) |
| initCode should be(200) |
| |
| // Running the code should be successful and return a 200 status |
| val (runCode, runRes) = c.run(runPayload(JsObject())) |
| runCode should be(200) |
| |
| runRes shouldBe defined |
| runRes.get.fields.get("message") shouldBe Some(JsString("success")) |
| } |
| } |
| } |
