fix(scorecard): add external plugins to test integration with other plugins and fix jira apiVersion type (#1543)

Author: christoph-jerolimov

workspaces/scorecard/.changeset/proud-files-love.md

@@ -0,0 +1,5 @@
+---
+'@red-hat-developer-hub/backstage-plugin-scorecard-backend-module-jira': patch
+---
+
+Allow numbers for the configuration jira.apiVersion to work in parallel with another plugin

workspaces/scorecard/app-config.local.EXAMPLE.yaml

@@ -0,0 +1,64 @@
+permission:
+  enabled: false
+
+auth:
+  environment: production
+  providers:
+    github:
+      production:
+        clientId: TODO
+        clientSecret: TODO
+        signIn:
+          resolvers:
+            - resolver: usernameMatchingUserEntityName
+
+catalog:
+  locations:
+    - type: file
+      target: ../../examples/entities.yaml
+    - type: file
+      target: ../../examples/github-scorecard-only.yaml
+      rules:
+        - allow: [Component]
+    - type: file
+      target: ../../examples/jira-scorecard-only.yaml
+      rules:
+        - allow: [Component]
+    - type: file
+      target: ../../examples/all-scorecards.yaml
+      rules:
+        - allow: [Component]
+    - type: file
+      target: ../../examples/no-scorecards.yaml
+      rules:
+        - allow: [Component]
+    # TODO: Additional catalog entities for your user
+
+proxy:
+  '/jira/api':
+    target: ${JIRA_URL}
+    headers:
+      Authorization: ${JIRA_TOKEN}
+      Accept: 'application/json'
+      Content-Type: 'application/json'
+      X-Atlassian-Token: 'nocheck'
+      User-Agent: 'MY-UA-STRING'
+
+integrations:
+  github:
+    - host: github.com
+      token: TODO
+
+jira:
+  proxyPath: /jira/api
+  product: cloud
+  baseUrl: ${JIRA_URL}
+  token: ${JIRA_TOKEN}
+  #apiVersion: 3
+
+scorecard:
+  plugins:
+    jira:
+      open_issues:
+        options:
+          mandatoryFilter: Resolution = Unresolved

workspaces/scorecard/app-config.yaml

@@ -1,12 +1,3 @@
-jira:
-  # Required
-  baseUrl: https://issues.redhat.com
-  # Required
-  token: dummy_token
-  # Required: Supported products: `cloud` or `datacenter`
-  product: cloud
-  # By default, the latest version is used. You can omit this prop when using the latest version.
-  apiVersion: '2'
 app:
   title: Scaffolded Backstage App
   baseUrl: http://localhost:3000
@@ -53,12 +44,28 @@ integrations:
     #   token: ${GHE_TOKEN}
 
 proxy:
-  ### Example for how to add a proxy endpoint for the frontend.
-  ### A typical reason to do this is to handle HTTPS and CORS for internal services.
-  # endpoints:
-  #   '/test':
-  #     target: 'https://example.com'
-  #     changeOrigin: true
+  '/jira/api':
+    target: ${JIRA_URL}
+    headers:
+      Authorization: ${JIRA_TOKEN}
+      Accept: 'application/json'
+      Content-Type: 'application/json'
+      X-Atlassian-Token: 'nocheck'
+      User-Agent: 'MY-UA-STRING'
+
+# Jira plugin and scorecard configuration
+jira:
+  # optional: Use the proxy configuration above
+  # proxyPath: /jira/api
+
+  # Required
+  baseUrl: ${JIRA_URL}
+  # Required
+  token: ${JIRA_TOKEN}
+  # Required: Supported products: `cloud` or `datacenter`
+  product: cloud
+  # By default, the latest version is used. You can omit this prop when using the latest version.
+  apiVersion: '2'
 
 # Reference documentation http://backstage.io/docs/features/techdocs/configuration
 # Note: After experimenting with basic setup, use CI/CD to generate docs

workspaces/scorecard/examples/all-scorecards.yaml

@@ -7,7 +7,7 @@ metadata:
   annotations:
     github.com/project-slug: redhat-developer/rhdh-plugins
     backstage.io/source-location: url:https://github.com/redhat-developer/rhdh-plugins
-    jira/project-key: RHDHBUGS
+    jira/project-key: RSPT
 spec:
   type: service
   owner: janus-authors

workspaces/scorecard/examples/jira-scorecard-only.yaml

@@ -5,7 +5,7 @@ kind: Component
 metadata:
   name: jira-scorecard-only-service
   annotations:
-    jira/project-key: RHDHBUGS
+    jira/project-key: RSPT
 spec:
   type: service
   owner: janus-authors

workspaces/scorecard/package.json

@@ -24,6 +24,7 @@
     "lint": "backstage-cli repo lint --since origin/main",
     "lint:all": "backstage-cli repo lint",
     "prettier:check": "prettier --check .",
+    "prettier:fix": "prettier --write .",
     "new": "backstage-cli new --scope @red-hat-developer-hub",
     "postinstall": "cd ../../ && yarn install"
   },

