feat: Add fallback option when Jira exporter can not determine application (#998)

Signed-off-by: Mateus Oliveira <msouzaol@redhat.com>

Author: mateusoliveira43

charts/operators/Chart.yaml

@@ -14,4 +14,4 @@ type: application
 
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
-version: 2.0.10-rc.5
+version: 2.0.10-rc.6

charts/pelorus/Chart.lock

@@ -1,6 +1,6 @@
 dependencies:
 - name: exporters
   repository: file://./charts/exporters
-  version: 2.0.10-rc.5
-digest: sha256:81bd39a2f18c82e32cf006453b20b0e7bb16b343b10e48a196d480463973ef68
-generated: "2023-05-15T16:12:35.760966639+02:00"
+  version: 2.0.10-rc.6
+digest: sha256:cb161faa5586bbb5112e63c731f0178f1d611529687225eb570ae1a49c1e6bd6
+generated: "2023-05-31T09:55:35.954667465-03:00"

charts/pelorus/Chart.yaml

@@ -14,9 +14,9 @@ type: application
 
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
-version: 2.0.10-rc.5
+version: 2.0.10-rc.6
 
 dependencies:
   - name: exporters
-    version: 2.0.10-rc.5
+    version: 2.0.10-rc.6
     repository: file://./charts/exporters

charts/pelorus/charts/exporters/Chart.yaml

@@ -14,4 +14,4 @@ type: application
 
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
-version: 2.0.10-rc.5
+version: 2.0.10-rc.6

charts/pelorus/charts/exporters/templates/_deploymentconfig.yaml

@@ -60,7 +60,7 @@ spec:
 
             {{- if and (not .source_ref) (not .source_url) }}
             - name: PELORUS_IMAGE_TAG
-              value: {{ .app_name }}:{{ .image_tag | default "v2.0.10-rc.5" }}
+              value: {{ .app_name }}:{{ .image_tag | default "v2.0.10-rc.6" }}
             {{- end }}
 
             {{- if .extraEnv }}

charts/pelorus/charts/exporters/templates/_imagestream_from_image.yaml

@@ -23,7 +23,7 @@ spec:
       name: {{ .image_name }}:{{ .image_tag | default "latest" }}
     {{- end }}
 {{- else }}
-      name: quay.io/pelorus/pelorus-{{ .exporter_type }}-exporter:{{ .image_tag | default "v2.0.10-rc.5" }}
+      name: quay.io/pelorus/pelorus-{{ .exporter_type }}-exporter:{{ .image_tag | default "v2.0.10-rc.6" }}
 # .image_name
 {{- end }}
     name: {{ .image_tag | default "stable" }}

docs/GettingStarted/configuration/ExporterFailure.md

@@ -56,6 +56,7 @@ This is the list of options that can be applied to `env_from_secrets`, `env_from
 | [API_USER](#api_user) | no | - |
 | [TOKEN](#token) | yes | - |
 | [APP_LABEL](#app_label) | no | `app.kubernetes.io/name` |
+| [APP_NAME](#app_name) | no | - |
 | [APP_FIELD](#app_field) | no | `u_application` |
 | [PROJECTS](#projects) | no | - |
 | [PELORUS_DEFAULT_KEYWORD](#pelorus_default_keyword) | no | `default` |
@@ -117,6 +118,14 @@ This is the list of options that can be applied to `env_from_secrets`, `env_from
 
 : Changes the label used to identify applications.
 
+###### APP_NAME
+
+- **Required:** no
+    - Only applicable for [PROVIDER](#provider) set to `jira`
+- **Type:** string
+
+: Set fallback option when Jira exporter can not determine application related to collected issues. Otherwise, applications that can not be determined from issues are stored as `unknown` and do not appear in Grafana dashboards.
+
 ###### APP_FIELD
 
 - **Required:** no

exporters/failure/collector_jira.py

@@ -88,6 +88,8 @@ class JiraFailureCollector(AbstractFailureCollector):
 
     query_result_fields_string: str = field(default=QUERY_RESULT_FIELDS, init=False)
 
+    app_name: Optional[str] = field(default=None, metadata=env_vars("APP_NAME"))
+
     def __attrs_post_init__(self):
         # Do not mix projects with custom JQL query
         # Gather all fields and projects
@@ -279,4 +281,6 @@ def get_app_name(self, issue: Issue) -> str:
             matcher = f"{self.app_label}="
             if label.startswith(matcher):
                 return label.replace(matcher, "")
-        return "unknown"
+        if self.app_name is None:
+            return "unknown"
+        return self.app_name

exporters/tests/test_failure_exporter.py

@@ -43,13 +43,15 @@ def setup_jira_collector(
     token: str = "WIEds4uZHiCGnrtmgQPn9E7D",
     projects: Optional[str] = None,
     jql_query_string: str = DEFAULT_JQL_SEARCH_QUERY,
+    app_name: Optional[str] = None,
 ) -> JiraFailureCollector:
     return JiraFailureCollector(
         tracker_api=JIRA_SERVER,
         username=username,
         token=token,
         projects=projects,
         jql_query_string=jql_query_string,
+        app_name=app_name,
     )
 
 
@@ -77,6 +79,28 @@ def test_jira_search_with_projects(projects):
 
     assert context is None
     assert len(issues) == 103
+    assert len([issue for issue in issues if issue.app == "unknown"]) == 4
+
+
+@pytest.mark.integration
+@pytest.mark.skipif(
+    not JIRA_USERNAME, reason="No Jira username set, run export JIRA_USERNAME=username"
+)
+@pytest.mark.skipif(
+    not JIRA_TOKEN, reason="No Jira token set, run export JIRA_TOKEN=token"
+)
+def test_jira_search_with_app_name():
+    collector = setup_jira_collector(
+        JIRA_USERNAME, JIRA_TOKEN, projects="Test", app_name="robotron"
+    )
+
+    with nullcontext() as context:
+        issues = collector.search_issues()
+
+    assert context is None
+    assert len(issues) == 103
+    assert len([issue for issue in issues if issue.app == "unknown"]) == 0
+    assert len([issue for issue in issues if issue.app == "robotron"]) == 4
 
 
 @pytest.mark.parametrize(
@@ -126,6 +150,7 @@ def test_jira_search_with_jql(jql):
 
     assert context is None
     assert len(issues) == 103
+    assert len([issue for issue in issues if issue.app == "unknown"]) == 4
 
 
 @pytest.mark.parametrize(

pelorus-operator/Makefile

@@ -3,7 +3,7 @@
 # To re-generate a bundle for another specific version without changing the standard setup, you can:
 # - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
 # - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
-VERSION ?= 0.0.7-rc.5
+VERSION ?= 0.0.7-rc.6
 
 # CHANNELS define the bundle channels used in the bundle.
 # Add a new line here if you would like to change its default config. (E.g CHANNELS = "candidate,fast,stable")