Add Ruby2.5 runtime support #3725

remore · 2018-06-06T04:25:42Z

This PR adds a new ruby:2.5 kind to allow Ruby methods like this:

def main(param)
  { :result => param.upcase }
end

Description

This PR is quite similar to #2415, but this time I did it in Ruby. I do believe there are certain number of developers who'd love to pick Ruby as a primary language (see #2046 for an instance).

Currently Ruby runtime is tentatively hosted at remore/openwhisk-runtime-ruby, but needless to say I'd love to move/transfer this to anywhere The Apache Software Foundation manage.

Related issue and scope

#2046 is most likely related

My changes affect the following components

Types of changes

Bug fix (generally a non-breaking change which closes an issue).
Enhancement or new feature (adds new functionality).
Breaking change (a bug fix or enhancement which changes existing behavior).

Checklist:

I signed an Apache CLA.
I reviewed the style guides and followed the recommendations (Travis CI will check :).
I added tests to cover my changes.
My changes require further changes to the documentation.
I updated the documentation where necessary.

rabbah · 2018-06-06T07:27:50Z

Thanks for this contribution!

Two comments:

The container tests should be in the runtime repository and we should generally remove the duplication here; @csantanapr I think we were planning to do this already?
Please send an email to the list about the runtime (perhaps including a small example on how to try it). This pr Adjust invoker playbook to pull docker images when a prefix and tag is specified. #3680 will actually make it possible to try using your image on dockerhub. @csantanapr are you ok with merging that now?

Following the email we can propose creating a repository to accept the runtime into a new repository.

rabbah · 2018-06-06T07:29:49Z

actionRuntimes/ruby2.5Action/Dockerfile

@@ -0,0 +1 @@
+FROM openwhisk/action-ruby-v2.5


With #3680 we won’t need this (and can remove all the others like it).

cc @csantanapr

Ok. I will see for how #3680 goes then.

I haven't canceled this change yet since it looks like Dockerfile and build.gradle files in the actionRuntime/ folder still remains for other language runtimes while #3680 has been merged

rabbah · 2018-06-06T07:30:47Z

docs/parameters.md

@@ -25,7 +25,7 @@ This page outlines how to configure parameters when deploying packages and actio

 ### Passing parameters to an action at invoke time

