Skip to content

Commit d1a4ab9

Browse files
Jiaxin FanJiaxin Fan
authored andcommitted
Revised README, also add EOL at end of file
Attempt to fix trailing white space Checked for typos Fix minor formatting error, test Git still works WIP: update top-level README
1 parent 752c8a9 commit d1a4ab9

File tree

2 files changed

+39
-6
lines changed

2 files changed

+39
-6
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,3 +114,4 @@ This will return the following runtime images with the following names: `action-
114114
```
115115
./gradlew :tests:test
116116
```
117+
An update about the details of verifying a standalone container can be found [here](https://github.com/apache/openwhisk-runtime-nodejs/pull/227/files#diff-c115bfeccd5f4a2e984d66e08ad3b677350baecacc248bc20d7585c2b6fe11e8)

tests/src/test/standalone/README.md

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,32 +26,64 @@ The following example shows how to generate a Docker image for the Node.js 18 ru
2626
```
2727
./gradlew core:nodejs18Action:distDocker
2828
```
29-
This will return the following runtime image with the name `action-nodejs-v18`
29+
This will return the following runtime image with the name `action-nodejs-v18`, which should be listed after using the `docker images`
3030

3131
## Running the Container
32-
For the purpose of the test. We are going to access the the runner container via `localhost`.
33-
The `Action` container exposes `port 8080` (see the Dockerfile for the associated Docker image), thus we publish the container's `port 8080` to the `localhost`:
32+
For the purpose of the test. We are going to start the container that has a web service running inside it built using Node/Express. In order to access this service within the container from the outside, as we are about to do using `curl`, port mapping needs to be done next. As a result, we can now access the web service inside docker by first reaching an IP port on `localhost`, which subsequently forwards the request to the docker container's designated port.
33+
In our example, the `Action` container exposes `port 8080` (see the Dockerfile for the associated Docker image), thus we publish the container's `port 8080` to the `localhost` (here, `port 3008` on `localhost` is chosen arbitrarily, as long as the port is not already assigned for something else):
3434
```
3535
docker run --publish 3008:8080 -i -t action-nodejs-v18:latest
3636
```
37+
A simpler way is to map `port 80` on `localhost` to the container's `port 8080`. The port number assigned to the HTTP protocol is `80` Since we will be sending actions against the runtime using HTTP, using this number will allow us to omit the port in the request later. Without loss of generality, the following examples will use the arbitrarily chosen `port 3008`
3738

3839
## Testing
3940
This example has prepared a `helloworld.json` file to post using `curl`.
41+
```json
42+
{
43+
"value": {
44+
"name" : "nodejs-helloworld",
45+
"main" : "main",
46+
"binary": false,
47+
"code" : "function main() {return {payload: 'Hello World!'};}"
48+
}
49+
}
50+
```
51+
The json file contains a simple JavaScript function, which is the actual payload.
4052

4153
### Initialze the Runtime
42-
Initialize the runtime with by invoking the ```/init``` endpoint.
54+
Before issuing the action against the runtime, we first initialize the function with by invoking the ```/init``` endpoint.
4355
```
4456
curl -H "Content-Type:application/json" -X POST --data '@openwhisk-runtime-nodejs/tests/src/test/standalone/helloworld/helloworld.json' http://localhost:3008/init
4557
4658
{"OK":true}
4759
```
60+
being the expected response.
61+
62+
As mentioned above, if `port 80` on `localhost` was used, the command could simply be
63+
```
64+
curl -H "Content-Type:application/json" -X POST --data '@openwhisk-runtime-nodejs/tests/src/test/standalone/helloworld/helloworld.json' http://localhost/init
65+
```
4866

4967
#### Run the function
5068

51-
Execute the function using the ```/run``` endpoint.
69+
Invoke the function using the ```/run``` endpoint.
5270

5371
```
5472
curl -H ""Content-Type:application/json" -X POST --data '@openwhisk-runtime-nodejs/tests/src/test/standalone/helloworld/helloworld.json' http://localhost:3008/run
73+
```
5574

75+
The JavaScript function in this example is one without arguments. Using the same json file as during initialization won't be a problem. Strictly speaking, we should have provided another json file with the arguments. In our case, it should simply be
76+
```json
77+
{
78+
"value": {}
79+
}
80+
```
81+
The expected response should be
82+
```
5683
{"payload":"Hello World!"}
57-
```
84+
```
85+
Also the running container will print
86+
```
87+
XXX_THE_END_OF_A_WHISK_ACTIVATION_XXX
88+
```
89+
in the terminal

0 commit comments

Comments
 (0)