RPJ Workflow

.github/workflows/rpj.yml

@@ -0,0 +1,18 @@
+name: Report Portal to Jira workflow container image and manifest push
+
+on:
+  workflow_dispatch:
+  push:
+    branches: ["main"]
+    paths:
+      - "rpj/**"
+      - "pipeline/**"
+      - .github/workflows/rpj.yml
+      - .github/workflows/main.yml
+
+jobs:
+  call-main-workflow:
+    uses: ./.github/workflows/main.yml
+    with:
+      workflow_id: rpj
+    secrets: inherit

.gitignore

@@ -48,4 +48,6 @@ nb-configuration.xml
 kn
 
 temp
-*.tar
+*.tar
+
+__pycache__

Makefile

@@ -12,6 +12,7 @@ WORKFLOWS = \
 	mta \
 	mta-v7.x \
 	create-ocp-project \
+	rpj \
 	$(NULL)
 
 # Dynamic rule patten that uses one of the workflows and sets the workflow id

rpj/.dockerignore

@@ -0,0 +1 @@
+proxy

rpj/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2024 [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.

rpj/README.md

@@ -0,0 +1,33 @@
+# RPJ - Report portal to Jira
+# Synopsis
+This workflow is an infrastructure workflow type, that invokes a [RPJ][1] run for a specific launch.
+
+
+# Inputs
+- `launchID` [mandatory] - The report portal launch ID to use to generate the Jira task
+- `epicCode` - The epic under which the task shall be created
+- `recipients` [mandatory] - A list of recipients for the notification in the format of `user:<namespace>/<username>` or `group:<namespace>/<groupname>`, i.e. `user:default/jsmith`.
+
+# Output
+1. On completion the workflow returns the run response in a notification.
+
+# Pre-requisites
+Access to the RPJ tool directly or via a proxy.
+
+In this project, a side proxy application was created in order to avoid self-signed certificates error when sending REST requests.
+If you RPJ is configured properly (i.e: without self-signed certificates), you can remove the proxy application.
+
+# Workflow Diagram
+![rpj workflow diagram](https://github.com/parodos-dev/serverless-workflows/blob/main/rpj/rpj.svg?raw=true)
+
+# Workflow application configuration
+Application properties can be initialized from environment variables before running the application:
+
+| Environment variable  | Description | Mandatory | Default value |
+|-----------------------|-------------|-----------|---------------|
+| `BACKSTAGE_NOTIFICATIONS_URL`      | The backstage server URL for notifications | ✅ | |
+| `NOTIFICATIONS_BEARER_TOKEN`      | The authorization bearer token to use to send notifications | ✅ | |
+| `RPJ_URL`  | The URL of the Report Portal to Jira tool, or to the proxy giving access to it | ✅ | |
+
+[1]: https://github.com/abrugaro/rp-jira-sync
+

rpj/application.properties

@@ -0,0 +1,14 @@
+# RPJ
+rpj.url = ${RPJ_URL}
+quarkus.rest-client.rpj_json.url = ${rpj.url}
+
+# Backstage Notifications service
+quarkus.rest-client.notifications.url=${BACKSTAGE_NOTIFICATIONS_URL}
+quarkus.openapi-generator.notifications.auth.BearerToken.bearer-token=${NOTIFICATIONS_BEARER_TOKEN}
+
+# This property is used to select the log level, which controls the amount
+# of information logged on HTTP requests based on the severity of the events.
+# Possible values: OFF, FATAL, ERROR, WARN, INFO, DEBUG, ALL.
+# and see https://quarkus.io/guides/logging for documentation
+quarkus.log.category."org.apache.http".level=INFO
+quarkus.log.level=INFO

rpj/argfile.conf

@@ -0,0 +1,4 @@
+BUILDER_IMAGE=brew.registry.redhat.io/rh-osbs/openshift-serverless-1-logic-swf-builder-rhel8@sha256:012439f21f964478225a459042f6e1dc14f63fdf4ae089c4ee5e613814682a27
+FLOW_NAME=RPJ
+FLOW_SUMMARY=RPJ serverless workflow consumes a launch ID from the Report Portal and creates a Jira task
+FLOW_DESCRIPTION=RPJ serverless workflow consumes a launch ID from the Report Portal and creates a Jira task

rpj/proxy/Dockerfile

@@ -0,0 +1,20 @@
+# Start with a minimal Red Hat Universal Base Image (UBI)
+FROM registry.access.redhat.com/ubi8/python-39
+
+# Set the working directory
+WORKDIR /app
+
+# Copy the requirements file first
+COPY requirements.txt .
+
+# Install required packages
+RUN pip install --no-cache-dir -r requirements.txt
+
+# Copy the application code into the container
+COPY . .
+
+# Expose the port for the Gunicorn server
+EXPOSE 8080
+
+# Command to run the application using Gunicorn
+CMD ["gunicorn", "-b", "0.0.0.0:8080", "app:app", "--workers", "4"]

rpj/proxy/app.py

@@ -0,0 +1,51 @@
+import os
+import logging
+from flask import Flask, request, Response
+import requests
+
+app = Flask(__name__)
+
+# Configure logging
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+
+# Get the target URL from environment variables
+TARGET_URL = os.getenv('TARGET_URL')
+
+@app.route('/health', methods=['GET'])
+def health_check():
+    return Response("Healthy", status=200)
+
+@app.route('/<path:url>', methods=['GET', 'POST', 'PUT', 'DELETE'])
+def proxy(url):
+    # Construct the full target URL
+    target = f"{TARGET_URL}/{url}"
+
+    # Log the request
+    logger.info(f"Proxying request to: {target}")
+
+    # Forward the request
+    try:
+        # Forward the request based on the HTTP method
+        if request.method == 'GET':
+            resp = requests.get(target, params=request.args, verify=False)
+        elif request.method == 'POST':
+            resp = requests.post(target, json=request.get_json(), verify=False)
+        elif request.method == 'PUT':
+            resp = requests.put(target, json=request.get_json(), verify=False)
+        elif request.method == 'DELETE':
+            resp = requests.delete(target, verify=False)
+        else:
+            return Response("Method Not Allowed", status=405)
+
+        content = resp.content
+        logger.debug(f"Content:\n{content}")
+        # Return the response from the target server
+        return Response(content, status=resp.status_code, content_type=resp.headers['Content-Type'])
+
+    except requests.exceptions.RequestException as e:
+        logger.error(f"Error while forwarding request: {e}")
+        return Response("Service Unavailable", status=503)
+
+if __name__ == "__main__":
+    app.run(host='0.0.0.0', port=8080)

rpj/proxy/requirements.txt

@@ -0,0 +1,3 @@
+Flask>=2.3.2
+requests>=2.26.0       
+gunicorn>=23.0.0