Publish CWS open source codebase to public GitHub

.gitignore

@@ -0,0 +1,23 @@
+.idea/
+
+cws-*-libs/
+
+dist/
+
+auto_conf*.dat
+
+cws-service/src/main/resources/bpmn/*.bpmn
+
+cws-service/src/main/resources/camunda/bpmn/*.bpmn
+
+*.iml
+
+.keystore
+cws_truststore.jks
+
+cookies.txt
+creds.txt
+
+cws-test/newCWSDir
+
+.DS_Store

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# How to Contribute
+
+TODO

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 [yyyy] [name of copyright owner]
+
+   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.

NOTICE.txt

@@ -0,0 +1,42 @@
+Common Workflow Service
+
+Copyright 2020, California Institute of Technology ("Caltech").
+U.S. Government sponsorship acknowledged. All Rights Reserved.
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+
+This product includes software developed at
+Spring (https://spring.io/).
+
+**********************
+THIRD PARTY COMPONENTS
+**********************
+This software includes third party software subject to the following copyrights:
+
+ - The AWS SDK for Java is Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ - The Camunda BPMN Platform is Copyright 2013-2020 Camunda Services GmbH.
+ - The Camunda Modeler is Copyright (c) Camunda Services GmbH.
+ - The Elasticsearch software is Copyright 2009-2018 Elasticsearch.
+ - The Logstash software is Copyright 2009-2018 Elasticsearch.
+ - The Bootstrap software has the following copyright holders:
+   - Copyright (c) 2011-2020 Twitter, Inc.
+   - Copyright (c) 2011-2020 The Bootstrap Authors.
+ - The fst (fast-serialization) library is Copyright 2012-2014 Ruediger Moeller.
+ - The gson library is Copyright 2008 Google Inc.
+ - The JMS library is Copyright (c) 1993, 2020, Oracle and/or its affiliates.
+ - The Javax Mail library is Copyright (c) 1993, 2020, Oracle and/or its affiliates.
+ - The Javax Servlet API is Copyright (c) 1993, 2020, Oracle and/or its affiliates.
+ - The Joda-Time library is Copyright (c) 2002-2020 Joda.org. All Rights Reserved.
+ - The Jython library has the following copyright holders:
+   - Copyright (c) 2000-2018 Jython Developers. All rights reserved.
+   - Copyright (c) 2000 BeOpen.com. All Rights Reserved.
+   - Copyright (c) 2000 The Apache Software Foundation. All rights reserved.
+   - Copyright (c) 1995-2000 Corporation for National Research Initiatives. All Rights Reserved.
+   - Copyright (c) 1991-1995 Stichting Mathematisch Centrum, Amsterdam. All Rights Reserved.
+ - The MariaDB Connector/J library is Copyright (c) 2020 MariaDB. All rights reserved.
+ - The mybatis library is Copyright (c) 2009–2020 MyBatis.org.
+ - The Quartz library is Copyright (c) Terracotta, Inc., a wholly-owned subsidiary of Software AG USA, Inc. All rights reserved.
+ - The slf4j-log4j12 library is Copyright (c) 2004-2007 QOS.ch. All rights reserved.
+ - The urlrewritefilter library is Copyright 1995-2012 Paul Tuckey.
+ - The respond.js library is Copyright 2011: Scott Jehl, scottjehl.com.

README.md

@@ -1 +1,83 @@
-# common-workflow-service
+# NASA-AMMOS Common Workflow Service (CWS)
+
+This repository is the open-source release of the [NASA-AMMOS](https://ammos.nasa.gov/) Common Workflow Service (CWS). It is the culmination of many years of development internally at JPL, and we are now bringing it to the public in hopes that the open-source community might benefit from its release.
+
+CWS is built on top of the [BPMN Workflow Engine](https://camunda.com/products/camunda-bpm/bpmn-engine/). CWS extends Camunda's functionality by layering an intuitive user interface, auditable logging, extensibility with code snippits and adaptation layers, and plenty of other useful tools such a powerful external task engine, custom process initiators, and much more.
+
+While this repository is mostly complete, the documentation will be a work-in-progress for some time as we parse through our internal docs and add them here. The `cws-test` package is also in need of an update, but we've included it here as it contains useful examples of integration testing for CWS.
+
+While documentation is still in the works, please feel free to [open an issue](https://github.com/NASA-AMMOS/commoan-workflow-service/issues/new/choose) with your inquiry.
+
+See the [wiki](https://github.com/NASA-AMMOS/common-workflow-service/wiki) for more information. 
+
+# Installation
+
+## Prerequisites
+
+  - Mariadb or mysql database set up on either your local machine or a remote host. You will also need to create the following:
+    - A database for CWS to use. `cws` is a good default.
+    - A database user with full access to the above database.
+  - ITerm2: Currently these build scripts include commands to open new terminal windows using ITerm2, so they are best run from that terminal.
+  - Logstash: You will need to place the logstash 6.4.2 zip in `install/logging/`. This is a temporary workaround while we clean up our installation process. You can find the zip download [here](https://www.elastic.co/downloads/past-releases/logstash-6-4-2).
+
+> **Note:** You will need to add your own Tomcat keystore and truststore to the `install/` directory for the CWS web console to work properly. See https://tomcat.apache.org/tomcat-9.0-doc/ssl-howto.html.
+
+## Building CWS
+
+To build and run CWS, use the `dev.sh` script - its usage is as follows:
+```
+./dev.sh <Install directory> <ldap_username> <DB type - mariadb|mysql> <DB host> <DB port> <DB name> <DB user> <DB password> <Enable cloud? y|n> <Security scheme - CAMUNDA|LDAP> <hostname> <Emails list for alerts> <Admin first name> <Admin last name> <Admin email> <Number of workers>
+```
+
+For development we tend to create our own build scripts that call `dev.sh`. Here's an example that will work for development on a local machine:
+
+```
+#!/bin/bash
+
+HOSTNAME=localhost
+
+# Used in cws-test
+echo "$HOSTNAME" > cws-test/src/test/resources/hostname.txt
+
+SECURITY="camunda"
+
+# Stop CWS is it is currently running
+./stop_dev.sh
+
+# DB config
+DB_TYPE=mariadb
+DB_HOST=localhost
+DB_NAME=<your database name> # needs to match the db you set up beforehand
+DB_USER=<your database user> # needs to match the user you set up beforehand
+DB_PASS=<your database pass> # could also be specified with environment vars
+DB_PORT=3306 # mariadb default
+
+USER=<your username for cws login>
+CLOUD=<y|n> # Enable cloudwatch monitoring
+
+EMAIL_LIST="<comma separated list of admin emails>"
+
+ADMIN_FIRST="<admin first name>"
+ADMIN_LAST="<admin last name>"
+ADMIN_EMAIL="<admin email>"
+
+# Num of workers to start. 1 is the minimum.
+NUM_WORKERS=1
+
+# Run the dev script
+./dev.sh `pwd` ${USER} ${DB_TYPE} ${DB_HOST} ${DB_PORT} ${DB_NAME} ${DB_USER} ${DB_PASS} ${CLOUD} ${SECURITY} ${HOSTNAME} ${EMAIL_LIST} ${ADMIN_FIRST} ${ADMIN_LAST} ${ADMIN_EMAIL} ${NUM_WORKERS}
+```
+
+The above script will build CWS, verify your configuration, then will start the CWS console and workers. The script will provide a link to access the console dashboard once everything has started up!
+
+## Stopping CWS
+
+You can stop CWS by running `./stop_dev.sh`. The script will bring down the console and all local workers.
+
+# Contributing
+
+Please see our [contribution guidelines](https://github.com/NASA-AMMOS/common-workflow-service/blob/main/CONTRIBUTING.md).
+
+# License
+
+The source files in this repository are made available under the [Apache License Version 2.0](https://github.com/NASA-AMMOS/common-workflow-service/blob/main/LICENSE).