Add networking block

.gitlab-ci.yml

@@ -4,30 +4,74 @@
 # See https://docs.gitlab.com/ee/ci/variables/#priority-of-environment-variables
 
 stages:
-#- test
+- test
 - build
-#- push_local
+- push_local
 - release
-#- push_dockerhub
+- 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
 
 build:
-  image: docker:24.0.7-dind
+  extends:
+    - .docker_base
   stage: build
-  services:
-    -  name: docker:24.0.7-dind
-       command: ["--tls=false"]
-  variables:
-    DOCKER_DRIVER: overlay2
-    DOCKER_HOST: tcp://docker:2375
-    DOCKER_TLS_CERTDIR: ""
-    FF_GITLAB_REGISTRY_HELPER_IMAGE: 1
   script:
-    - 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
+  - docker pull $CI_REGISTRY_IMAGE:latest || true
+  - >
+    docker build
+    --pull
+    --cache-from $CI_REGISTRY_IMAGE:latest
+    --tag $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
+
+push local:
+  extends:
+    - .docker_base
+  stage: push_local
+  variables:
+    GIT_STRATEGY: none
+  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
+
+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:
+  - tags
+  script:
+  - docker pull $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
+  - docker tag $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA $CI_DOCKERHUB_IMAGE:$CI_COMMIT_REF_NAME 
+  - 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
 
 release:
-  image: node:20.10.0-alpine3.18
+  image: node:13
   stage: release
   only:
     refs:
