mirror of
https://github.com/zulip/zulip.git
synced 2025-11-02 04:53:36 +00:00
tushar912
Tim Abbott
BIN
static/images/integrations/bot_avatars/sonarqube.png
Normal file
BIN
static/images/integrations/bot_avatars/sonarqube.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.2 KiB |
1
static/images/integrations/logos/sonarqube.svg
Normal file
1
static/images/integrations/logos/sonarqube.svg
Normal file
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="51" height="51" xml:space="preserve"><image width="51" height="51" xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADMAAAAzCAYAAAA6oTAqAAAABGdBTUEAALGPC/xhBQAAACBjSFJN AAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAABmJLR0QA/wD/AP+gvaeTAAAI cklEQVRo3u2aa2xcxRXHfzP33l3vw971Y3dtxyF24sTGgQBRQgMqASFoIxyFoj5QVKmV2lRtWpV+ qNTSfmnaquoDFVGpAoRE1UckEImEUiiICEpwqJoggpo4QBLn4STEdhw79np3vd7HnemHe3e9GzuO U+WxRTnSSnfvjufOb/7nnDkz10JrrfmUmLzeA7gBcwPm/8zMK9GJ1hohBKW5pPS7EKKsbeGeKlxf 0F9p+8sxcSWzmdaa0s5ECdRcA1RaT7edBe6awlxsALZyujakKMKWtv9gIEXAMuiM+sqBLgF/MZsR M1rr6YdqjSr56As+xQG63zN5m6feHeTVQ2OMpHIYUmBIUfz7AnJhsNt6z7Nh62FeOjCKFAIhwFaq CHS58zwjZkpnRAgxy4xrlALlyIoU04MbTuZ54cAI/eNZOhuq+PzSEBu66rgl5gdAKQ1iOl5+tLaJ er/J42+cYs/pJL98sIWAxyBva0yjHHw+NsPNCn4vhWBiyiY+lcNnGViGwGMIfJYxQ0lbaaQQ5LVm cCLL7v4EOz4e4/1PUnhMwfqOWr6xKsJyF8q2FVI6SoBg1/EJfvz6SRprPDy9oZUFIS9KaYS4PLeb AaOUQmkwDclfPjjHb3adIVZt4bMM6nwGTdVeFtd5WNbgo63WS1utBykL3lruSntOp9jeO8rfD41h CPjaygjfXBUhFvQ4rucO2JCS/rEpNu/oJ5mx+fOXlrCkvoq8UhhCzBtoVmWU1hhSsq13hCd3D+L3 GMSnbBJZm8msIqc0XlPSGDTpivr5TEuQ+xZXs7TB5wS71uS1xnQhe4cm+eO/h3jl0BjLGqp4fO0C 1nWEiy6rcZ6XyNh86+Xj9J+f4q+PtrOs3oetlBtPlwaaFaYQLzlbkc5rsrYilbEZncwzMJHj5HiG j4bTfDSc5sRYhnReEQtafHZRNes7a7mntZpqr4GtnCA2DQloXvl4nN/2DHBqLMPmNTEeu7uRgMfA VgoNmFKSzNhsevkYp+NZtm1cRnONpwjErDE8B8y8TWsGElmOjk7xz2MT9PQn6BudQgrBmoUBNt4W obsjhGVIcrbCECClZCiR5VdvD/BS7wgPdYT5xYMLWRjyknckwjQEiYxi44t9GELwt68sIeg1QDtx qbn4ojqnMqU/6WkGNGCI8k6HUznePBpnx0fn2Xs6BcC9i2v43poYd7YEAU0ur7FMCRqe3XuWX79z hq6oj6fWt9IR8bnrkuNyJ8czfHHrEda2VfP7hxZRyOxyDncztmzZsqWMzvXP0uvSe1JOS60BN9sS 9Bjc2uinuyPM0voqBpNZ3j2ZYGdfnKmc4tbGAD6PQdZWSAGrFwZpq/Wy/eB53jo2wd03VRMNWk42 VZpav0VnxMcT7wwQCVqsaAqULayz2QyYuawUEgrlSuFKozR4TUFn1E93Z5igx+TgUJqdR+N8fC7N LY0+ogEPtptkumJ+bo742P7hKO+cSLC2tZr6gIXGyXRtdVXkNTy9Z5gH20PU+c2ylH3lYmYO17S1 xpQCEOw7k+SJnkF2n5xgaV0VWx5o4b7FIWylnNmUkjf6xvnujn5ub/Tz3CNtzqBdV8rkFY9sPUJb XRXPPNzmwjg+dyHQZSkzl2KlMSalRGungFwQ8vJAe4hUVtFzMsnuEwkagxY3x/zFMmdZg4+Y3+T5 fcOMpnOsWxoG14W9pkFr2Msf/jXEygUBFtV6UVqXrG1XGOZCqELmkUKQtxV+j8H97SFMKeg5kWDX iQmaqi2WxwK4pR0rmvxM5jR/ev8ckYDJHQuCKDfZ3FTr5cPhNK8eGufhrlo8LsiFylyVzVlpoWhI ga0USmm+f1cjP7m3mZzS/OzNT9h5ZBxDCnehhh/e08i9i6v5Xc8gB89OYhqiGPRfXxkhErCYmLKR cnovVPbcq3k6U0yhWqOcG0gpeXbvWZ7oGSQSMHnmC63c0RwkbytMQ3JgMMWjL/axqiXI848sdgtO jRSyrN9rpswMhVyXA2eP8+3VUTatjjCQyLLlrTMMJ53tQs5WrGgK8J07Y7x5NM5rh8fddYUZu9jZ stlVPwMoKKPdOHJuwg/ubmRde4j3Tid58t1BZ70STtL46u0NdDRU8dx7w0xM5ZHulmHGPupaw5TN pJjerPk9Bj+9v4WOqI/tB0f5x+ExTCnJK01DwGLTqij/GUqxsy9eVKF05b8uypSaLlHIVprWWi+P 3dWIreHpPWcZSmQxXdj1nbUsqati6/5R8iWF5lwhfk1hysojnE1dd0eY7o4w+wcneWH/aLH2CvtM vnxrPfvOJNl7KjlDmesOU7DpQTn7ok2rokSDFtsOnqd/PFNMHA8sqSHoMXi9b9xtX0HKFKygjhTO zvb25gDdHWGOn59ie+9osdRvr6/itiY/e0+liKfzTvtKg4FCNhJod7YfXVFHnd/gtcNxhpM5ADym ZHVLkP1nJzl8Lu0qdvE+rxtMaewAdEX9rG2t4chImt39iWLsrFsa4uf3t7Aw7HWSh6ywmClYIXZs pbEMyefaQwgBbx+Pk7edU6LlMR+b18RoqvG4rlmhMNPZzSk21ywMclPIw76BFEPJrFOoKl08SyhM QEXCFAYn3czWXONhZXOAM/EsvUPp4m+CuRfLioEpqKPcw8c7mgPkbM3+wVSxFJrvieZ1h4HyxbAr 5sNvSQ6dm7rsA/SKgCm8ygBYFPYSq7Y4Hc8wls5fMh1XHAxMvxIJWpJowOLcZJ6RVN4J+HmKU1Ew QgiqTEkkYDKZVYykLk+ZK/Ia8EqYBtAayxDU+kxspUlmbdzb87KKUaawgdOuTw2ncsQzdinqJa1i lJnOWpruzjDRgMXymA9gzlW/rI8b/25yFWy2d6nzKWEqEuZC+19en99ws0q1GzCVap8qmP8CUixg 6Y5XCSIAAAAldEVYdGRhdGU6Y3JlYXRlADIwMjEtMDMtMDhUMjM6MDU6MTErMDM6MDAJFNw3AAAA JXRFWHRkYXRlOm1vZGlmeQAyMDIxLTAzLTA4VDIzOjA1OjExKzAzOjAweElkiwAAABl0RVh0U29m dHdhcmUAZ25vbWUtc2NyZWVuc2hvdO8Dvz4AAAAASUVORK5CYII="/></svg>
|
||||
|
After Width: | Height: | Size: 3.4 KiB |
BIN
static/images/integrations/sonarqube/001.png
Normal file
BIN
static/images/integrations/sonarqube/001.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
@@ -444,6 +444,7 @@ WEBHOOK_INTEGRATIONS: List[WebhookIntegration] = [
|
||||
),
|
||||
WebhookIntegration("slack", ["communication"]),
|
||||
WebhookIntegration("solano", ["continuous-integration"], display_name="Solano Labs"),
|
||||
WebhookIntegration("sonarqube", ["continuous-integration"], display_name="SonarQube"),
|
||||
WebhookIntegration("sonarr", ["entertainment"], display_name="Sonarr"),
|
||||
WebhookIntegration("splunk", ["monitoring"], display_name="Splunk"),
|
||||
WebhookIntegration("statuspage", ["customer-support"], display_name="Statuspage"),
|
||||
@@ -780,6 +781,7 @@ DOC_SCREENSHOT_CONFIG: Dict[str, List[BaseScreenshotConfig]] = {
|
||||
],
|
||||
"slack": [ScreenshotConfig("message_info.txt")],
|
||||
"solano": [ScreenshotConfig("build_001.json")],
|
||||
"sonarqube": [ScreenshotConfig("error.json")],
|
||||
"sonarr": [ScreenshotConfig("sonarr_episode_grabbed.json")],
|
||||
"splunk": [ScreenshotConfig("search_one_result.json")],
|
||||
"statuspage": [ScreenshotConfig("incident_created.json")],
|
||||
|
||||
0
zerver/webhooks/sonarqube/__init__.py
Normal file
0
zerver/webhooks/sonarqube/__init__.py
Normal file
15
zerver/webhooks/sonarqube/doc.md
Normal file
15
zerver/webhooks/sonarqube/doc.md
Normal file
@@ -0,0 +1,15 @@
|
||||
Get Zulip notifications for your Sonarqube code analysis!
|
||||
|
||||
1. {!create-stream.md!}
|
||||
|
||||
1. {!create-bot-construct-url-indented.md!}
|
||||
|
||||
1. To configure webhooks for a specific SonarQube project, go to the project and select **Administration**. Select
|
||||
**Webhooks** and click **Create**. **Note**: you can also configure webhooks globally by going to **Configurations** ->
|
||||
**Webhooks** in SonarQube.
|
||||
|
||||
1. Set **Name** to a name for the webhook. Set **URL** to the URL constructed above and click **Create**.
|
||||
|
||||
{!congrats.md!}
|
||||
|
||||
|
||||
46
zerver/webhooks/sonarqube/fixtures/error.json
Normal file
46
zerver/webhooks/sonarqube/fixtures/error.json
Normal file
@@ -0,0 +1,46 @@
|
||||
{
|
||||
"serverUrl": "http://localhost:9000",
|
||||
"taskId": "AXgTFfXRZCzhMRNj54bo",
|
||||
"status": "SUCCESS",
|
||||
"analysedAt": "2021-03-08T18:25:04+0000",
|
||||
"changedAt": "2021-03-08T18:25:04+0000",
|
||||
"project": {
|
||||
"key": "test-sonar",
|
||||
"name": "test-sonar",
|
||||
"url": "http://localhost:9000/dashboard?id=test-sonar"
|
||||
},
|
||||
"branch": {
|
||||
"name": "master",
|
||||
"type": "BRANCH",
|
||||
"isMain": true,
|
||||
"url": "http://localhost:9000/dashboard?id=test-sonar"
|
||||
},
|
||||
"qualityGate": {
|
||||
"name": "Sonar way",
|
||||
"status": "ERROR",
|
||||
"conditions": [
|
||||
{
|
||||
"metric": "maintainability_rating",
|
||||
"operator": "GREATER_THAN",
|
||||
"value": "1",
|
||||
"status": "OK",
|
||||
"errorThreshold": "1"
|
||||
},
|
||||
{
|
||||
"metric": "coverage",
|
||||
"operator": "LESS_THAN",
|
||||
"value": "0.0",
|
||||
"status": "ERROR",
|
||||
"errorThreshold": "80"
|
||||
},
|
||||
{
|
||||
"metric": "duplicated_lines_density",
|
||||
"operator": "GREATER_THAN",
|
||||
"value": "89.39828080229226",
|
||||
"status": "ERROR",
|
||||
"errorThreshold": "3"
|
||||
}
|
||||
]
|
||||
},
|
||||
"properties": {}
|
||||
}
|
||||
40
zerver/webhooks/sonarqube/fixtures/error_no_branch.json
Normal file
40
zerver/webhooks/sonarqube/fixtures/error_no_branch.json
Normal file
@@ -0,0 +1,40 @@
|
||||
{
|
||||
"serverUrl": "http://localhost:9000",
|
||||
"taskId": "AXgTFfXRZCzhMRNj54bo",
|
||||
"status": "SUCCESS",
|
||||
"analysedAt": "2021-03-08T18:25:04+0000",
|
||||
"changedAt": "2021-03-08T18:25:04+0000",
|
||||
"project": {
|
||||
"key": "test-sonar",
|
||||
"name": "test-sonar",
|
||||
"url": "http://localhost:9000/dashboard?id=test-sonar"
|
||||
},
|
||||
"qualityGate": {
|
||||
"name": "Sonar way",
|
||||
"status": "ERROR",
|
||||
"conditions": [
|
||||
{
|
||||
"metric": "maintainability_rating",
|
||||
"operator": "GREATER_THAN",
|
||||
"value": "1",
|
||||
"status": "OK",
|
||||
"errorThreshold": "1"
|
||||
},
|
||||
{
|
||||
"metric": "coverage",
|
||||
"operator": "LESS_THAN",
|
||||
"value": "0.0",
|
||||
"status": "ERROR",
|
||||
"errorThreshold": "80"
|
||||
},
|
||||
{
|
||||
"metric": "duplicated_lines_density",
|
||||
"operator": "GREATER_THAN",
|
||||
"value": "89.39828080229226",
|
||||
"status": "ERROR",
|
||||
"errorThreshold": "3"
|
||||
}
|
||||
]
|
||||
},
|
||||
"properties": {}
|
||||
}
|
||||
45
zerver/webhooks/sonarqube/fixtures/error_no_value.json
Normal file
45
zerver/webhooks/sonarqube/fixtures/error_no_value.json
Normal file
@@ -0,0 +1,45 @@
|
||||
{
|
||||
"serverUrl": "http://localhost:9000",
|
||||
"taskId": "AXgTFfXRZCzhMRNj54bo",
|
||||
"status": "SUCCESS",
|
||||
"analysedAt": "2021-03-08T18:25:04+0000",
|
||||
"changedAt": "2021-03-08T18:25:04+0000",
|
||||
"project": {
|
||||
"key": "test-sonar",
|
||||
"name": "test-sonar",
|
||||
"url": "http://localhost:9000/dashboard?id=test-sonar"
|
||||
},
|
||||
"branch": {
|
||||
"name": "master",
|
||||
"type": "BRANCH",
|
||||
"isMain": true,
|
||||
"url": "http://localhost:9000/dashboard?id=test-sonar"
|
||||
},
|
||||
"qualityGate": {
|
||||
"name": "Sonar way",
|
||||
"status": "ERROR",
|
||||
"conditions": [
|
||||
{
|
||||
"metric": "maintainability_rating",
|
||||
"operator": "GREATER_THAN",
|
||||
"value": "1",
|
||||
"status": "OK",
|
||||
"errorThreshold": "1"
|
||||
},
|
||||
{
|
||||
"metric": "coverage",
|
||||
"operator": "LESS_THAN",
|
||||
"value": "0.0",
|
||||
"status": "ERROR",
|
||||
"errorThreshold": "80"
|
||||
},
|
||||
{
|
||||
"metric": "duplicated_lines_density",
|
||||
"operator": "GREATER_THAN",
|
||||
"status": "ERROR",
|
||||
"errorThreshold": "3"
|
||||
}
|
||||
]
|
||||
},
|
||||
"properties": {}
|
||||
}
|
||||
64
zerver/webhooks/sonarqube/fixtures/success.json
Normal file
64
zerver/webhooks/sonarqube/fixtures/success.json
Normal file
@@ -0,0 +1,64 @@
|
||||
{
|
||||
"serverUrl": "http://localhost:9000",
|
||||
"taskId": "AXgTFfXRZCzhMRNj54bo",
|
||||
"status": "SUCCESS",
|
||||
"analysedAt": "2021-03-08T18:25:04+0000",
|
||||
"changedAt": "2021-03-08T18:25:04+0000",
|
||||
"project": {
|
||||
"key": "test-sonar",
|
||||
"name": "test-sonar",
|
||||
"url": "http://localhost:9000/dashboard?id=test-sonar"
|
||||
},
|
||||
"branch": {
|
||||
"name": "master",
|
||||
"type": "BRANCH",
|
||||
"isMain": true,
|
||||
"url": "http://localhost:9000/dashboard?id=test-sonar"
|
||||
},
|
||||
"qualityGate": {
|
||||
"name": "Sonar way",
|
||||
"status": "OK",
|
||||
"conditions": [
|
||||
{
|
||||
"metric": "new_reliability_rating",
|
||||
"operator": "GREATER_THAN",
|
||||
"value": "1",
|
||||
"status": "OK",
|
||||
"errorThreshold": "1"
|
||||
},
|
||||
{
|
||||
"metric": "new_security_rating",
|
||||
"operator": "GREATER_THAN",
|
||||
"value": "1",
|
||||
"status": "OK",
|
||||
"errorThreshold": "1"
|
||||
},
|
||||
{
|
||||
"metric": "new_maintainability_rating",
|
||||
"operator": "GREATER_THAN",
|
||||
"value": "1",
|
||||
"status": "OK",
|
||||
"errorThreshold": "1"
|
||||
},
|
||||
{
|
||||
"metric": "new_coverage",
|
||||
"operator": "LESS_THAN",
|
||||
"status": "NO_VALUE",
|
||||
"errorThreshold": "80"
|
||||
},
|
||||
{
|
||||
"metric": "new_duplicated_lines_density",
|
||||
"operator": "GREATER_THAN",
|
||||
"status": "NO_VALUE",
|
||||
"errorThreshold": "3"
|
||||
},
|
||||
{
|
||||
"metric": "new_security_hotspots_reviewed",
|
||||
"operator": "LESS_THAN",
|
||||
"status": "NO_VALUE",
|
||||
"errorThreshold": "100"
|
||||
}
|
||||
]
|
||||
},
|
||||
"properties": {}
|
||||
}
|
||||
58
zerver/webhooks/sonarqube/fixtures/success_no_branch.json
Normal file
58
zerver/webhooks/sonarqube/fixtures/success_no_branch.json
Normal file
@@ -0,0 +1,58 @@
|
||||
{
|
||||
"serverUrl": "http://localhost:9000",
|
||||
"taskId": "AXgTFfXRZCzhMRNj54bo",
|
||||
"status": "SUCCESS",
|
||||
"analysedAt": "2021-03-08T18:25:04+0000",
|
||||
"changedAt": "2021-03-08T18:25:04+0000",
|
||||
"project": {
|
||||
"key": "test-sonar",
|
||||
"name": "test-sonar",
|
||||
"url": "http://localhost:9000/dashboard?id=test-sonar"
|
||||
},
|
||||
"qualityGate": {
|
||||
"name": "Sonar way",
|
||||
"status": "OK",
|
||||
"conditions": [
|
||||
{
|
||||
"metric": "new_reliability_rating",
|
||||
"operator": "GREATER_THAN",
|
||||
"value": "1",
|
||||
"status": "OK",
|
||||
"errorThreshold": "1"
|
||||
},
|
||||
{
|
||||
"metric": "new_security_rating",
|
||||
"operator": "GREATER_THAN",
|
||||
"value": "1",
|
||||
"status": "OK",
|
||||
"errorThreshold": "1"
|
||||
},
|
||||
{
|
||||
"metric": "new_maintainability_rating",
|
||||
"operator": "GREATER_THAN",
|
||||
"value": "1",
|
||||
"status": "OK",
|
||||
"errorThreshold": "1"
|
||||
},
|
||||
{
|
||||
"metric": "new_coverage",
|
||||
"operator": "LESS_THAN",
|
||||
"status": "NO_VALUE",
|
||||
"errorThreshold": "80"
|
||||
},
|
||||
{
|
||||
"metric": "new_duplicated_lines_density",
|
||||
"operator": "GREATER_THAN",
|
||||
"status": "NO_VALUE",
|
||||
"errorThreshold": "3"
|
||||
},
|
||||
{
|
||||
"metric": "new_security_hotspots_reviewed",
|
||||
"operator": "LESS_THAN",
|
||||
"status": "NO_VALUE",
|
||||
"errorThreshold": "100"
|
||||
}
|
||||
]
|
||||
},
|
||||
"properties": {}
|
||||
}
|
||||
84
zerver/webhooks/sonarqube/tests.py
Normal file
84
zerver/webhooks/sonarqube/tests.py
Normal file
@@ -0,0 +1,84 @@
|
||||
from zerver.lib.test_classes import WebhookTestCase
|
||||
|
||||
|
||||
class SonarqubeHookTests(WebhookTestCase):
|
||||
STREAM_NAME = "SonarQube"
|
||||
URL_TEMPLATE = "/api/v1/external/sonarqube?api_key={api_key}&stream={stream}"
|
||||
FIXTURE_DIR_NAME = "sonarqube"
|
||||
WEBHOOK_DIR_NAME = "sonarqube"
|
||||
|
||||
def test_analysis_success(self) -> None:
|
||||
expected_topic = "test-sonar / master"
|
||||
|
||||
expected_message = """
|
||||
Project [test-sonar](http://localhost:9000/dashboard?id=test-sonar) analysis of branch master resulted in success.
|
||||
""".strip()
|
||||
|
||||
self.check_webhook(
|
||||
"success",
|
||||
expected_topic,
|
||||
expected_message,
|
||||
content_type="application/x-www-form-urlencoded",
|
||||
)
|
||||
|
||||
def test_analysis_error(self) -> None:
|
||||
expected_topic = "test-sonar / master"
|
||||
|
||||
expected_message = """
|
||||
Project [test-sonar](http://localhost:9000/dashboard?id=test-sonar) analysis of branch master resulted in error:
|
||||
* coverage: **error** 0.0 should be greater than or equal to 80.
|
||||
* duplicated lines density: **error** 89.39828080229226 should be less than or equal to 3.
|
||||
""".strip()
|
||||
|
||||
self.check_webhook(
|
||||
"error",
|
||||
expected_topic,
|
||||
expected_message,
|
||||
content_type="application/x-www-form-urlencoded",
|
||||
)
|
||||
|
||||
def test_analysis_error_no_value(self) -> None:
|
||||
expected_topic = "test-sonar / master"
|
||||
|
||||
expected_message = """
|
||||
Project [test-sonar](http://localhost:9000/dashboard?id=test-sonar) analysis of branch master resulted in error:
|
||||
* coverage: **error** 0.0 should be greater than or equal to 80.
|
||||
* duplicated lines density: **error**.
|
||||
""".strip()
|
||||
|
||||
self.check_webhook(
|
||||
"error_no_value",
|
||||
expected_topic,
|
||||
expected_message,
|
||||
content_type="application/x-www-form-urlencoded",
|
||||
)
|
||||
|
||||
def test_analysis_success_no_branch(self) -> None:
|
||||
expected_topic = "test-sonar"
|
||||
|
||||
expected_message = """
|
||||
Project [test-sonar](http://localhost:9000/dashboard?id=test-sonar) analysis resulted in success.
|
||||
""".strip()
|
||||
|
||||
self.check_webhook(
|
||||
"success_no_branch",
|
||||
expected_topic,
|
||||
expected_message,
|
||||
content_type="application/x-www-form-urlencoded",
|
||||
)
|
||||
|
||||
def test_analysis_error_no_branch(self) -> None:
|
||||
expected_topic = "test-sonar"
|
||||
|
||||
expected_message = """
|
||||
Project [test-sonar](http://localhost:9000/dashboard?id=test-sonar) analysis resulted in error:
|
||||
* coverage: **error** 0.0 should be greater than or equal to 80.
|
||||
* duplicated lines density: **error** 89.39828080229226 should be less than or equal to 3.
|
||||
""".strip()
|
||||
|
||||
self.check_webhook(
|
||||
"error_no_branch",
|
||||
expected_topic,
|
||||
expected_message,
|
||||
content_type="application/x-www-form-urlencoded",
|
||||
)
|
||||
132
zerver/webhooks/sonarqube/view.py
Normal file
132
zerver/webhooks/sonarqube/view.py
Normal file
@@ -0,0 +1,132 @@
|
||||
# Webhooks for external integrations.
|
||||
|
||||
from typing import Any, Dict, List, Mapping
|
||||
|
||||
from django.http import HttpRequest, HttpResponse
|
||||
|
||||
from zerver.decorator import webhook_view
|
||||
from zerver.lib.request import REQ, has_request_variables
|
||||
from zerver.lib.response import json_success
|
||||
from zerver.lib.webhooks.common import check_send_webhook_message
|
||||
from zerver.models import UserProfile
|
||||
|
||||
TOPIC_WITH_BRANCH = "{} / {}"
|
||||
|
||||
MESSAGE_WITH_BRANCH_AND_CONDITIONS = "Project [{}]({}) analysis of branch {} resulted in {}:\n"
|
||||
MESSAGE_WITH_BRANCH_AND_WITHOUT_CONDITIONS = (
|
||||
"Project [{}]({}) analysis of branch {} resulted in {}."
|
||||
)
|
||||
MESSAGE_WITHOUT_BRANCH_AND_WITH_CONDITIONS = "Project [{}]({}) analysis resulted in {}:\n"
|
||||
MESSAGE_WITHOUT_BRANCH_AND_CONDITIONS = "Project [{}]({}) analysis resulted in {}."
|
||||
|
||||
INVERSE_OPERATORS = {
|
||||
"WORSE_THAN": "should be better or equal to",
|
||||
"GREATER_THAN": "should be less than or equal to",
|
||||
"LESS_THAN": "should be greater than or equal to",
|
||||
}
|
||||
|
||||
TEMPLATES = {
|
||||
"default": "* {}: **{}** {} {} {}.",
|
||||
"no_value": "* {}: **{}**.",
|
||||
}
|
||||
|
||||
|
||||
def parse_metric_name(metric_name: str) -> str:
|
||||
return " ".join(metric_name.split("_"))
|
||||
|
||||
|
||||
def parse_condition(condition: Mapping[str, Any]) -> str:
|
||||
metric = condition["metric"]
|
||||
|
||||
metric_name = parse_metric_name(metric)
|
||||
operator = condition["operator"]
|
||||
operator = INVERSE_OPERATORS.get(operator, operator)
|
||||
value = condition.get("value", "no value")
|
||||
status = condition["status"].lower()
|
||||
threshold = condition["errorThreshold"]
|
||||
|
||||
if value == "no value":
|
||||
return TEMPLATES["no_value"].format(metric_name, status)
|
||||
|
||||
template = TEMPLATES["default"]
|
||||
|
||||
return template.format(metric_name, status, value, operator, threshold)
|
||||
|
||||
|
||||
def parse_conditions(conditions: List[Mapping[str, Any]]) -> str:
|
||||
return "\n".join(
|
||||
[
|
||||
parse_condition(condition)
|
||||
for condition in conditions
|
||||
if condition["status"].lower() != "ok" and condition["status"].lower() != "no_value"
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
def render_body_with_branch(payload: Mapping[str, Any]) -> str:
|
||||
project_name = payload["project"]["name"]
|
||||
project_url = payload["project"]["url"]
|
||||
quality_gate_status = payload["qualityGate"]["status"].lower()
|
||||
if quality_gate_status == "ok":
|
||||
quality_gate_status = "success"
|
||||
else:
|
||||
quality_gate_status = "error"
|
||||
branch = payload["branch"]["name"]
|
||||
|
||||
conditions = payload["qualityGate"]["conditions"]
|
||||
conditions = parse_conditions(conditions)
|
||||
|
||||
if not conditions:
|
||||
return MESSAGE_WITH_BRANCH_AND_WITHOUT_CONDITIONS.format(
|
||||
project_name, project_url, branch, quality_gate_status
|
||||
)
|
||||
msg = MESSAGE_WITH_BRANCH_AND_CONDITIONS.format(
|
||||
project_name, project_url, branch, quality_gate_status
|
||||
)
|
||||
msg += conditions
|
||||
|
||||
return msg
|
||||
|
||||
|
||||
def render_body_without_branch(payload: Mapping[str, Any]) -> str:
|
||||
project_name = payload["project"]["name"]
|
||||
project_url = payload["project"]["url"]
|
||||
quality_gate_status = payload["qualityGate"]["status"].lower()
|
||||
if quality_gate_status == "ok":
|
||||
quality_gate_status = "success"
|
||||
else:
|
||||
quality_gate_status = "error"
|
||||
conditions = payload["qualityGate"]["conditions"]
|
||||
conditions = parse_conditions(conditions)
|
||||
|
||||
if not conditions:
|
||||
return MESSAGE_WITHOUT_BRANCH_AND_CONDITIONS.format(
|
||||
project_name, project_url, quality_gate_status
|
||||
)
|
||||
msg = MESSAGE_WITHOUT_BRANCH_AND_WITH_CONDITIONS.format(
|
||||
project_name, project_url, quality_gate_status
|
||||
)
|
||||
msg += conditions
|
||||
|
||||
return msg
|
||||
|
||||
|
||||
@webhook_view("Sonarqube")
|
||||
@has_request_variables
|
||||
def api_sonarqube_webhook(
|
||||
request: HttpRequest,
|
||||
user_profile: UserProfile,
|
||||
payload: Dict[str, Any] = REQ(argument_type="body"),
|
||||
) -> HttpResponse:
|
||||
project = payload["project"]["name"]
|
||||
branch = None
|
||||
if "branch" in payload.keys():
|
||||
branch = payload["branch"].get("name", None)
|
||||
if branch:
|
||||
topic = TOPIC_WITH_BRANCH.format(project, branch)
|
||||
message = render_body_with_branch(payload)
|
||||
else:
|
||||
topic = project
|
||||
message = render_body_without_branch(payload)
|
||||
check_send_webhook_message(request, user_profile, topic, message)
|
||||
return json_success()
|
||||
Reference in New Issue
Block a user