Add CI/CD support using GitHub Actions

.github/workflows/main.yml

@@ -0,0 +1,49 @@
+---
+name: pagure-exporter
+on: [push, pull_request, workflow_dispatch]
+jobs:
+  ci-basic:
+    strategy:
+      fail-fast: false
+    runs-on: ubuntu-latest
+    container: fedorapython/fedora-python-tox:latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install the base dependencies
+        run: |
+             python3 -m pip install --upgrade poetry tox
+
+      - name: Check the correctness of the project config
+        run: |
+             poetry check
+
+      - name: Check the quality of the code
+        run: |
+             tox -e black
+             tox -e isort
+             tox -e lint
+             tox -e bandit
+
+  ci-tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        tox-env: ["py311"]
+    runs-on: ubuntu-latest
+    container: fedorapython/fedora-python-tox:latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install the base dependencies
+        run: |
+             python3 -m pip install --upgrade tox
+
+      - name: Set up user for running the testcases
+        run: |
+             useradd testrunner
+             chown -R testrunner .
+
+      - name: Execute tox
+        run: |
+             su testrunner -c "tox -e ${{ matrix.tox-env }}"

protop2g/conf/standard.py

@@ -37,7 +37,25 @@
 
 movestat = False
 
-tempdrct = "/var/tmp"
+# While the location for creating temporary directories is definitive, the temporary directories
+# are created with a random name constituting of a definitive prefix in runtime with only the user
+# that created the file having READ and WRITE access to them. Basically, while the location
+# `/var/tmp` is known from the beginning, the locations `/var/tmp/protop2g-tempsrce-$RANDOM` and
+# `/var/tmp/protop2g-tempdest-$RANDOM` are not and hence - that should not be a security concern.
+# For more information, please read
+# https://bandit.readthedocs.io/en/latest/plugins/b108_hardcoded_tmp_directory.html
+# https://security.openstack.org/guidelines/dg_using-temporary-files-securely.html
+tempdrct = "/var/tmp"  # noqa: S108
+
+# If a definitive timeout is not specified for every usage of `requests`, there is likeliness that
+# a failure in probing a URL might lead to the program trying so indefinitely - thus causing the
+# program to freeze. Remember, `requests` is a synchronous HTTP library and if you are looking for
+# some of that nice asynchronicity, you are much better off using the likes of `httpx`.
+# For more information, please read
+# https://bandit.readthedocs.io/en/latest/plugins/b113_request_without_timeout.html
+# https://datagy.io/python-requests-timeouts/
+rqsttime = 30
+
 dfremote = "origin"
 prfxsrce = "protop2g-tempsrce-"
 prfxdest = "protop2g-tempdest-"

protop2g/work/stat.py

@@ -36,7 +36,7 @@ def __init__(self):
 
     def obtninfo(self):
         rqstloca = "{}/{}".format(self.loca, self.repo)
