feat: migrate from woodpecker to forgejo actions

.forgejo/workflows/package.yml

@@ -0,0 +1,38 @@
+---
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+
+  build_wheel:
+    runs-on: docker
+    steps:
+      - uses: https://code.forgejo.org/actions/checkout@v4
+      - name: Build Python wheel
+        run: |
+          apt update; apt install -y python3-pip
+          pip3 install --break-system-packages -e .[test]
+          python3 setup.py egg_info bdist_wheel
+      - uses: https://git.kabelsalat.ch/s3lph/forgejo-action-wheel-package-upload@v3
+        with:
+          username: ${{ secrets.API_USERNAME }}
+          password: ${{ secrets.API_PASSWORD }}
+
+  build_debian:
+    runs-on: docker
+    steps:
+      - uses: https://code.forgejo.org/actions/checkout@v4
+      - uses: https://git.kabelsalat.ch/s3lph/forgejo-action-python-debian-package@v5
+        with:
+          python_module: icalendar_timeseries_server
+          package_name: icalendar-timeseries-server
+          package_root: package/debian/icalendar-timeseries-server
+          package_output_path: package/debian
+      - uses: https://git.kabelsalat.ch/s3lph/forgejo-action-debian-package-upload@v2
+        with:
+          username: ${{ secrets.API_USERNAME }}
+          password: ${{ secrets.API_PASSWORD }}
+          deb: "package/debian/*.deb"

.forgejo/workflows/test.yml

@@ -0,0 +1,27 @@
+---
+
+on: push
+
+jobs:
+
+  test:
+    runs-on: docker
+    steps:
+      - uses: https://code.forgejo.org/actions/checkout@v4
+      - name: test
+        run: |
+          apt update; apt install --yes python3-pip
+          pip3 install --break-system-packages -e .[test]
+          python3 -m coverage run --rcfile=setup.cfg -m unittest discover icalendar_timeseries_server
+          python3 -m coverage combine
+          python3 -m coverage report --rcfile=setup.cfg
+
+  codestyle:
+    runs-on: docker
+    steps:
+      - uses: https://code.forgejo.org/actions/checkout@v4
+      - name: codestyle
+        run: |
+          apt update; apt install --yes python3-pip
+          pip3 install --break-system-packages -e .[test]
+          pycodestyle icalendar_timeseries_server

.gitlab-ci.yml

