Merge pull request #17 from devops-ia/feat/add-tests-and-examples

add tests and linter

Author: ialejandro

.github/workflows/build.yaml

@@ -34,16 +34,6 @@ jobs:
           git config user.name "$GITHUB_ACTOR"
           git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
 
-      - name: Semantic Release
-        uses: cycjimmy/semantic-release-action@v4
-        id: semantic_release
-        with:
-          dry_run: true
-          branch: main
-          tag_format: ${version}
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
       - name: "Set Docker metadata"
         id: meta
         uses: docker/metadata-action@v5
@@ -56,8 +46,10 @@ jobs:
             org.opencontainers.image.title=Bitbucket Bot
             org.opencontainers.image.description=Bitbucket Bot to Google Chat (Spaces)
             org.opencontainers.image.vendor=DevOps IA
+          flavor: |
+            latest=auto
           tags: |
-            type=raw,value=${{ github.ref_name }}
+            type=semver,pattern={{raw}}
             type=sha,enable=false
 
       - name: Set up QEMU

.github/workflows/lint-tests.yaml

@@ -0,0 +1,56 @@
+name: Linter and tests for Bitbucket Bot
+
+on:
+  workflow_dispatch:
+  pull_request:
+    types: [opened, synchronize, reopened]
+  push:
+    paths:
+      - app/**
+      - tests/**
+      - Pipfile*
+
+jobs:
+  release:
+    name: Linter and tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+          check-latest: true
+
+      - name: Install pipenv
+        run: |
+          python -m pip install --upgrade pipenv wheel
+
+      - id: cache-pipenv
+        uses: actions/cache@v4
+        with:
+          path: ~/.local/share/virtualenvs
+          key: ${{ runner.os }}-pipenv-${{ hashFiles('**/Pipfile.lock') }}
+
+      - name: Install dependencies
+        if: steps.cache-pipenv.outputs.cache-hit != 'true'
+        run: |
+          pipenv install --deploy --dev
+
+      - name: pylint
+        uses: sunnysid3up/python-linter@master
+        with:
+          source: "app"
+          pylint-options: "--rcfile=.pylintrc"
+
+      - name: pytest
+        uses: pavelzw/pytest-action@v2
+        with:
+          verbose: false
+          emoji: false
+          job-summary: true
+          report-title: 'pylint report'

.pylintrc

@@ -0,0 +1,5 @@
+[pylint]
+max-line-length=120
+disable=no-value-for-parameter,no-member
+ignore=.git,venv,tests/__pycache__,migrations
+max-attributes=10

Pipfile

@@ -0,0 +1,18 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+flask = "==3.0.*"
+gunicorn = "==22.0.*"
+markupsafe = "==2.1.5"
+requests = "==2.32.*"
+
+[dev-packages]
+pytest = "==8.3.*"
+pytest-flask = "==1.3.*"
+pylint = "==3.2.*"
+
+[requires]
+python_version = "3.12"

Pipfile.lock

@@ -1,49 +1,102 @@
+
 # Bitbucket Bot for Google Chat
 
 ## Introduction
 
-Bitbucket Bot to integrate Bitbucket's webhook with Google Chat (Spaces).
+The Bitbucket Bot integrates Bitbucket's webhook events with Google Chat (Spaces). This bot listens for specific events from Bitbucket, such as pull requests (PRs), and sends notifications directly to a Google Chat (Spaces). The bot is designed to streamline your development workflow by providing real-time updates on key activities in your repositories.
 
 ## Example
 
+When a pull request is opened, the bot sends a notification to your Google Chat space with details about the PR:
+
 ![Sample open PR](img/sample-pr.png)
 
-## Image details (from dive)
+## Quick start!
 