workspaces/scorecard/packages/app/package.json

@@ -19,6 +19,7 @@
     "lint": "backstage-cli package lint"
   },
   "dependencies": {
+    "@backstage-community/plugin-github-issues": "^0.13.0",
     "@backstage-community/plugin-rbac": "^1.43.0",
     "@backstage/app-defaults": "^1.6.5",
     "@backstage/catalog-model": "^1.7.5",
@@ -49,6 +50,8 @@
     "@material-ui/icons": "^4.9.1",
     "@red-hat-developer-hub/backstage-plugin-scorecard": "workspace:^",
     "@red-hat-developer-hub/backstage-plugin-theme": "^0.10.0",
+    "@roadiehq/backstage-plugin-github-pull-requests": "^3.5.1",
+    "@roadiehq/backstage-plugin-jira": "^2.13.1",
     "react": "^18.0.2",
     "react-dom": "^18.0.2",
     "react-router": "^6.3.0",

workspaces/scorecard/packages/app/src/components/catalog/EntityPage.tsx

@@ -74,12 +74,34 @@ import {
 } from '@backstage/plugin-kubernetes';
 import { EntityScorecardContent } from '@red-hat-developer-hub/backstage-plugin-scorecard';
 
+import { GithubIssuesCard } from '@backstage-community/plugin-github-issues';
+import { EntityGithubPullRequestsContent } from '@roadiehq/backstage-plugin-github-pull-requests';
+import { EntityJiraOverviewCard } from '@roadiehq/backstage-plugin-jira';
+
 const scorecardRoute = (
   <EntityLayout.Route path="/scorecard" title="Scorecard">
     <EntityScorecardContent />
   </EntityLayout.Route>
 );
 
+const githubIssuesRoute = (
+  <EntityLayout.Route path="/github-issues" title="GitHub Issues">
+    <GithubIssuesCard />
+  </EntityLayout.Route>
+);
+
+const githubPullRequestsRoute = (
+  <EntityLayout.Route path="/pull-requests" title="Pull Requests">
+    <EntityGithubPullRequestsContent />
+  </EntityLayout.Route>
+);
+
+const jiraOpenIssuesRoute = (
+  <EntityLayout.Route path="/jira" title="Jira">
+    <EntityJiraOverviewCard />
+  </EntityLayout.Route>
+);
+
 const techdocsContent = (
   <EntityTechdocsContent>
     <TechDocsAddons>
@@ -210,6 +232,9 @@ const serviceEntityPage = (
     </EntityLayout.Route>
 
     {scorecardRoute}
+    {githubIssuesRoute}
+    {githubPullRequestsRoute}
+    {jiraOpenIssuesRoute}
   </EntityLayout>
 );
 
@@ -247,6 +272,9 @@ const websiteEntityPage = (
     </EntityLayout.Route>
 
     {scorecardRoute}
+    {githubIssuesRoute}
+    {githubPullRequestsRoute}
+    {jiraOpenIssuesRoute}
   </EntityLayout>
 );
 
@@ -268,6 +296,9 @@ const defaultEntityPage = (
     </EntityLayout.Route>
 
     {scorecardRoute}
+    {githubIssuesRoute}
+    {githubPullRequestsRoute}
+    {jiraOpenIssuesRoute}
   </EntityLayout>
 );
 

workspaces/scorecard/playwright.config.ts

@@ -30,6 +30,10 @@ export default defineConfig({
         command: 'yarn start',
         port: 3000,
         reuseExistingServer: false,
+        env: {
+          JIRA_URL: 'https://issues.redhat.com',
+          JIRA_TOKEN: 'my-jira-token',
+        },
       },
 
   retries: process.env.CI ? 2 : 0,

workspaces/scorecard/plugins/scorecard-backend-module-jira/README.md

@@ -41,7 +41,7 @@ jira:
   # Required: Supported products: `cloud` or `datacenter`
   product: cloud
   # By default, the latest version is used. You can omit this prop when using the latest version.
-  apiVersion: '3'
+  apiVersion: 3
 ```
 
 ## Installation