Discourse API (#3)

* Add discourse client API
* Add CI using common github actions workflows

Author: jdkandersson

.github/workflows/ci.yaml

@@ -0,0 +1,12 @@
+name: Comment on the pull request
+
+on:
+  workflow_run:
+    workflows: ["Tests"]
+    types:
+      - completed
+
+jobs:
+  comment-on-pr:
+    uses: canonical/operator-workflows/.github/workflows/comment.yaml@main
+    secrets: inherit

.github/workflows/comment.yaml

@@ -0,0 +1,11 @@
+name: Integration Tests
+
+on:
+  pull_request:
+
+jobs:
+  integration-tests:
+    uses: canonical/operator-workflows/.github/workflows/integration_test.yaml@main
+    secrets: inherit
+    with:
+      pre-run-script: tests/integration/pre_run.sh

.github/workflows/integration_test.yaml

@@ -0,0 +1,9 @@
+name: Tests
+
+on:
+  pull_request:
+
+jobs:
+  unit-tests:
+    uses: canonical/operator-workflows/.github/workflows/test.yaml@main
+    secrets: inherit

.github/workflows/on_pull_request.yaml

@@ -0,0 +1,4 @@
+rules:
+  # Ignore "master" - discourse uses this as the rake action to generate the
+  # main API key for server interactions.
+  - name: master

.github/workflows/test.yaml

@@ -0,0 +1 @@
+*       @canonical/is-charms

.woke.yaml

@@ -1,9 +1,9 @@
 FROM python:3-slim AS builder
-ADD . /app
+COPY . /app
 WORKDIR /app
 
 # We are installing a dependency here directly into our app source dir
-RUN pip install --target=/app requests
+RUN pip install --no-cache-dir requests
 
 # A distroless container image with Python and some basics like SSL certificates
 # https://github.com/GoogleContainerTools/distroless

CODEOWNERS

@@ -8,6 +8,10 @@ inputs:
       docs key in metadata.yaml either does not exist or is empty. Defaults to
       not creating a new topic in which case an error is returned.
     default: false
+  discourse_host:
+    description: The discourse host name.
+  discourse_category_id:
+    description: The category identifier to use on discourse for all topics.
 runs:
   using: docker
   image: Dockerfile

Dockerfile

@@ -1,5 +1,5 @@
 # Copyright 2022 Canonical Ltd.
-# Licensed under the GPLv3, see LICENCE file for details.
+# See LICENSE file for licensing details.
 
 """Main execution for the action."""
 

action.yaml

@@ -11,7 +11,7 @@ skips = ["*/*test.py", "*/test_*.py"]
 branch = true
 
 [tool.coverage.report]
-fail_under = 85
+fail_under = 100
 show_missing = true
 
 
@@ -39,9 +39,12 @@ select = ["E", "W", "F", "C", "N", "R", "D", "H"]
 # Ignore D107 Missing docstring in __init__
 ignore = ["W503", "E501", "D107"]
 # D100, D101, D102, D103: Ignore missing docstrings in tests
-per-file-ignores = ["tests/*:D100,D101,D102,D103,D104"]
+per-file-ignores = ["tests/*:D100,D101,D102,D103,D104,D205,D212,D415"]
 docstring-convention = "google"
 # Check for properly formatted copyright header in each file
 copyright-check = "True"
 copyright-author = "Canonical Ltd."
 copyright-regexp = "Copyright\\s\\d{4}([-,]\\d{4})*\\s+%(author)s"
+
+[tool.mypy]
+ignore_missing_imports = true

main.py

@@ -0,0 +1 @@
+pydiscourse>=1.3,<1.4

pyproject.toml

@@ -1,4 +1,4 @@
 # Copyright 2022 Canonical Ltd.
-# Licensed under the GPLv3, see LICENCE file for details.
+# See LICENSE file for licensing details.
 
 """Library for uploading docs to charmhub."""