-        response = requests.get(rqstloca, headers=self.head)
+        response = requests.get(rqstloca, headers=self.head, timeout=standard.rqsttime)
         if response.status_code == 200:
             jsondict = response.json()
             standard.srcedict = {
@@ -70,7 +70,7 @@ def __init__(self):
 
     def obtninfo(self):
         rqstloca = "{}/{}".format(self.loca, self.repo)
-        response = requests.get(rqstloca, headers=self.head)
+        response = requests.get(rqstloca, headers=self.head, timeout=standard.rqsttime)
         if response.status_code == 200:
             jsondict = response.json()
             standard.destdict = {

protop2g/work/tkts.py

@@ -43,7 +43,12 @@ def getcount(self):
             initdata = {"per_page": standard.pagesize, "page": "1"}
             if standard.tktstate == "closed" or standard.tktstate == "all":
                 initdata["status"] = standard.tktstate
-            initresp = requests.get(url=f"{self.purl}/issues", params=initdata, headers=self.phed)
+            initresp = requests.get(
+                url=f"{self.purl}/issues",
+                params=initdata,
+                headers=self.phed,
+                timeout=standard.rqsttime,
+            )
             respcode, respresn = initresp.status_code, initresp.reason
             if respcode == 200:
                 initdict = initresp.json()
@@ -55,7 +60,10 @@ def getcount(self):
                     if standard.tktstate == "closed" or standard.tktstate == "all":
                         lastdata["status"] = standard.tktstate
                     lastresp = requests.get(
-                        url=f"{self.purl}/issues", params=lastdata, headers=self.phed
+                        url=f"{self.purl}/issues",
+                        params=lastdata,
+                        headers=self.phed,
+                        timeout=standard.rqsttime,
                     )
                     respcode, respresn = lastresp.status_code, lastresp.reason
                     if lastresp.status_code == 200:
@@ -74,7 +82,12 @@ def iterpage(self, indx):
             rqstdata = {"per_page": standard.pagesize, "page": f"{indx}"}
             if standard.tktstate == "closed" or standard.tktstate == "all":
                 rqstdata["status"] = standard.tktstate
-            response = requests.get(url=f"{self.purl}/issues", params=rqstdata, headers=self.phed)
+            response = requests.get(
+                url=f"{self.purl}/issues",
+                params=rqstdata,
+                headers=self.phed,
+                timeout=standard.rqsttime,
+            )
             respcode, respresn = response.status_code, response.reason
             if respcode == 200:
                 standard.pagerslt = response.json()["issues"]
@@ -87,7 +100,9 @@ def iterpage(self, indx):
     def iteriden(self, tkid):
         try:
             strttime = time.time()
-            response = requests.get(url=f"{self.purl}/issue/{tkid}", headers=self.phed)
+            response = requests.get(
+                url=f"{self.purl}/issue/{tkid}", headers=self.phed, timeout=standard.rqsttime
+            )
             respcode, issuskip = response.status_code, True
             if respcode == 200:
                 standard.issurslt = response.json()
@@ -120,7 +135,7 @@ def itertkts(self, dictobjc):
             standard.issubody = dictobjc["content"]
             standard.timedata = int(dictobjc["date_created"])
             headdata = standard.headtemp_ticket.format(
-                issuiden=standard.issuiden, issuname=standard.issuname
+                issuiden=standard.issuiden, issuname=standard.issuname, timeout=standard.rqsttime
             )
             bodydata = standard.bodytemp_ticket.format(
                 issubody=standard.issubody,
@@ -145,7 +160,12 @@ def itertkts(self, dictobjc):
             rqstdata = {"title": headdata, "description": bodydata.replace("@", "&")}
             if standard.movetags:
                 rqstdata["labels"] = ",".join(standard.issutags)
-            response = requests.post(url=f"{self.gurl}/issues", data=rqstdata, headers=self.ghed)
+            response = requests.post(
+                url=f"{self.gurl}/issues",
+                data=rqstdata,
+                headers=self.ghed,
+                timeout=standard.rqsttime,
+            )
             respcode, respresn = response.status_code, response.reason
             if respcode == 201:
                 respresn = response.json()["web_url"]
@@ -192,6 +212,7 @@ def itercmts(self, dictobjc):
                 url=f"{self.gurl}/issues/{standard.gtlbtkid}/notes",
                 data=rqstdata,
                 headers=self.ghed,
+                timeout=standard.rqsttime,
             )
             respcode, respresn = response.status_code, response.reason
             if respcode == 201:
@@ -212,6 +233,7 @@ def iterstat(self):
                     url=f"{self.gurl}/issues/{standard.gtlbtkid}",
                     data=rqstdata,
                     headers=self.ghed,
+                    timeout=standard.rqsttime,
                 )
                 respcode, respresn = response.status_code, response.reason
             else:

pyproject.toml

@@ -16,10 +16,8 @@ GitPython = "^3.1.37"
 [tool.poetry.group.dev.dependencies]
 pre-commit = "^3.4.0"
 black = "^22.8.0"
-isort = "^5.10.1"
 flake8 = "<5.0.0"
 tox = "^4.0.0"
-bandit = "^1.7.4"
 pytest = "^7.1.3"
 pytest-black = "^0.3.12"
 pytest-flake8 = "^1.0.7"

test/test_main.py

@@ -116,6 +116,6 @@
 def test_main_help(cmdl, code, text):
     runner = CliRunner()
     result = runner.invoke(main, cmdl)
-    assert result.exit_code == code
+    assert result.exit_code == code  # noqa: S101
     for indx in text:
-        assert indx in result.output
+        assert indx in result.output  # noqa: S101

tox.ini

@@ -0,0 +1,39 @@
+[tox]
+minversion = 3.11.0
+envlist = py311,black,lint,isort,bandit
+isolated_build = true
+skip_missing_interpreters = true
+
+[testenv]
+passenv = HOME
+skip_install = true
+sitepackages = false
+deps =
+    poetry>=1.2.0
+commands_pre =
+    poetry install --all-extras
+commands =
+  poetry run pytest -o 'addopts=--cov-config .coveragerc --cov=protop2g --cov-report term-missing --cov-report xml --cov-report html' test/ {posargs}
+
+[testenv:black]
+commands =
+  poetry run black --diff --check protop2g/ test/
+
+[testenv:lint]
+commands =
+  poetry run ruff check protop2g/ test/
+
+[testenv:isort]
+commands =
+  poetry run ruff check --select I protop2g/ test/
+
+[testenv:bandit]
+commands =
+  poetry run ruff check --select S protop2g/ test/
+
+[flake8]
+max-line-length = 100
+extend-ignore = E203
+
+[isort]
+profile = black