@@ -37,17 +81,32 @@ release:
     - /^(([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
+    - npm install @semantic-release/gitlab @semantic-release/changelog @semantic-release/git
     - npx semantic-release
   artifacts:
     paths:
     - CHANGELOG.md
+
+sast:
+  stage: test
+include:
+- template: Security/SAST.gitlab-ci.yml
+
+sonarqube-check:
+  image: 
+    name: sonarsource/sonar-scanner-cli:latest
+    entrypoint: [""]
+  variables:
+    SONAR_USER_HOME: "${CI_PROJECT_DIR}/.sonar"  # Defines the location of the analysis task cache
+    GIT_DEPTH: "0"  # Tells git to fetch all the branches of the project, required by the analysis task
+  cache:
+    key: "${CI_JOB_NAME}"
+    paths:
+      - .sonar/cache
+  script: 
+    - sonar-scanner
+  allow_failure: true
+  only:
+    - master # or the name of your main branch

.releaserc.yml

@@ -1,38 +1,6 @@
 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/commit-analyzer"
+  - "@semantic-release/release-notes-generator"
   - - "@semantic-release/changelog"
     - changelogFile: CHANGELOG.md
   - "@semantic-release/gitlab"

CHANGELOG.md

@@ -1,48 +1,3 @@
-## [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)
 
 

Docker/Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.12-alpine
+FROM python:3.9.4-alpine3.13
 LABEL maintainer="Evan Richardson (evanrich81[at]gmail.com)"
 
 ARG BUILD_DATE

Docker/requirements.txt

@@ -1,3 +1,3 @@
-paho-mqtt==1.6.1
-bottle==0.12.25
+paho-mqtt==1.5.1
+bottle==0.12.19
 defusedxml==0.7.1

Docker/src/bin/tHome-eagle.py

@@ -1,10 +1,10 @@
 #!/usr/bin/env python3
 
-#===========================================================================
+# ===========================================================================
 #
 # Eagle posting server 
 #
-#===========================================================================
+# ===========================================================================
 
 __doc__ = """
 Starts a small web server.  The Rain Forest Eagle is configured with
@@ -22,100 +22,116 @@ import json
 import bottle as B
 import tHome as T
 
-#===========================================================================
-def meter( client, data, cfg ):
-   msg = {
-      "time" : data.TimeUnix,
-      "consumed" : data.Consumed, # kWh
-      "produced" : data.Produced, # kWh
-      }
 
-   return ( cfg.mqttEnergy, msg )
+# ===========================================================================
+def meter(client, data, cfg):
+    msg = {
+        "time": data.TimeUnix,
+        "consumed": data.Consumed,  # kWh
+        "produced": data.Produced,  # kWh
+    }
 
-#===========================================================================
-def instant( client, data, cfg ):
-   msg = {
-      "time" : data.TimeUnix,
-      "power" : data.Power * 1000, # W
-      }
+    return cfg.mqttEnergy, msg
 
-   return ( cfg.mqttPower, msg )
-   
-#===========================================================================
-def price( client, data, cfg ):
-   msg = {
-      "time" : data.TimeUnix,
-      "price" : data.Price,
-      "tier" : data.Tier,
-      }
-   return ( cfg.mqttPrice, msg )
 
-#===========================================================================
+# ===========================================================================
+def instant(client, data, cfg):
+    msg = {
+        "time": data.TimeUnix,
+        "power": data.Power * 1000,  # W
+    }
+
+    return cfg.mqttPower, msg
+
+
+# ===========================================================================
+def price(client, data, cfg):
+    msg = {
+        "time": data.TimeUnix,
+        "price": data.Price,
+        "tier": data.Tier,
+    }
+    return cfg.mqttPrice, msg
+
+
+# ===========================================================================
+def network(client, data, cfg):
+    msg = {
+        "status": data.Status,
+        "description": data.Description,
+        "linkstrength": data.LinkStrength
+    }
+    return cfg.mqttNetwork, msg
+
+
+# ===========================================================================
 handlers = {
-   #"BlockPriceDetail" : 
-   "CurrentSummation" : meter,
-   #"DeviceInfo" : 
-   #"FastPollStatus" : 
-   "InstantaneousDemand" : instant,
-   #"MessageCluster" : 
-   #"MeterInfo" : 
-   #"NetworkInfo" : 
-   "PriceCluster" : price,
-   #"Reading" : 
-   #"ScheduleInfo" :
-   #"TimeCluster" : 
-   }
+    # "BlockPriceDetail" :
+    "CurrentSummation": meter,
+    # "DeviceInfo" :
+    # "FastPollStatus" :
+    "InstantaneousDemand": instant,
+    # "MessageCluster" :
+    # "MeterInfo" :
+    "NetworkInfo": network,
+    "PriceCluster": price,
+    # "Reading" :
+    # "ScheduleInfo" :
+    # "TimeCluster" :
+}
 
-#===========================================================================
 
-@B.post( '/' )
+# ===========================================================================
+
+@B.post('/')
 def root_post():
-   data = B.request.body.read( B.request.content_length )
-   try:
-      obj = T.eagle.parse( data )
-   except:
-      log.exception( "Error parsing Eagle posted data" )
-      return "ERROR"
+    data = B.request.body.read(B.request.content_length)
+    try:
+        obj = T.eagle.parse(data)
+    except:
+        log.exception("Error parsing Eagle posted data")
+        return "ERROR"
 
-   log.info( "Read packet: %s" % obj.name )
-   
-   func = handlers.get( obj.name, None )
-   if func:
-      topic, msg = func( client, obj, cfg )
-      if msg:
-         log.info( "Publish: %s: %s" % ( topic, msg ) )
-         
-         payload = json.dumps( msg )
-         client.publish( topic, payload )
+    log.info("Read packet: %s" % obj.name)
 
-   return "ok"
+    func = handlers.get(obj.name, None)
+    if func:
+        topic, msg = func(client, obj, cfg)
+        if msg:
+            log.info("Publish: %s: %s" % (topic, msg))
 
-#===========================================================================
+            payload = json.dumps(msg)
+            client.publish(topic, payload)
+
+    return "ok"
+
+
+# ===========================================================================
 #
 # Main applications script
 #
-#===========================================================================
+# ===========================================================================
 
-p = argparse.ArgumentParser( prog=sys.argv[0],
-                             description="T-Home Eagle Server" )
-p.add_argument( "-c", "--configDir", metavar="configDir",
-                default="/etc/tHome",
-                help="Configuration file directory." )
-p.add_argument( "-l", "--log", metavar="logFile",
-                default=None, help="Logging file to use.  Input 'stdout' "
-                "to log to the screen." )
-c = p.parse_args( sys.argv[1:] )
+p = argparse.ArgumentParser(prog=sys.argv[0],
+                            description="T-Home Eagle Server")
+p.add_argument("-c", "--configDir", metavar="configDir",
+               default="/etc/tHome",
+               help="Configuration file directory.")
+p.add_argument("-l", "--log", metavar="logFile",
+               default=None, help="Logging file to use.  Input 'stdout' "
+                                  "to log to the screen.")
+c = p.parse_args(sys.argv[1:])
 
 # Parse the eagle config file.
-cfg = T.eagle.config.parse( c.configDir )
-log = T.eagle.config.log( cfg, c.log )
+cfg = T.eagle.config.parse(c.configDir)
+log = T.eagle.config.log(cfg, c.log)
 
 # Create the MQTT client and connect it to the broker.
-client = T.broker.connect( c.configDir, log )
+client = T.broker.connect(c.configDir, log)
 
 # Start the MQTT as a background thread. This way we can run the web
 # server as the main thread here.
 client.loop_start()
 
-log.info( "Starting web server at port %d" % cfg.httpPort )
-B.run( host='0.0.0.0', port=cfg.httpPort, quiet=True )
+log.info("Starting web server at port %d" % cfg.httpPort)
+B.run(host='0.0.0.0', port=cfg.httpPort, quiet=True)

Docker/src/conf/eagle.py

@@ -23,6 +23,9 @@ mqttPrice = 'power/elec/Home/price'
 #Current rate label (returns rate label from meter)
 mqttRateLabel = 'power/elec/Home/ratelabel'
 
+#Network Info Topic (returns status, description and link strength from meter)
+mqttNetwork = 'power/elec/Home/network'
+
 #===========================================================================
 #
 # Logging configuration.  Env variables are allowed in the file name.

renovate.json

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