-Parameters can be passed to the action when it is invoked. These examples use JavaScript but all the other languages work the same way (see documentation on [Swift actions](./actions.md#creating-swift-actions), [Python actions](./actions.mdcreating-python-actions), [Java actions](./actions.mdcreating-java-actions), [PHP actions](./actions.mdcreating-php-actions), [Docker actions](./actions.mdcreating-docker-actions) or [Go actions](./actions.mdcreating-go-actions) as appropriate for more detailed examples).
+Parameters can be passed to the action when it is invoked. These examples use JavaScript but all the other languages work the same way (see documentation on [Swift actions](./actions.md#creating-swift-actions), [Python actions](./actions.mdcreating-python-actions), [Java actions](./actions.mdcreating-java-actions), [PHP actions](./actions.mdcreating-php-actions), [Ruby actions](./actions.md#creating-ruby-actions), [Docker actions](./actions.mdcreating-docker-actions) or [Go actions](./actions.mdcreating-go-actions) as appropriate for more detailed examples).


This list will just keep getting longer. Perhaps we should provide just one reference to the index above.

Updated accordingly.

rabbah · 2018-06-06T07:32:19Z

docs/reference.md

@@ -434,6 +434,14 @@ The following Composer packages are also available:
 - guzzlehttp/guzzle       v6.3.0
 - ramsey/uuid             v3.6.1

+## Ruby actions
+
+Ruby actions are executed using Ruby 2.5. To use this runtime, specify the `wsk` CLI parameter `--kind ruby:2.5` when creating or updating an action. This is the default when creating an action with file that has a `.rb` extension.


You’ll have modified the cli then to recognize this extension. I have an alternate proposal here: apache/openwhisk-cli#286

Ok. I will keep my eyes open on it.

@rabbah I have pushed a PR to workaround tentatively.

rabbah · 2018-06-06T07:32:57Z

docs/reference.md

+
+A few Ruby gems such as `mechanize` and `jwt` are available in addition to the default and bundled gems. See Dockerfile of ruby runtime image for more information.
+
+Last but not least, you can use arbitrary gem so long as you use zipped actions to package all the dependencies. doc/actions.md will explain how to do this.


rabbah · 2018-06-06T07:33:24Z

settings.gradle

@@ -28,6 +28,7 @@ include 'actionRuntimes:swift3.1.1Action'
 include 'actionRuntimes:swift4.1Action'
 include 'actionRuntimes:javaAction'
 include 'actionRuntimes:php7.1Action'
+include 'actionRuntimes:ruby2.5Action'


@csantanapr we can also drop all of these I think.

remore · 2018-06-06T09:40:47Z

@rabbah Thanks for catching this up. I have just sent an email to [email protected] but correct me if the email address was wrong.

rabbah · 2018-06-06T12:00:02Z

docs/parameters.md

@@ -25,7 +25,7 @@ This page outlines how to configure parameters when deploying packages and actio

 ### Passing parameters to an action at invoke time

-Parameters can be passed to the action when it is invoked. These examples use JavaScript but all the other languages work the same way (see documentation on [Swift actions](./actions.md#creating-swift-actions), [Python actions](./actions.mdcreating-python-actions), [Java actions](./actions.mdcreating-java-actions), [PHP actions](./actions.mdcreating-php-actions), [Docker actions](./actions.mdcreating-docker-actions) or [Go actions](./actions.mdcreating-go-actions) as appropriate for more detailed examples).
+Parameters can be passed to the action when it is invoked. These examples use JavaScript but all the other languages work the same way (see documentation on [this page](./actions.md) as appropriate for more detailed examples).


for more details examples ... that are language specific.

rabbah · 2018-06-08T08:36:14Z

tests/src/test/scala/actionContainers/Ruby25ActionContainerTests.scala

@@ -0,0 +1,408 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more


This will also go with #3467.

Thanks. I will remove this once #3467 get merged.

I have removed this with 3cc287c

rabbah · 2018-06-08T08:38:05Z

actionRuntimes/ruby2.5Action/build.gradle

@@ -0,0 +1,2 @@
+ext.dockerImageName = 'action-ruby-v2.5'


And this also becomes unnecessary - same comment as dockerfile.

Got it🙋‍

Same comment as this applies here

rabbah · 2018-06-10T22:16:55Z

ansible/files/runtimes.json

+                "kind": "ruby:2.5",
+                "default": true,
+                "deprecated": false,
+                "image": {


with #3680, the image prefix and tag should be specified explicitly (to openwhisk and latest respectively).

made a change as a result of #3680

changed prefix and name temporarily to workaround the build failure. (thank you @rabbah for the quick advice to fix this)

Travis CI was kicking up the following error in apache#3725 ``` Scan detected 1 error(s) in 1 file(s): [/home/travis/build/apache/incubator-openwhisk/tools/travis/../../actionRuntimes/ruby2.5Action/build.gradle]: 1: file does not include required license header. Scan detected 1 error(s) in 1 file(s): ``` Super easy fix, thought I'd help you out. Thanks for working on Ruby runtime support!

codecov-io · 2018-06-15T01:35:59Z

Codecov Report

Merging #3725 into master will decrease coverage by 4.69%.
The diff coverage is n/a.

@@            Coverage Diff            @@
##           master    #3725     +/-   ##
=========================================
- Coverage    75.9%   71.21%   -4.7%     
=========================================
  Files         147      147             
  Lines        7048     7048             
  Branches      422      422             
=========================================
- Hits         5350     5019    -331     
- Misses       1698     2029    +331

Impacted Files	Coverage Δ
...core/database/cosmosdb/RxObservableImplicits.scala	`0% <0%> (-100%)`	⬇️
...core/database/cosmosdb/CosmosDBArtifactStore.scala	`0% <0%> (-95.1%)`	⬇️
...sk/core/database/cosmosdb/CosmosDBViewMapper.scala	`0% <0%> (-92.6%)`	⬇️
...whisk/core/database/cosmosdb/CosmosDBSupport.scala	`0% <0%> (-81.82%)`	⬇️
...abase/cosmosdb/CosmosDBArtifactStoreProvider.scala	`0% <0%> (-58.83%)`	⬇️
...la/whisk/core/database/cosmosdb/CosmosDBUtil.scala	`92% <0%> (-4%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7000687...95a4414. Read the comment docs.

rabbah

both noted PRs are now committed eschewing several files in this PR.

rabbah · 2018-06-26T03:10:51Z

@remore i squashed and rebased this to master to resolve a new conflicts with docs i updated.

@csantanapr we'll need to document the examples to be included here for system tests; should we just test a hello world here and defer the rest (including unicode) to the runtime tests?

rabbah · 2018-07-03T15:13:09Z

@remore @csantanapr I rebased this to pick up the latest refactoring.

rabbah · 2018-07-03T15:14:06Z

docs/actions.md

@@ -54,13 +54,14 @@ the [Docker](docker-actions.md) action or [native binary](docker-actions.md#crea
 paths more suitable. Multiple actions may be composed together to create a longer processing pipeline called a
 [sequence](#creating-action-sequences). A more advanced form of composition is described [here](conductors.md).

-* [JavaScript](actions-node.md)
-* [Python](actions-python.md)
+* [Go](actions-go.md)


@akrabat @csantanapr I reordered these alphabetically (but keeping docker actions last). FYI.

Alphabetical ordering makes sense to me.

rabbah

actually we will need a hello.rb files under tests/dat/actions.md for the automated system tests (that will be added).

it would be nice to automatically extract the example from the doc and turn it into a test :)... not for this pr

jthomas · 2018-07-12T14:21:11Z

Looks like this PR is almost ready to go but the doc re-org needs the Ruby action details in a separate markdown file now? @remore are you able to do this small change and we can get it merged?
thanks for all the hard work on this.

rabbah · 2018-07-12T14:50:15Z

@jthomas we need to do a couple of things apart form updating this pr:

make sure the ruby runtime repo adopts and passes the basic runtimes test suite
move the runtime remote to an apache repo (requires INFRA to create the repo)
successfully building and tagging the ruby runtime from that repo
changing the runtime manifest to use openwhisk/ruby runtime instead of @remore's personal docker prefix

remore · 2018-07-13T07:46:42Z

are you able to do this small change and we can get it merged?

Yes for sure, I have just made a few changes to get everything organized in the ruby-actions.md.
Thank you for shedding the light on this. @jthomas

make sure the ruby runtime repo adopts and passes the basic runtimes test suite

Here is the log output of test code which is executed in my laptop with the latest code today just FYI @rabbah

vagrant@ubuntu-xenial:~/openwhisk-runtime-ruby$ ./gradlew :tests:test --tests *actionContainers.Ruby25ActionContainerTests*

> Task :tests:test

runtime.actionContainers.Ruby25ActionContainerTests > action-ruby-v2.5 should run a RUBY script STANDARD_OUT
    test router? false

runtime.actionContainers.Ruby25ActionContainerTests > action-ruby-v2.5 should run a RUBY script PASSED

runtime.actionContainers.Ruby25ActionContainerTests > action-ruby-v2.5 should run and report an error for script not returning a json object PASSED

runtime.actionContainers.Ruby25ActionContainerTests > action-ruby-v2.5 should run a RUBY action and handle unicode in source, input params, logs, and result PASSED

runtime.actionContainers.Ruby25ActionContainerTests > action-ruby-v2.5 should run a RUBY script and confirm expected environment variables PASSED

runtime.actionContainers.Ruby25ActionContainerTests > action-ruby-v2.5 should fail to initialize with bad code PASSED

runtime.actionContainers.Ruby25ActionContainerTests > action-ruby-v2.5 should fail to initialize with no code PASSED

runtime.actionContainers.Ruby25ActionContainerTests > action-ruby-v2.5 should return some error on action error PASSED

runtime.actionContainers.Ruby25ActionContainerTests > action-ruby-v2.5 should support application errors PASSED

runtime.actionContainers.Ruby25ActionContainerTests > action-ruby-v2.5 should fail gracefully when an action has a TypeError exception PASSED

runtime.actionContainers.Ruby25ActionContainerTests > action-ruby-v2.5 should support the documentation examples (1) PASSED

runtime.actionContainers.Ruby25ActionContainerTests > action-ruby-v2.5 should have mechanize and activesupport gems available PASSED

runtime.actionContainers.Ruby25ActionContainerTests > action-ruby-v2.5 should support large-ish actions PASSED

runtime.actionContainers.Ruby25ActionContainerTests > action-ruby-v2.5 should support zip-encoded packages PASSED

runtime.actionContainers.Ruby25ActionContainerTests > action-ruby-v2.5 should fail gracefully on invalid zip files PASSED

runtime.actionContainers.Ruby25ActionContainerTests > action-ruby-v2.5 should fail gracefully on valid zip files that are not actions PASSED

runtime.actionContainers.Ruby25ActionContainerTests > action-ruby-v2.5 should fail gracefully on valid zip files with invalid code in main.rb PASSED

runtime.actionContainers.Ruby25ActionContainerTests > action-ruby-v2.5 should support actions using non-default entry point PASSED

runtime.actionContainers.Ruby25ActionContainerTests > action-ruby-v2.5 should support zipped actions using non-default entry point PASSED


BUILD SUCCESSFUL in 48s
3 actionable tasks: 1 executed, 2 up-to-date

move the runtime remote to an apache repo (requires INFRA to create the repo)

I'm willing to proceed with these steps only if I'm eligible. If so, please let me know.

rabbah · 2018-07-13T10:48:34Z

There some conflicts to resolve on the PR.

rabbah · 2018-07-13T10:56:04Z

@remore I opened 3 issues against the ruby repo that we’ll need to also address.

remore · 2018-07-13T11:22:44Z

@rabbah the conflict has been fixed. I will take a look at those issues.

remore · 2018-07-13T11:35:50Z

FYI: I have just squashed as well to make both git tree view and log messages cleaner. (I have just realized that my commit messages were not following comment message convention here. My apologies.)

rabbah · 2018-07-13T12:38:04Z

Repository requested: https://issues.apache.org/jira/browse/INFRA-16764

jthomas · 2018-07-17T10:36:13Z

https://github.com/apache/incubator-openwhisk-runtime-ruby repo is now available.

remore · 2018-07-17T16:01:49Z

The first PR has been sent:
apache/openwhisk-runtime-ruby#1

rabbah · 2018-07-29T13:22:42Z

@remore we (@csantanapr or i) will be fixing the travis publishing step in the ruby repo shortly.
can you add the expected sniff test https://github.com/apache/incubator-openwhisk/blob/master/docs/actions-new.md#the-test-action.

and go ahead and change the image prefix s/remore/openwhisk - travis will fail for now but i'll rebuild it when the image is published.

this gets the PR ready for merging.

rabbah · 2018-07-29T13:25:25Z

ansible/files/runtimes.json

+                "deprecated": false,
+                "image": {
+                    "prefix": "remore",
+                    "name": "openwhisk-runtime-ruby",


the image name should be action-ruby-v2.5 per the naming convention.

so it is matching https://github.com/apache/incubator-openwhisk-runtime-ruby/blob/9378cda5b09879ecce5076c5e58fdca578069593/core/ruby2.5Action/build.gradle#L1.

rabbah · 2018-07-29T13:25:57Z

ansible/files/runtimes.json

+                "default": true,
+                "deprecated": false,
+                "image": {
+                    "prefix": "remore",


go ahead and change this image prefix to openwhisk.

rabbah

@remore I went ahead and made the changes.

remore · 2018-07-30T09:40:05Z

@rabbah Thank you for going ahead about this.

this gets the PR ready for merging.

Can't wait to see that happen.

rabbah · 2018-07-30T16:55:21Z

image now published to dockerhub https://hub.docker.com/r/openwhisk/action-ruby-v2.5 (thanks @csantanapr).

jthomas · 2018-08-06T10:23:18Z

Great to see this merged. 💯
@remore Would you like to do an announcement blog post for the OpenWhisk Medium channel?

rabbah reviewed Jun 6, 2018

View reviewed changes

rabbah added runtime review Review for this PR has been requested and yet needs to be done. labels Jun 6, 2018

rabbah reviewed Jun 6, 2018

View reviewed changes

rabbah reviewed Jun 8, 2018

View reviewed changes

rabbah reviewed Jun 10, 2018

View reviewed changes

Juice10 mentioned this pull request Jun 14, 2018

Add required License header remore/incubator-openwhisk#1

Merged

20 tasks

rabbah requested changes Jun 21, 2018

View reviewed changes

rabbah force-pushed the add-ruby-as-a-kind branch 2 times, most recently from b9699cf to 9032997 Compare June 26, 2018 03:08

rabbah force-pushed the add-ruby-as-a-kind branch 2 times, most recently from d1de77f to c46c3ad Compare July 3, 2018 15:12

rabbah approved these changes Jul 3, 2018

View reviewed changes

rabbah reviewed Jul 3, 2018

View reviewed changes

rabbah force-pushed the add-ruby-as-a-kind branch from c46c3ad to 270f44f Compare July 3, 2018 15:22

rabbah requested changes Jul 3, 2018

View reviewed changes

rabbah approved these changes Jul 3, 2018

View reviewed changes

rabbah mentioned this pull request Jul 3, 2018

Document adding a new runtime kind. #3837

Merged

21 tasks

rabbah force-pushed the add-ruby-as-a-kind branch 3 times, most recently from f367e6f to 02fb9e5 Compare July 6, 2018 02:33

remore mentioned this pull request Jul 13, 2018

Add new file extension tentatively for Ruby runtime apache/openwhisk-cli#352

Merged

remore force-pushed the add-ruby-as-a-kind branch from 2ac254e to f273f0b Compare July 13, 2018 11:18

remore force-pushed the add-ruby-as-a-kind branch from f273f0b to 49154d7 Compare July 13, 2018 11:32

remore mentioned this pull request Jul 17, 2018

Add the base source code for Ruby 2.5 Runtime apache/openwhisk-runtime-ruby#1

Merged

rabbah reviewed Jul 29, 2018

View reviewed changes

rabbah force-pushed the add-ruby-as-a-kind branch from 49154d7 to 0889a48 Compare July 29, 2018 14:12

rabbah approved these changes Jul 29, 2018

View reviewed changes

Add Ruby2.5 runtime to runtimes manifest

0e28e7c

rabbah force-pushed the add-ruby-as-a-kind branch from 0889a48 to b6b3176 Compare July 29, 2018 14:40

Add system test and update image name.

95a4414

rabbah force-pushed the add-ruby-as-a-kind branch from b6b3176 to 95a4414 Compare July 30, 2018 18:36

rabbah self-assigned this Jul 30, 2018

rabbah merged commit 35cf728 into apache:master Jul 30, 2018

csantanapr mentioned this pull request Sep 15, 2018

Feature request: Ruby runtime #2046

Closed

csantanapr mentioned this pull request Oct 26, 2018

Add golang runtime support to default deployments #4085

Closed

TPei mentioned this pull request Nov 22, 2018

add ruby to specifications file apache/openwhisk-wskdeploy#1012

Merged

BillZong pushed a commit to BillZong/openwhisk that referenced this pull request Nov 18, 2019

Add Ruby 2.5 actions (apache#3725)

7f64c32


		A few Ruby gems such as `mechanize` and `jwt` are available in addition to the default and bundled gems. See Dockerfile of ruby runtime image for more information.

		Last but not least, you can use arbitrary gem so long as you use zipped actions to package all the dependencies. doc/actions.md will explain how to do this.

		@@ -0,0 +1,408 @@
		/*
		* Licensed to the Apache Software Foundation (ASF) under one or more

Add Ruby2.5 runtime support #3725

Add Ruby2.5 runtime support #3725

Conversation

remore commented Jun 6, 2018

Description

Related issue and scope

My changes affect the following components

Types of changes

Checklist:

rabbah commented Jun 6, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

remore commented Jun 6, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

remore Jun 11, 2018 • edited Loading

Choose a reason for hiding this comment

rabbah Jun 8, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-io commented Jun 15, 2018 • edited Loading

Codecov Report

rabbah left a comment

Choose a reason for hiding this comment

rabbah commented Jun 26, 2018

rabbah commented Jul 3, 2018

rabbah Jul 3, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rabbah left a comment

Choose a reason for hiding this comment

jthomas commented Jul 12, 2018

rabbah commented Jul 12, 2018

remore commented Jul 13, 2018

rabbah commented Jul 13, 2018

rabbah commented Jul 13, 2018

remore commented Jul 13, 2018

remore commented Jul 13, 2018

rabbah commented Jul 13, 2018

jthomas commented Jul 17, 2018

remore commented Jul 17, 2018

rabbah commented Jul 29, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rabbah left a comment

Choose a reason for hiding this comment

remore commented Jul 30, 2018 • edited Loading

rabbah commented Jul 30, 2018

jthomas commented Aug 6, 2018

remore Jun 11, 2018 •

edited

Loading

rabbah Jun 8, 2018 •

edited

Loading

codecov-io commented Jun 15, 2018 •

edited

Loading

rabbah Jul 3, 2018 •

edited

Loading

rabbah commented Jul 29, 2018 •

edited

Loading

remore commented Jul 30, 2018 •

edited

Loading