Merge pull request 'chore(deps): update dependency docker/metadata-action to v5.6.1' (#106) from renovate/docker-metadata-action-5.x into master

Reviewed-on: #106

.gitea/workflows/semantic-release.yaml

@@ -0,0 +1,64 @@
+name: ci
+
+on:
+  schedule:
+    - cron: "0 10 * * *"
+  push:
+    branches:
+      - "**"
+    tags:
+      - "v*.*.*"
+  pull_request:
+    branches:
+      - "main"
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4.2.2
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5.6.1
+        with:
+          # list of Docker images to use as base name for tags
+          images: |
+            harbor.evanshome.io/library/py-eagle-mqtt       
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{raw}}
+            type=semver,pattern={{version}}
+            type=sha            
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3.9.0
+      - name: Login to Harbor
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3.3.0
+        with:
+          registry: harbor.evanshome.io
+          username: ${{ secrets.HARBOR_USERNAME }}
+          password: ${{ secrets.HARBOR_PASSWORD }}
+
+      - name: echo new tag
+        run: |
+          echo "${{ steps.meta.outputs.tags }}"        
+        
+
+      # - name: Build and push
+      #   uses: docker/build-push-action@v6.9.0
+      #   with:
+      #     context: ./Docker/
+      #     push: ${{ github.event_name != 'pull_request' }}
+      #     tags: ${{ steps.meta.outputs.tags }}
+      #     labels: ${{ steps.meta.outputs.labels }}
+
+
+
+
+
+
+

.gitea/workflows/tag-release.yaml

@@ -0,0 +1,61 @@
+name: Bump version
+on:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - master
+
+jobs:
+  create_release_tag:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4.2.2
+        with:
+          ref: ${{ github.event.pull_request.merge_commit_sha }}
+          fetch-depth: '0'
+      
+      - name: Create Release Tag
+        id: taggerFinal
+        uses: anothrNick/github-tag-action@1.71.0
+        with:
+         GITHUB_TOKEN: ${{ secrets.REPO_PUSH_TOKEN }}
+         WITH_V: true
+         GIT_API_TAGGING: false
+         DEFAULT_BUMP: patch
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5.6.1
+        with:
+          # list of Docker images to use as base name for tags
+          images: |
+            harbor.evanshome.io/library/py-eagle-mqtt       
+          # generate Docker tags based on the following events/attributes
+          flavor: |
+            latest=true
+          tags: |
+            type=schedule
+            type=ref,event=branch
+            type=ref,event=pr
+            type=raw,value=${{ steps.taggerFinal.outputs.new_tag }}
+            type=semver,pattern={{raw}}
+            type=semver,pattern={{version}}
+            type=sha            
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3.9.0
+      - name: Login to Harbor
+        uses: docker/login-action@v3.3.0
+        with:
+          registry: harbor.evanshome.io
+          username: ${{ secrets.HARBOR_USERNAME }}
+          password: ${{ secrets.HARBOR_PASSWORD }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v6.9.0
+        with:
+          context: ./Docker/
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.gitlab-ci.yml

@@ -4,63 +4,77 @@
 # See https://docs.gitlab.com/ee/ci/variables/#priority-of-environment-variables
 
 stages:
-- test
+#- test
 - build
+- release
 - push_local
-- push_dockerhub
-
-.docker_base:
-  image: docker:18.09.7-dind
-  services:
-    - docker:18.09.7-dind
-  variables:
-    DOCKER_DRIVER: overlay
-    DOCKER_HOST: tcp://localhost:2375/
-    IMAGE_TAG: "$CI_REGISTRY_IMAGE:$CI_COMMIT_REF_SLUG"
-    FF_GITLAB_REGISTRY_HELPER_IMAGE: 1
-  before_script:
-    - docker version
-    - docker info
-    - docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY
+##- push_dockerhub
 
 build:
-  extends:
-    - .docker_base
+  image: docker:27.4.0-dind
   stage: build
+  only:
+    refs:
+    - tags
+    - branches
+  services:
+    -  name: docker:27.4.0-dind
+       command: ["--tls=false"]
+  variables:
+    DOCKER_DRIVER: overlay2
+    DOCKER_HOST: tcp://docker:2375
+    DOCKER_TLS_CERTDIR: ""
+    FF_GITLAB_REGISTRY_HELPER_IMAGE: 1
   script:
-  - docker build --tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA ./Docker/
-  - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
+    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
+    - docker build -t $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA --build-arg BUILD_DATE=$(date -u +'%Y-%m-%dT%H:%M:%SZ') --build-arg VCS_REF=$CI_COMMIT_SHORT_SHA ./Docker/
+    - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
+
+release:
+  image: node:22.12.0-alpine3.19
+  stage: release
+  only:
+    refs:
+    - master
+    - alpha
+    # This matches maintenance branches
+    - /^(([0-9]+)\.)?([0-9]+)\.x/
+    # This matches pre-releases
+    - /^([0-9]+)\.([0-9]+)\.([0-9]+)(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z-]+)?$/ 
+  except:
+    refs:
+      - tags
+  script:
+    - touch CHANGELOG.md
+    - apk add --no-cache git
+    - git config user.email "ci-bot@evanshome.io"
+    - git config user.name "ci-bot"
+    - npm install @semantic-release/gitlab@12.1.1 @semantic-release/changelog@6.0.3
+      @semantic-release/git@10.0.1 conventional-changelog-eslint@5.0.0
+    - npx semantic-release
+  artifacts:
+    paths:
+    - CHANGELOG.md
 
 push local:
