initial commit
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..454255b
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+openwhisk
\ No newline at end of file
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..2689029
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,27 @@
+# A Travis CI configuration file.
+
+sudo: required
+
+language: scala
+scala:
+ - 2.11.6
+
+services:
+ - docker
+
+env:
+ global:
+ - TERM=dumb
+
+notifications:
+ email: false
+
+install: true
+
+before_install:
+ - git clone https://github.com/openwhisk/openwhisk.git
+ - cd openwhisk
+ - ./tools/travis/setup.sh
+
+script:
+- ../tools/travis/build.sh
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..1881a61
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,38 @@
+# Contributing to OpenWhisk
+
+We welcome contributions, but request you follow these guidelines.
+
+ - [Raising issues](#raising-issues)
+ - [Contributor License Agreement](#contributor-license-agreement)
+ - [Coding Standards](#coding-standards)
+
+## Raising issues
+
+Please raise any bug reports on the issue tracker. Be sure to
+search the list to see if your issue has already been raised.
+
+A good bug report is one that make it easy for us to understand what you were
+trying to do and what went wrong. Provide as much context as possible so we can try to recreate the issue.
+
+
+### Contributor License Agreement
+
+In order for us to accept pull-requests, the contributor must first complete
+a Contributor License Agreement (CLA). This clarifies the intellectual
+property license granted with any contribution. It is for your protection as a
+Contributor as well as the protection of IBM and its customers; it does not
+change your rights to use your own Contributions for any other purpose.
+
+You can download the CLAs here:
+
+- [individual](https://github.com/openwhisk/openwhisk/blob/master/CLA-INDIVIDUAL.md)
+- [corporate](https://github.com/openwhisk/openwhisk/blob/master/CLA-CORPORATE.md)
+
+
+### Coding standards
+
+Please ensure you follow the coding standards used throughout the existing
+code base. Some basic rules include:
+
+ - all files must have the Apache license in the header.
+ - all PRs must have passing builds for all operating systems.
diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 0000000..a2fe52f
--- /dev/null
+++ b/LICENSE.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright 2015-2016 IBM Corporation
+
+ Licensed 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.
diff --git a/README.md b/README.md
index fe3a49e..c671676 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,84 @@
-# openwhisk-package-template
+#Openwhisk Package Template
+==========================
+This package is a template for Openwhisk Packages, it can be used to build, test and integrate new packages.
+
+```
+openwhisk-package-template/
+├── actions
+│ └── hello_world.js
+├── CONTRIBUTING.md
+├── feeds
+│ └── ...
+├── install.sh
+├── LICENSE.txt
+├── README.md
+├── tests
+│ ├── credentials.json
+│ ├── credentials.json.enc
+│ └── src
+│ └── TemplateTests.scala
+├── tools
+│ └── travis
+│ └── build.sh
+├── TriggerProvider
+│ └── ...
+└── uninstall.sh
+```
+
+##How to install and uninstall this package ?
+Install the package using `./install.sh $EDGE_HOST $AUTH_KEY $WSK_CLI`
+where :
+- **$EDGE_HOST** is where openwhisk is deployed
+- **$AUTH_KEY** is the authentication key
+- **$WSK_CLI** is the path of Openwhisk command interface binary
+
+This will create a new package called **packageTemplate** as well as a hello world action.
+
+To uninstall the package, please use `./uninstall.sh $EDGE_HOST $AUTH_KEY $WSK_CLI`
+
+##Testing
+You can test your package using the test cases you provided within tests/src, it is highly recommended to use Scala in writing test cases. To execute the test cases locally ( local deployment of Openwhisk), please copy your test files into `openwhisk/tests/src/packages` and then by using gradle within Openwhisk `gradle :tests:test` this will execute all test files of openwhisk, to execute a specific test class you can use `gradle :tests:test --tests "packages.CLASS_NAME`
+
+**credentials**: You may need credentials during testing, you can put whatever credentials you need in `tests/credentials.json` (use `tests/template_ceredentials.json` as an example). In case of travis deployment for continuous integration, you can encrypt credentials.json file by using [travis CLI](https://docs.travis-ci.com/user/encrypting-files/).
+
+**Caution:** Do not forget to include tests/credentials.json in .gitignore.
+
+##Package contents
+| Entity | Type | Parameters | Description |
+| --- | --- | --- | --- |
+| `/namespace/packageTemplate` | package | - | Openwhisk Package Template |
+| `/namespace/packageTemplate/helloWorld` | action | [details](#hello-world) | A simple hello world action |
+
+###Feeds
+List here Feed actions ...
+
+###Actions
+####Hello World
+This action is a simple hello world,
+######Parameters
+| **Parameter** | **Type** | **Required** | **Description**| **Options** | **Default** | **Example** |
+| ------------- | ---- | -------- | ------------ | ------- | ------- |------- |
+| name | *string* | no | A name to greet | - | - | "Openwhisk" |
+
+######Usage
+To use this action, you need to pass the required parameters (refer to the table above)
+```bash
+wsk action invoke /namespace/packageTemplate/helloWorld -p name 'Openwhisk' --blocking
+```
+
+Output:
+```javascript
+{
+ "message": "Hello, Openwhisk!"
+}
+```
+
+## Contributing
+Please refer to [CONTRIBUTING.md](CONTRIBUTING.md)
+
+## License
+Copyright 2015-2016 IBM Corporation
+
+Licensed under the [Apache License, Version 2.0 (the "License")](http://www.apache.org/licenses/LICENSE-2.0.html).
+
+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.
diff --git a/actions/hello_world.js b/actions/hello_world.js
new file mode 100644
index 0000000..636b33f
--- /dev/null
+++ b/actions/hello_world.js
@@ -0,0 +1,6 @@
+function main(params){
+ if(params === undefined)
+ return whisk.done({"message":"Hello, World!"});
+ else
+ return whisk.done({"message":"Hello, "+params.name+"!"});
+}
\ No newline at end of file
diff --git a/install.sh b/install.sh
new file mode 100755
index 0000000..f01be43
--- /dev/null
+++ b/install.sh
@@ -0,0 +1,22 @@
+#!/bin/bash
+
+set -e
+set -x
+
+if [ $# -eq 0 ]
+then
+ echo "Usage: ./install.sh $APIHOST $AUTH $WSK_CLI"
+fi
+
+APIHOST="$1"
+AUTH="$2"
+WSK_CLI="$3"
+
+PACKAGE_HOME="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+echo Installing an Openwhisk Package Template \
+
+$WSK_CLI --apihost $APIHOST package update --auth $AUTH --shared yes packageTemplate \
+ -a description "Openwhisk Package Template" \
+ -a parameters '[{"name":"apiKey","required":true,"bindTime":true,"description":"Watson IoT platform apiKey"},{"name":"apiToken","required":true,"bindTime":true,"type":"password","description":"Watson IoT platform authentication token"},{"name":"orgId","required":false,"bindTime":false,"description":"Watson IoT platform organization ID"}]'
+
+$WSK_CLI --apihost $APIHOST action update --auth $AUTH --shared yes packageTemplate/helloWorld $PACKAGE_HOME/actions/hello_world.js \
\ No newline at end of file
diff --git a/tests/credentials.json b/tests/credentials.json
new file mode 100644
index 0000000..1222949
--- /dev/null
+++ b/tests/credentials.json
@@ -0,0 +1,20 @@
+{
+ "template_service": [{
+ "name": "Service x",
+ "label": "service-x",
+ "credentials": {
+ "apiKey": "XXXXXXXX",
+ "apiToken": "YYYYYYY",
+ "base_uri": "https://openwhisk.ng.bluemix.net/api/v1",
+ }
+ }],
+ "another_service": [{
+ "name": "Service y",
+ "label": "service-y",
+ "credentials": {
+ "apiKey": "ZZZZZZZZZZ",
+ "apiToken": "MMMMMMMMMM",
+ "base_uri": "https://openwhisk.ng.bluemix.net/api/v1",
+ }
+ }]
+}
\ No newline at end of file
diff --git a/tests/credentials.json.enc b/tests/credentials.json.enc
new file mode 100644
index 0000000..aef8732
--- /dev/null
+++ b/tests/credentials.json.enc
Binary files differ
diff --git a/tests/src/TemplateTests.scala b/tests/src/TemplateTests.scala
new file mode 100644
index 0000000..dcdd473
--- /dev/null
+++ b/tests/src/TemplateTests.scala
@@ -0,0 +1,47 @@
+/*
+ * Copyright 2015-2016 IBM Corporation
+ *
+ * Licensed 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 packages
+
+import common._
+import org.junit.runner.RunWith
+import org.scalatest.Matchers
+import org.scalatest.junit.JUnitRunner
+import spray.json._
+import spray.json.DefaultJsonProtocol.StringJsonFormat
+import scala.collection.immutable.HashMap
+import org.scalatest.FlatSpecLike
+
+@RunWith(classOf[JUnitRunner])
+class TemplateTests extends TestHelpers with WskTestHelpers with Matchers {
+
+ implicit val wskprops = WskProps()
+ val wsk = new Wsk()
+
+ val credentials = TestUtils.getVCAPcredentials("template")
+ val apiKey = credentials.get("apiKey");
+
+ behavior of "Template Package"
+
+ "helloworld action" should "return Hello, World!" in {
+ val actionName = "/whisk.system/packageTemplate/helloworld"
+ val params = HashMap("name" -> "Tareq".toJson);
+
+ withActivation(wsk.activation, wsk.action.invoke(actionName, params)) {
+ _.fields("response").toString should include(s""""message": "Hello, Tareq!"""")
+ }
+ }
+}
diff --git a/tests/template_credentials.json b/tests/template_credentials.json
new file mode 100644
index 0000000..1222949
--- /dev/null
+++ b/tests/template_credentials.json
@@ -0,0 +1,20 @@
+{
+ "template_service": [{
+ "name": "Service x",
+ "label": "service-x",
+ "credentials": {
+ "apiKey": "XXXXXXXX",
+ "apiToken": "YYYYYYY",
+ "base_uri": "https://openwhisk.ng.bluemix.net/api/v1",
+ }
+ }],
+ "another_service": [{
+ "name": "Service y",
+ "label": "service-y",
+ "credentials": {
+ "apiKey": "ZZZZZZZZZZ",
+ "apiToken": "MMMMMMMMMM",
+ "base_uri": "https://openwhisk.ng.bluemix.net/api/v1",
+ }
+ }]
+}
\ No newline at end of file
diff --git a/tools/travis/build.sh b/tools/travis/build.sh
new file mode 100755
index 0000000..916cf17
--- /dev/null
+++ b/tools/travis/build.sh
@@ -0,0 +1,49 @@
+# Build script for Travis-CI.
+
+SCRIPTDIR=$(cd $(dirname "$0") && pwd)
+ROOTDIR="$SCRIPTDIR/../../openwhisk"
+
+cd $ROOTDIR
+
+cp $ROOTDIR/../tests/src/* $ROOTDIR/tests/src/packages/
+
+tools/build/scanCode.py .
+
+cd $ROOTDIR/ansible
+
+ANSIBLE_CMD="ansible-playbook -i environments/travis"
+
+$ANSIBLE_CMD setup.yml
+$ANSIBLE_CMD prereq.yml
+$ANSIBLE_CMD couchdb.yml
+$ANSIBLE_CMD initdb.yml
+
+cd $ROOTDIR
+
+./gradlew distDocker
+
+cd $ROOTDIR/ansible
+
+$ANSIBLE_CMD openwhisk.yml
+
+cd $ROOTDIR
+
+VCAP_SERVICES_FILE="$(readlink -f $ROOTDIR/../tests/credentials.json)"
+
+#update whisk.properties to add tests/credentials.json file to vcap.services.file, which is needed in tests
+WHISKPROPS_FILE="$ROOTDIR/whisk.properties"
+sed -i 's:^[ \t]*vcap.services.file[ \t]*=\([ \t]*.*\)$:vcap.services.file='$VCAP_SERVICES_FILE':' $WHISKPROPS_FILE
+cat whisk.properties
+
+WSK_CLI=$ROOTDIR/bin/wsk
+AUTH_KEY=$(cat $ROOTDIR/ansible/files/auth.whisk.system)
+EDGE_HOST=$(grep '^edge.host=' $WHISKPROPS_FILE | cut -d'=' -f2)
+
+# Install the package
+source $ROOTDIR/../install.sh $EDGE_HOST $AUTH_KEY $WSK_CLI
+
+#Test only the test cases classes in tests/src (Openwhisk dependencies are needed)
+X="./gradlew :tests:test "
+for f in $(ls $ROOTDIR/../tests/src | sed -e 's/\..*$//'); do X="$X --tests \"packages.$f\""; done
+eval $X
+
diff --git a/uninstall.sh b/uninstall.sh
new file mode 100755
index 0000000..82ee2cc
--- /dev/null
+++ b/uninstall.sh
@@ -0,0 +1,19 @@
+#!/bin/bash
+
+set -e
+set -x
+
+if [ $# -eq 0 ]
+then
+ echo "Usage: ./uninstall.sh $APIHOST $AUTH $WSK_CLI"
+fi
+
+APIHOST="$1"
+AUTH="$2"
+WSK_CLI="$3"
+
+echo Uninstalling Template Package \
+
+$WSK_CLI --apihost $APIHOST action delete --auth $AUTH packageTemplate/helloworld
+
+$WSK_CLI --apihost $APIHOST package delete --auth $AUTH packageTemplate