@@ -1,108 +0,0 @@
----
-image: s3lph/icalendar-timeseries-server-ci:20190820-01
-
-stages:
-- test
-- build
-- release
-
-
-
-before_script:
-- export ITS_VERSION=$(python -c 'import icalendar_timeseries_server; print(icalendar_timeseries_server.__version__)')
-
-
-
-test:
-  stage: test
-  script:
-  - pip3 install -e .
-  - sudo -u its python3 -m coverage run --rcfile=setup.cfg -m unittest discover icalendar_timeseries_server
-  - sudo -u its python3 -m coverage combine
-  - sudo -u its python3 -m coverage report --rcfile=setup.cfg
-
-codestyle:
-  stage: test
-  script:
-  - pip3 install -e .
-  - sudo -u its pycodestyle icalendar_timeseries_server
-
-
-
-build_wheel:
-  stage: build
-  script:
-  - pip3 install -e .
-  - python3 setup.py egg_info bdist_wheel
-  - cd dist
-  - sha256sum *.whl > SHA256SUMS
-  artifacts:
-    paths:
-    - "dist/*.whl"
-    - dist/SHA256SUMS
-  only:
-  - tags
-
-build_debian:
-  stage: build
-  script:
-  # The Python package name provided by the python3-magic Debian package is "python-magic" rather than "file-magic".
-  - sed -re 's/file-magic/python-magic/' -i setup.py
-  - echo -n > package/debian/icalendar-timeseries-server/usr/share/doc/icalendar-timeseries-server/changelog
-  - |
-    cat > package/debian/icalendar-timeseries-server/DEBIAN/control <<EOF
-    Package: icalendar-timeseries-server
-    Version: ${ITS_VERSION}
-    Maintainer: ${PACKAGE_AUTHOR}
-    Section: web
-    Priority: optional
-    Architecture: all
-    Depends: python3 (>= 3.7), python3-jinja2, python3-bottle, python3-dateutil, python3-icalendar, python3-isodate
-    Description: Scrape iCalendar endpoints and present their data in a
-     timeseries format.  A small service that scrapes iCalendar files
-     served over HTTP, parses their contents and returns a timeseries
-     format compatible to the /api/v1/query API endpoint of a Prometheus
-     server. This allows e.g. a Grafana administrator to add a Prometheus
-     data source pointing at this server, returning the events in the
-     calendars in the event metric.
-    EOF
-  - |
-    for version in $(cat CHANGELOG.md | grep '<!-- BEGIN CHANGES' | cut -d ' ' -f 4); do
-      echo "icalendar-timeseries-server (${version}-1); urgency=medium\n" >> package/debian/icalendar-timeseries-server/usr/share/doc/icalendar-timeseries-server/changelog
-      cat CHANGELOG.md | grep -A 1000 "<"'!'"-- BEGIN CHANGES ${version} -->" | grep -B 1000 "<"'!'"-- END CHANGES ${version} -->" | tail -n +2 | head -n -1 | sed -re 's/^-/  */g' >> package/debian/icalendar-timeseries-server/usr/share/doc/icalendar-timeseries-server/changelog
-      echo "\n -- ${PACKAGE_AUTHOR}  $(date -R)\n" >> package/debian/icalendar-timeseries-server/usr/share/doc/icalendar-timeseries-server/changelog
-    done
-  - gzip -9n package/debian/icalendar-timeseries-server/usr/share/doc/icalendar-timeseries-server/changelog
-  - python3.7 setup.py egg_info install --root=package/debian/icalendar-timeseries-server/ --prefix=/usr --optimize=1
-  - cd package/debian
-  - mkdir -p icalendar-timeseries-server/usr/lib/python3/dist-packages/
-  - rsync -a icalendar-timeseries-server/usr/lib/python3.7/site-packages/ icalendar-timeseries-server/usr/lib/python3/dist-packages/
-  - rm -rf icalendar-timeseries-server/usr/lib/python3.7/
-  - find icalendar-timeseries-server/usr/lib/python3/dist-packages -name __pycache__ -exec rm -r {} \; 2>/dev/null || true
-  - find icalendar-timeseries-server/usr/lib/python3/dist-packages -name '*.pyc' -exec rm {} \;
-  - mv icalendar-timeseries-server/usr/bin/icalendar-timeseries-server icalendar-timeseries-server/usr/lib/icalendar-timeseries-server/icalendar-timeseries-server
-  - rm -rf icalendar-timeseries-server/usr/bin
-  - sed -re 's$#!/usr/local/bin/python3.7$#!/usr/bin/python3$' -i icalendar-timeseries-server/usr/lib/icalendar-timeseries-server/icalendar-timeseries-server
-  - find icalendar-timeseries-server -type f -exec chmod 0644 {} \;
-  - find icalendar-timeseries-server -type d -exec chmod 755 {} \;
-  - find icalendar-timeseries-server -type f -name .gitkeep -delete
-  - chmod +x icalendar-timeseries-server/usr/lib/icalendar-timeseries-server/icalendar-timeseries-server icalendar-timeseries-server/DEBIAN/postinst icalendar-timeseries-server/DEBIAN/prerm icalendar-timeseries-server/DEBIAN/postrm
-  - dpkg-deb --build icalendar-timeseries-server
-  - mv icalendar-timeseries-server.deb "icalendar-timeseries-server_${ITS_VERSION}-1_all.deb"
-  - sudo -u nobody lintian "icalendar-timeseries-server_${ITS_VERSION}-1_all.deb"
-  - sha256sum *.deb > SHA256SUMS
-  artifacts:
-    paths:
-    - "package/debian/*.deb"
-    - package/debian/SHA256SUMS
-  only:
-  - tags
-
-
-
-release:
-  stage: release
-  script:
-  - python package/release.py
-  only:
-  - tags