-  extends:
-    - .docker_base
+  image: docker:27.4.0-dind
   stage: push_local
+  services:
+    -  name: docker:27.4.0-dind
+       command: ["--tls=false"]
   variables:
+    DOCKER_DRIVER: overlay2
+    DOCKER_HOST: tcp://docker:2375
+    DOCKER_TLS_CERTDIR: ""
     GIT_STRATEGY: none
+    FF_GITLAB_REGISTRY_HELPER_IMAGE: 1
   only:
   - master
   script:
-  - docker pull $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
-  - docker tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA $CI_REGISTRY_IMAGE:latest
-  - docker push $CI_REGISTRY_IMAGE:latest
+    - echo $CI_COMMIT_TAG
+    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
+    - docker pull $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
+    - docker tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA $CI_REGISTRY_IMAGE:latest
+    - docker push $CI_REGISTRY_IMAGE:latest
 
-push dockerhub:
-  extends:
-    - .docker_base
-  stage: push_dockerhub
-  variables:
-    GIT_STRATEGY: none
-    CI_DOCKERHUB_IMAGE: index.docker.io/evanrich/py-eagle-mqtt
-    CI_DOCKERHUB_REGISTRY: docker.io
-  only:
-  - master
-  script:
-  - docker pull $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
-  - docker tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA $CI_DOCKERHUB_IMAGE:latest
-  - docker login -u "$CI_DOCKERHUB_USER" -p "$CI_DOCKERHUB_PASSWORD" $CI_DOCKERHUB_REGISTRY
-  - docker push $CI_DOCKERHUB_IMAGE:latest
   
-sast:
-  stage: test
-include:
-- template: Security/SAST.gitlab-ci.yml

.releaserc.yml

@@ -0,0 +1,45 @@
+plugins:
+  - - "@semantic-release/commit-analyzer"
+    - preset: eslint
+      releaseRules:
+      - tag: Breaking
+        release: major
+      - tag: Build
+        release: patch
+      - tag: Chore
+        release: minor
+      - tag: Fix
+        release: patch
+      - tag: New
+        release: minor
+      - tag: Update
+        release: minor
+      - tag: Upgrade
+        release: minor
+  - - "@semantic-release/release-notes-generator"
+    - preset: eslint
+      releaseRules:
+      - tag: Breaking
+        release: major
+      - tag: Build
+        release: patch
+      - tag: Chore
+        release: minor
+      - tag: Fix
+        release: patch
+      - tag: New
+        release: minor
+      - tag: Update
+        release: minor
+      - tag: Upgrade
+        release: minor
+  - - "@semantic-release/changelog"
+    - changelogFile: CHANGELOG.md
+  - "@semantic-release/gitlab"
+  - - "@semantic-release/git"
+    - assets: CHANGELOG.md
+branches:
+  - "master"
+  - "+([0-9])?(.{+([0-9]),x}).x"
+  - name: "alpha"
+    prerelease: "alpha"

CHANGELOG.md