-```text
-│ Image Details ├─────────────
+### Run container
 
-Total Image size: 178 MB
-Potential wasted space: 6.6 MB
-Image efficiency score: 97 %
+```bash
+docker run --name <container-name>    \
+  -p 8080:8080                        \
+  --bind 0.0.0.0:8080                 \
+  --log-level=info                    \
+  -e URL=<ENDPOINT-GOOGLE-CHAT-SPACE> \
+  -e TOKEN=<SECRET-TOKEN>             \
+  devopsiaci/bitbucket-bot:latest
 ```
 
-You can reproduce this summary with [`dive`](https://github.com/wagoodman/dive):
-
-```command
-dive build -t <tag-name> .
+### Bitbucket Payloads
+
+Refer to the [Bitbucket payload documentation](https://confluence.atlassian.com/bitbucketserver0721/event-payload-1115665959.html?utm_campaign=in-app-help&utm_medium=in-app-help&utm_source=stash#Eventpayload-pullrequest) for details on the data structure of events.
+
+## Request Payload
+
+### Payload example
+
+Here is an example of a pull request payload that the bot processes. Check [samples folder](./samples):
+
+```json
+{
+    "eventKey": "pr:comment:added",
+    "date": "2022-09-02T09:24:34+0000",
+    "actor": {
+        "name": "sample",
+        "emailAddress": "mail@example.com",
+        "id": 86045,
+        "displayName": "sample",
+        "active": true,
+        "slug": "sample",
+        "type": "NORMAL",
+        "links": {
+            "self": [
+                {
+                    "href": "https://bitbucket.org/bitbucket/users/sample"
+                }
+            ]
+        }
+    },
+    ...
 ```
 
-## Quick start!
+On `samples` folder:
+
+```console
+# request
+$ curl -XPOST -H "Content-Type: application/json" -d '@sample_pr_add_comment.json' http://<IP>:<PORT>\?token\=<SECRET-TOKEN>
+
+POST / HTTP/1.1
+Host: <IP>:<PORT>
+User-Agent: python-requests/2.32.3
+Accept-Encoding: gzip, deflate
+Accept: */*
+Connection: keep-alive
+Content-Type: application/json; charset=UTF-8
+Content-Length: 958
 
-### Pull image
+{"cards": [{"header": {"title": "pr:comment:added | (GFP) REPOSITORY", "imageUrl": "https://cdn-icons-png.flaticon.com/512/6125/6125001.png"}, "sections": [{"widgets": [{"keyValue": {"icon": "PERSON", "topLabel": "author", "content": "mail@example.com"}}, {"keyValue": {"iconUrl": "https://cdn-icons-png.flaticon.com/512/7201/7201872.png", "topLabel": "Pull Request", "content": "test 3"}}, {"keyValue": {"iconUrl": "https://cdn-icons-png.flaticon.com/512/6577/6577243.png", "topLabel": "ID Pull Request", "content": "1 (version: 5)"}}, {"keyValue": {"iconUrl": "https://cdn-icons-png.flaticon.com/512/1721/1721936.png", "topLabel": "Status", "content": "OPEN"}}]}, {"widgets": [{"keyValue": {"icon": "DESCRIPTION", "topLabel": "Comment by sample", "content": "Test"}}]}, {"widgets": [{"buttons": [{"textButton": {"text": "Review PR", "onClick": {"openLink": {"url": "https://bitbucket.org/bitbucket/projects/KEY/repos/REPOSITORY/pull-requests/1"}}}}]}]}]}]}
 
-```command
-docker build -t <tag-name> .
 ```
 
-### Run container
+## Tests
 
-**IMPORTANT**: `--bind`, `--log-level`, `-e` are runtime Docker options.
+### Running Tests
 
-```command
-docker run --name <container-name>    \
-  -p 8080:8080                        \
-  <tag-name>                          \
-  --bind 0.0.0.0:8080                 \
-  --log-level=info                    \
-  -e URL=<ENDPOINT-GOOGLE-CHAT-SPACE> \
-  -e TOKEN=<SECRET-TOKEN>
+The project uses `pytest` for testing. To run the tests, navigate to the project directory and execute the following command:
+
+```bash
+pytest
 ```
 
-* [Bitbucket playloads](https://confluence.atlassian.com/bitbucketserver0721/event-payload-1115665959.html?utm_campaign=in-app-help&utm_medium=in-app-help&utm_source=stash#Eventpayload-pullrequest)
+This will run all the tests located in the `tests/` directory. Make sure you have the necessary dependencies installed by running:
+
+```bash
+pip install -r requirements-dev.txt
+```
+
+### Writing Tests
+
+To write new tests, create a new file in the `tests/` directory with the prefix `test_`. For example, to test a new feature in `app.py`, create a file named `test_app.py` and add your test cases there.
+
+## Contributing
+
+Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file for details on our code of conduct and the process for submitting pull requests.

README.md

@@ -1,3 +1,7 @@
+"""
+Bitbucket Bot to integrate Bitbucket's webhook with Google Chat (Spaces)
+"""
+
 import html
 import json
 import os
@@ -175,6 +179,7 @@ def send_message(self, message={}):
             url=self.url,
             headers=headers,
             data=json.dumps(bot_message),
+            timeout=10
         )
 
         return response.text
@@ -186,10 +191,11 @@ def main():
     Main function to deploy
 
     '''
-    url   = os.environ.get('URL', 'http://example.com')
+    url = os.environ.get('URL', 'http://example.com')
     token = os.environ.get('TOKEN')
+    r = {}
 
-    if request.args['token']!= token:
+    if request.args['token'] != token:
         return "Invalid token", 403
 
     event = request.get_json()
@@ -200,18 +206,17 @@ def main():
     message = Message(url, event)
     if (event['eventKey'] == 'pr:opened' or event['eventKey'] == 'pr:merged' or event['eventKey'] == 'pr:declined'):
         r = message.send_message()
-    elif (event['eventKey'] == 'pr:modified'):
+    elif event['eventKey'] == 'pr:modified':
         r = comment = message.pr_modified(event)
         message.send_message(comment)
-    elif (event['eventKey'] == 'pr:comment:added'):
+    elif event['eventKey'] == 'pr:comment:added':
         comment = message.pr_comment_add(event)
         r = message.send_message(comment)
     elif (event['eventKey'] == 'pr:reviewer:needs_work' or event['eventKey'] == 'pr:reviewer:approved'):
         comment = message.pr_approved(event)
         r = message.send_message(comment)
 
-    # Mitigate XSS
-    return html.escape(r)
+    return html.escape(json.dumps(r))
 
 
 if __name__ == "__main__":

app/__init__.py

@@ -1,5 +1,9 @@
+
+"""
+Starts the Flask application
+"""
+
 from app import app
 
 if __name__ == "__main__":
     app.run()
-

app/app.py

@@ -0,0 +1,3 @@
+[pytest]
+pythonpath = .
+testpaths = tests