CHANGELOG.md

@@ -1,6 +1,55 @@
 # iCalendar Timeseries Server Changelog
 
 
+<!-- BEGIN RELEASE v0.6.3 -->
+## Version 0.6.3
+
+### Changes
+
+<!-- BEGIN CHANGES 0.6.3 -->
+- Migration from Woodpecker to Forgejo Actions.
+<!-- END CHANGES 0.6.3 -->
+
+<!-- END RELEASE v0.6.3 -->
+
+<!-- BEGIN RELEASE v0.6.2 -->
+## Version 0.6.2
+
+### Changes
+
+<!-- BEGIN CHANGES 0.6.2 -->
+- Migration from Gitlab-CI to Woodpecker
+<!-- END CHANGES 0.6.2 -->
+
+<!-- END RELEASE v0.6.2 -->
+
+
+<!-- BEGIN RELEASE v0.6.1 -->
+## Version 0.6.1
+
+### Changes
+
+<!-- BEGIN CHANGES 0.6.1 -->
+- Same fix, but for todo as well as events.
+
+<!-- END CHANGES 0.6.1 -->
+
+<!-- END RELEASE v0.6.1 -->
+
+
+<!-- BEGIN RELEASE v0.6 -->
+## Version 0.6
+
+### Changes
+
+<!-- BEGIN CHANGES 0.6 -->
+- Fix: A specific API field has to be a string rather than float, and recent Grafana versions validate this.
+
+<!-- END CHANGES 0.6 -->
+
+<!-- END RELEASE v0.6 -->
+
+
 <!-- BEGIN RELEASE v0.5 -->
 ## Version 0.5
 

icalendar_timeseries_server/__init__.py

@@ -1,2 +1,2 @@
 
-__version__ = '0.5'
+__version__ = '0.6.3'

icalendar_timeseries_server/event.py

@@ -59,7 +59,7 @@ class Event(Metric):
             },
             'value': [
                 self.start.timestamp(),
-                1
+                "1"
             ]
         }
         event['metric'].update(self._labels)

icalendar_timeseries_server/todo.py

@@ -70,7 +70,7 @@ class Todo(Metric):
             },
             'value': [
                 self.start.timestamp(),
-                1
+                "1"
             ]
         }
         todo['metric'].update(self._labels)

package/debian/icalendar-timeseries-server/DEBIAN/control

@@ -0,0 +1,14 @@
+Package: icalendar-timeseries-server
+Version: __VERSION__
+Maintainer: s3lph <s3lph@kabelsalat.ch>
+Section: web
+Priority: optional
+Architecture: all
+Depends: python3 (>= 3.7), python3-jinja2, python3-bottle, python3-dateutil, python3-icalendar, python3-isodate
+Description: Scrape iCalendar endpoints and present their data in a timeseries format.
+ A small service that scrapes iCalendar files served over HTTP, parses
+ their contents and returns a timeseries format compatible to the
+ /api/v1/query API endpoint of a Prometheus server. This allows e.g. a
+ Grafana administrator to add a Prometheus data source pointing at
+ this server, returning the events in the calendars in the event
+ metric.

package/debian/icalendar-timeseries-server/DEBIAN/postinst

@@ -15,11 +15,7 @@ if [[ "$1" == "configure" ]]; then
     chown its:its /var/lib/its
     chmod 0750 /var/lib/its
 
-    systemctl daemon-reload || true
-
-    if [[ "$2" != "" ]]; then
-        # Restart after upgrading the package
-        systemctl restart icalendar-timeseries-server.service
-    fi
+    deb-systemd-helper enable icalendar-timeseries-server.service
+    deb-systemd-invoke restart icalendar-timeseries-server.service
 
 fi

package/debian/icalendar-timeseries-server/DEBIAN/prerm

@@ -4,6 +4,6 @@ set -e
 
 if [[ "$1" == "remove" ]]; then
 
-    userdel its
+    deb-systemd-invoke stop icalendar-timeseries-server.service
 
 fi

package/release.py