@@ -0,0 +1,133 @@
+## [1.7.10](https://gitlab.evanshome.io/erichardson/py-eagle-mqtt/compare/v1.7.9...v1.7.10) (2023-12-03)
+
+
+### Build
+
+* fix build pipeline order ([1cf67d1](https://gitlab.evanshome.io/erichardson/py-eagle-mqtt/commit/1cf67d139b8ce3954a42afeeef49262c72d9b0a5))
+
+### CI
+
+* add branches to refs for building ([e0da9b1](https://gitlab.evanshome.io/erichardson/py-eagle-mqtt/commit/e0da9b110e69fc4f18f6588d297589ca71a27c08))
+* Add push latest tag on master ([8e6130d](https://gitlab.evanshome.io/erichardson/py-eagle-mqtt/commit/8e6130d9195c19933054d9a4efbeeb3d025b5301))
+* fix ordering of stages ([385c1d8](https://gitlab.evanshome.io/erichardson/py-eagle-mqtt/commit/385c1d88d85e64591fd0d3814111a7e335ea45f8))
+
+## [1.7.9](https://gitlab.evanshome.io/erichardson/py-eagle-mqtt/compare/v1.7.8...v1.7.9) (2023-12-03)
+
+
+### Build
+
+* bump docker base to python:3.12-alpine ([6489f3d](https://gitlab.evanshome.io/erichardson/py-eagle-mqtt/commit/6489f3d01a71fba8e1a4ac35de2b0bffdf2529bd))
+
+## [1.7.8](https://gitlab.evanshome.io/erichardson/py-eagle-mqtt/compare/v1.7.7...v1.7.8) (2023-12-03)
+
+
+### ci
+
+* fix semantic versioning and docker push to local registry ([9ce6bb5](https://gitlab.evanshome.io/erichardson/py-eagle-mqtt/commit/9ce6bb579847fba7fd31cc7ece4bcbb0661247b8))
+
+### Fix
+
+* semantic versioning and docker push to local registry ([08069d6](https://gitlab.evanshome.io/erichardson/py-eagle-mqtt/commit/08069d61d135eff8c2ee5b210279589c4e4eed8f))
+
+## [1.7.6](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/compare/v1.7.5...v1.7.6) (2021-05-10)
+
+
+### Build
+
+* Change docker driver to overlay2 ([13cb517](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/commit/13cb51706b97f25486f62dd6985903e834d28ee2))
+
+## [1.7.5](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/compare/v1.7.4...v1.7.5) (2021-05-09)
+
+
+### Build
+
+* push all tags instead of just latest ([b143379](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/commit/b143379f2018f410677a9646234e7b483d9277d3))
+
+## [1.7.4](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/compare/v1.7.3...v1.7.4) (2021-05-09)
+
+
+### Build
+
+* cleanup long install line ([de1d073](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/commit/de1d073c6daf5d43fb7d9b7dafddd3b0cbcffc9b))
+
+### ci
+
+* Add git to node image ([6eb2d01](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/commit/6eb2d0145eff50c3243a364d821e769ae2ee06c9))
+* change semantic release image to alpine to save space, updated to node 16 ([b1ca049](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/commit/b1ca0497b0b51e0c50ca1e5f99e5c8abd4224d53))
+* Update DinD base to 20.10.6 and semantic release to node:15.  Also pin sonar-scanner-cli to 4.6 ([589fb4f](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/commit/589fb4fcf7841d3c5f08327d7fb5d5c107562ed6))
+
+## [1.7.3](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/compare/v1.7.2...v1.7.3) (2021-04-12)
+
+
+### Bug Fixes
+
+* Empty commit to get recent changes into build (last commit should've been labeled this) ([e513752](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/commit/e513752c46cc0b3beb93530f6549661d67196905))
+
+## [1.7.2](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/compare/v1.7.1...v1.7.2) (2021-04-08)
+
+
+### Bug Fixes
+
+* Cleanup CHANGELOG.md since using new semantic-release format ([a72ac7a](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/commit/a72ac7a1df91cb2231e38e8bbceb5ccf9c93328a))
+* fix asset info for git commit ([00c95c4](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/commit/00c95c42ea98921a1b2da9d2069d41e8e32f34f5))
+
+## [1.7.1](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/compare/v1.7.0...v1.7.1) (2021-04-08)
+
+
+### Bug Fixes
+
+* refactor Dockerfile to improve build ([40ac8c5](https://gitlab.evanrichardsonphotography.com/erichardson/py-eagle-mqtt/commit/40ac8c5ada9b993f53b72dcc14b2d9b7cd183e2f))
+
+## [1.6.10] - 2021-04-06
+
+### Fixed
+
+- Fix docker tagging issue
+
+## [1.6.9] - 2021-04-06
+
+### Fixed
+
+- Remove release-cli section of CI file
+- Add updated README.md
+
+## [1.6.8] - 2021-04-06
+
+### Changed
+
+- Fixed slight issue with tagging
+
+## [1.6.7] - 2021-04-06
+
+### Changed
+
+- Updated base image to Python 3.9.4-alpine3.13
+- Moved changes to this file
+
+### Removed
+
+- Changelog from README.md
+
+## [1.6.6] - 2021-04-03
+
+### Added
+
+- Added CI/CD pipeline to project
+
+### Changed
+
+- Moved project to my own personal Gitlab server for CI/CD pipelines as well as to run security scans on the container image and code
+
+- Updated base image to Python 3.9.3-alpine3.12
+
+## [Unversioned history]
+
+- 2019-07-24: Rebase to python 3.7.4-alpine3.10, update bottle to 0.12.17
+
+- 2019-04-12: Rebase to python 3.7.3-alpine3.9
+
+- 2019-03-08: Rebase to python 3.7.2-alpine3.9, update bottle and astral versions to latest
+
+- 2019-01-03: Rebase to python 3.7.2-alpine3.8, changed logging level to Info (should output to /var/log/tHome/eagle.log)
+
+- 2018-09-10: Ported to Python3, Added pricing info.  Merged into master branch

Docker/Dockerfile

@@ -1,17 +1,33 @@
-FROM python:3.9.3-alpine3.12
-
+FROM python:3.13-alpine
 LABEL maintainer="Evan Richardson (evanrich81[at]gmail.com)"
-LABEL version="1.6.6"
+
+ARG BUILD_DATE
+ARG VCS_REF
+
+LABEL org.label-schema.schema-version="1.0"
+LABEL org.label-schema.build-date=$BUILD_DATE
+LABEL org.label-schema.name="evanrich/py-eagle-mqtt"
+LABEL org.label-schema.description="Python Rainforest Eagle to MQTT Application"
+LABEL org.label-schema.vcs-url="https://github.com/evanrich/py-eagle-mqtt"
+LABEL org.label-schema.vcs-ref=$VCS_REF
+LABEL org.label-schema.vendor="Evan Richardson"
+LABEL org.label-schema.docker.cmd="docker run --name=py-eagle-mqtt -e MQTT_BROKER_IP=<IP> -e MQTT_BROKER_PORT=1883 -p 22042:22042 -d evanrich/py-eagle-mqtt"
 
 WORKDIR /app
-COPY . /app
-COPY ./src/conf/logrotate/tHome /etc/logrotate.d/
-ENV PYTHONPATH=/app/src/python
-RUN apk --update add --no-cache logrotate \
-&& pip3 install --no-cache-dir  --upgrade pip \
-&& pip3 install --no-cache-dir -r requirements.txt
-#RUN rm -rf /var/cache/apk
 
-CMD ["/app/src/bin/tHome-eagle.py", "-c", "/app/src/conf"]
+COPY requirements.txt /app
+COPY ./src/conf/logrotate/tHome /etc/logrotate.d/
+
+ENV PYTHONPATH=/app/src/python
+
+RUN apk --update add --no-cache logrotate && \
+    apk upgrade && \
+    pip3 install --no-cache-dir --upgrade pip && \
+    pip3 install --no-cache-dir -r requirements.txt && \
+    rm -rf /var/cache/apk/*
+
+COPY . /app
+
+CMD ["python3", "-u", "/app/src/bin/tHome-eagle.py", "-c", "/app/src/conf", "-l", "stdout"]
 
 EXPOSE 22042

Docker/requirements.txt

@@ -1,4 +1,3 @@
-astral==2.2
-paho-mqtt==1.5.1
-bottle==0.12.19
+paho-mqtt==2.1.0
+bottle==0.13.2
 defusedxml==0.7.1

Docker/src/bin/dbg-msgHub.py

@@ -26,7 +26,7 @@ class Client ( mqtt.Client ):
       self.on_connect = Client.on_connect
       self.on_message = Client.on_message
       
-   def on_connect( self, userData, flags, rc ):
+   def on_connect( self, userdata, flags, reason_code, properties ):
       self.subscribe( '#' )
 
    def on_message( self, userData, msg ):
@@ -62,4 +62,4 @@ client.loop_start()
 while True:
    pass
 
-client.loop_stop( force=True )
+client.loop_stop()

Docker/src/python/tHome/broker/connect.py

@@ -7,11 +7,11 @@ from . import config
 import paho.mqtt.client as mqtt
 
 #===========================================================================
-class Client( mqtt.Client ):
+class Client(  mqtt.Client ):
    """Logging client
    """
    def __init__( self, log=None ):
-      mqtt.Client.__init__( self )
+      mqtt.Client.__init__( self, mqtt.CallbackAPIVersion.VERSION2 )
       self._logger = log
       # Restore callbacks overwritten by stupid mqtt library
       self.on_log = Client.on_log

Docker/src/python/tHome/util/fimport.py

@@ -3,8 +3,9 @@
 # Arbitrary file importing utility.  Does NOT modify sys.modules
 #
 #===========================================================================
-import imp
+#import importlib
 import os
+import types
 
 def fimport( filePath ):
    # Read the file and compile the code.  This will fail if the file
@@ -19,7 +20,7 @@ def fimport( filePath ):
    rootName, ext = os.path.splitext( fileName )
 
    # Create a new module and exec the code in it's context.  
-   m = imp.new_module( rootName )
+   m = types.ModuleType( rootName )
    m.__file__ = absPath
    exec(code, m.__dict__)
 

README.md

@@ -1,22 +1,20 @@
 # py-eagle-mqtt
+
 Python3 based Docker for Eagle to MQTT reader
 
-I have only ported this into a dockerfile, All Original code (with one minor modification for XML root tag) is credit to [Ted Drain - TD22057](https://github.com/TD22057/T-Home).
+I have only ported this into a dockerfile, as well as made some changes to code for security or other purposes. All Original code is credit to [Ted Drain - TD22057](https://github.com/TD22057/T-Home).
+
+This project utilizes the following tools:
+
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/evanrich/py-eagle-mqtt)]()
+[![Gitlab pipeline status (self-hosted)](https://img.shields.io/gitlab/pipeline/erichardson/py-eagle-mqtt/master?gitlab_url=https%3A%2F%2Fgitlab.evanrichardsonphotography.com)]()
+[![Docker Pulls](https://img.shields.io/docker/pulls/evanrich/py-eagle-mqtt)]()
+[![Docker Image Version (latest by date)](https://img.shields.io/docker/v/evanrich/py-eagle-mqtt)]()
 
 ## UPDATES:
 
-2020-04-03: I've moved the repo to my private Gitlab server, with a mirror set up to github.  I did this so that I could easily integrate a CI/CD pipeline to build this image, as well as run some Security tools against the image to improve it's code quality.   Please continue to open bug reports/issues/pull requests here in Github.  Also swapped to defusedxml python module due to security issues around xmltree.  Forgot to incrememnt the build number, but docker container  latest is up-to-date.
-   
-2019-07-24: Rebase to python 3.7.4-alpine3.10, update bottle to 0.12.17
-
-2019-04-12: Rebase to python 3.7.3-alpine3.9
-
-2019-03-08: Rebase to python 3.7.2-alpine3.9, update bottle and astral versions to latest
-
-2019-01-03: Rebase to python 3.7.2-alpine3.8, changed logging level to Info (should output to /var/log/tHome/eagle.log)
-
-2018-09-10: Ported to Python3, Added pricing info.  Merged into master branch
-
+2020-04-06: Moved Updates to a CHANGELOG.md file to clean this up.
 
 ## Usage
 

renovate.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base",
+    ":semanticCommits"
+  ],
+  "prConcurrentLimit": 5,
+  "labels": [
+      "upgrade", 
+      "bot"
+    ]
+}

sonar-project.properties

@@ -0,0 +1,3 @@
+sonar.projectKey=erichardson_py-eagle-mqtt_AXkgI9tRLcemhRz3NCjo
+sonar.qualitygate.wait=true
+sonar.projectBaseDir=Docker/src