@@ -1,183 +0,0 @@
-
-from typing import Any, Dict, List, Optional, Tuple
-
-import os
-import sys
-import json
-import urllib.request
-import http.client
-from urllib.error import HTTPError
-
-
-def parse_changelog(tag: str) -> Optional[str]:
-    release_changelog: str = ''
-    with open('CHANGELOG.md', 'r') as f:
-        in_target: bool = False
-        done: bool = False
-        for line in f.readlines():
-            if in_target:
-                if f'<!-- END RELEASE {tag} -->' in line:
-                    done = True
-                    break
-                release_changelog += line
-            elif f'<!-- BEGIN RELEASE {tag} -->' in line:
-                in_target = True
-                continue
-    if not done:
-        return None
-    return release_changelog
-
-
-def fetch_job_ids(project_id: str, pipeline_id: str, api_token: str) -> Dict[str, str]:
-    url: str = f'https://gitlab.com/api/v4/projects/{project_id}/pipelines/{pipeline_id}/jobs'
-    headers: Dict[str, str] = {
-        'Private-Token': api_token,
-        'User-Agent': 'curl/7.70.0'
-    }
-    req = urllib.request.Request(url, headers=headers)
-    try:
-        resp: http.client.HTTPResponse = urllib.request.urlopen(req)
-    except HTTPError as e:
-        print(e.read().decode())
-        sys.exit(1)
-    resp_data: bytes = resp.read()
-    joblist: List[Dict[str, Any]] = json.loads(resp_data.decode())
-
-    jobidmap: Dict[str, str] = {}
-    for job in joblist:
-        name: str = job['name']
-        job_id: str = job['id']
-        jobidmap[name] = job_id
-    return jobidmap
-
-
-def fetch_single_shafile(url: str, api_token: str) -> str:
-    headers: Dict[str, str] = {
-        'User-Agent': 'curl/7.70.0',
-        'Private-Token': api_token
-    }
-    req = urllib.request.Request(url, headers=headers)
-    try:
-        resp: http.client.HTTPResponse = urllib.request.urlopen(req)
-    except HTTPError as e:
-        print(e.read().decode())
-        sys.exit(1)
-    resp_data: bytes = resp.readline()
-    shafile: str = resp_data.decode()
-    filename: str = shafile.strip().split(' ')[-1].strip()
-    return filename
-
-
-def fetch_wheel_url(base_url: str, project_id: str, job_ids: Dict[str, str], api_token: str) -> Optional[Tuple[str, str]]:
-    mybase: str = f'{base_url}/jobs/{job_ids["build_wheel"]}/artifacts/raw'
-    wheel_sha_url: str = f'https://gitlab.com/api/v4/projects/{project_id}/jobs/{job_ids["build_wheel"]}'\
-                         '/artifacts/dist/SHA256SUMS'
-    wheel_filename: str = fetch_single_shafile(wheel_sha_url, api_token)
-    wheel_url: str = f'{mybase}/dist/{wheel_filename}'
-    return wheel_url, wheel_sha_url
-
-
-def fetch_debian_url(base_url: str, project_id: str, job_ids: Dict[str, str], api_token: str) -> Optional[Tuple[str, str]]:
-    mybase: str = f'{base_url}/jobs/{job_ids["build_debian"]}/artifacts/raw'
-    debian_sha_url: str = f'https://gitlab.com/api/v4/projects/{project_id}/jobs/{job_ids["build_debian"]}'\
-                          '/artifacts/package/debian/SHA256SUMS'
-    debian_filename: str = fetch_single_shafile(debian_sha_url, api_token)
-    debian_url: str = f'{mybase}/package/debian/{debian_filename}'
-    return debian_url, debian_sha_url
-
-
-def main():
-    api_token: Optional[str] = os.getenv('GITLAB_API_TOKEN')
-    release_tag: Optional[str] = os.getenv('CI_COMMIT_TAG')
-    project_name: Optional[str] = os.getenv('CI_PROJECT_PATH')
-    project_id: Optional[str] = os.getenv('CI_PROJECT_ID')
-    pipeline_id: Optional[str] = os.getenv('CI_PIPELINE_ID')
-    if api_token is None:
-        print('GITLAB_API_TOKEN is not set.', file=sys.stderr)
-        sys.exit(1)
-    if release_tag is None:
-        print('CI_COMMIT_TAG is not set.', file=sys.stderr)
-        sys.exit(1)
-    if project_name is None:
-        print('CI_PROJECT_PATH is not set.', file=sys.stderr)
-        sys.exit(1)
-    if project_id is None:
-        print('CI_PROJECT_ID is not set.', file=sys.stderr)
-        sys.exit(1)
-    if pipeline_id is None:
-        print('CI_PIPELINE_ID is not set.', file=sys.stderr)
-        sys.exit(1)
-
-    changelog: Optional[str] = parse_changelog(release_tag)
-    if changelog is None:
-        print('Changelog could not be parsed.', file=sys.stderr)
-        sys.exit(1)
-
-    job_ids: Dict[str, str] = fetch_job_ids(project_id, pipeline_id, api_token)
-
-    base_url: str = f'https://gitlab.com/{project_name}/-'
-
-    wheel_url, wheel_sha_url = fetch_wheel_url(base_url, project_id, job_ids, api_token)
-    debian_url, debian_sha_url = fetch_debian_url(base_url, project_id, job_ids, api_token)
-
-    augmented_changelog = f'''{changelog.strip()}
-
-### Download
-
-- [Python Wheel]({wheel_url}) ([sha256]({wheel_sha_url}))
-- [Debian Package]({debian_url}) ([sha256]({debian_sha_url}))'''
-    # Docker currently not working
-    # - Docker image: registry.gitlab.com/{project_name}:{release_tag}
-
-    post_body: str = json.dumps({
-        'tag_name': release_tag,
-        'description': augmented_changelog,
-        'assets': {
-            'links': [
-                {
-                    'name': 'Python Wheel',
-                    'url': wheel_url,
-                    'link_type': 'package'
-                },
-                {
-                    'name': 'Debian Package',
-                    'url': debian_url,
-                    'link_type': 'package'
-                }
-            ]
-        }
-    })
-
-    gitlab_release_api_url: str = \
-        f'https://gitlab.com/api/v4/projects/{project_id}/releases'
-    headers: Dict[str, str] = {
-        'Private-Token': api_token,
-        'Content-Type': 'application/json; charset=utf-8',
-        'User-Agent': 'curl/7.70.0'
-    }
-
-    request = urllib.request.Request(
-        gitlab_release_api_url,
-        post_body.encode('utf-8'),
-        headers=headers,
-        method='POST'
-    )
-    try:
-        response: http.client.HTTPResponse = urllib.request.urlopen(request)
-    except HTTPError as e:
-        print(e.read().decode())
-        sys.exit(1)
-    response_bytes: bytes = response.read()
-    response_str: str = response_bytes.decode()
-    response_data: Dict[str, Any] = json.loads(response_str)
-
-    if response_data['tag_name'] != release_tag:
-        print('Something went wrong...', file=sys.stderr)
-        print(response_str, file=sys.stderr)
-        sys.exit(1)
-
-    print(response_data['description'])
-
-
-if __name__ == '__main__':
-    main()

setup.py

@@ -12,7 +12,7 @@ setup(
     description='',
     license='MIT',
     keywords='ical,icalendar,timeseries,prometheus,grafana',
-    url='https://gitlab.com/s3lph/icalendar-timeseries-server',
+    url='https://git.kabelsalat.ch/s3lph/icalendar-timeseries-server',
     packages=find_packages(exclude=['*.test']),
     long_description='',
     python_requires='>=3.6',
@@ -23,6 +23,14 @@ setup(
         'isodate',
         'jinja2'
     ],
+    extras_require={
+        'test': [
+            'coverage',
+            'pycodestyle',
+            'mypy',
+            'twine'
+        ]
+    },
     entry_points={
         'console_scripts': [
             'icalendar-timeseries-server = icalendar_timeseries_server:main'