Develop

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/ci.yml

@@ -0,0 +1,96 @@
+name: CI
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-20.04
+    env:
+      SONAR_SCANNER_VERSION: 4.6.1.2450 # Find the latest version in the "Windows" link on this page:
+                                        # https://docs.sonarqube.org/latest/analysis/scan/sonarscanner/
+      SONAR_SERVER_URL: "https://sonarcloud.io"
+      BUILD_WRAPPER_OUT_DIR: build_wrapper_output_directory # Directory where build-wrapper output will be placed
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
+      - name: Set up JDK 11
+        uses: actions/setup-java@v1
+        with:
+          java-version: 11
+      - name: Cache SonarQube packages
+        uses: actions/cache@v1
+        with:
+          path: ~/.sonar/cache
+          key: ${{ runner.os }}-sonar
+          restore-keys: ${{ runner.os }}-sonar
+      - name: Download and set up sonar-scanner
+        env:
+          SONAR_SCANNER_DOWNLOAD_URL: https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-${{ env.SONAR_SCANNER_VERSION }}-linux.zip
+        run: |
+          mkdir -p $HOME/.sonar
+          curl -sSLo $HOME/.sonar/sonar-scanner.zip ${{ env.SONAR_SCANNER_DOWNLOAD_URL }} 
+          unzip -o $HOME/.sonar/sonar-scanner.zip -d $HOME/.sonar/
+          echo "$HOME/.sonar/sonar-scanner-${{ env.SONAR_SCANNER_VERSION }}-linux/bin" >> $GITHUB_PATH
+      - name: Download and set up build-wrapper
+        env:
+          BUILD_WRAPPER_DOWNLOAD_URL: ${{ env.SONAR_SERVER_URL }}/static/cpp/build-wrapper-linux-x86.zip
+        run: |
+          curl -sSLo $HOME/.sonar/build-wrapper-linux-x86.zip ${{ env.BUILD_WRAPPER_DOWNLOAD_URL }}
+          unzip -o $HOME/.sonar/build-wrapper-linux-x86.zip -d $HOME/.sonar/
+          echo "$HOME/.sonar/build-wrapper-linux-x86" >> $GITHUB_PATH     
+      - name: Download and install Fledge
+        env:
+          FLEDGE_REPO_URL: "https://github.com/fledge-iot/fledge/archive/refs/heads/develop.zip" 
+        run: |
+          curl -sSLo fledge-pkg.zip ${{ env.FLEDGE_REPO_URL }}
+          unzip -o fledge-pkg.zip -d $HOME
+          mv $HOME/fledge-develop $HOME/fledge
+          cd $HOME/fledge
+          sudo apt-get update
+          sudo apt-get install libcurl4-openssl-dev
+          sudo $HOME/fledge/requirements.sh
+          sudo make install
+          sudo mkdir -p /usr/include/fledge/rapidjson/
+          find $HOME/fledge/C/common/ -name '*.h' -exec sudo cp -prv '{}' '/usr/include/fledge/' ';'
+          find $HOME/fledge/C/plugins/ -name '*.h' -exec sudo cp -prv '{}' '/usr/include/fledge/' ';'
+          find $HOME/fledge/C/services/ -name '*.h' -exec sudo cp -prv '{}' '/usr/include/fledge/' ';'
+          find $HOME/fledge/C/tasks/ -name '*.h' -exec sudo cp -prv '{}' '/usr/include/fledge/' ';'
+          find $HOME/fledge/C/thirdparty/Simple-Web-Server/ -name '*.hpp' -exec sudo cp -prv '{}' '/usr/include/fledge/' ';'
+          sudo cp -prv $HOME/fledge/C/thirdparty/rapidjson/include/rapidjson/* /usr/include/fledge/rapidjson/
+          sudo mkdir -p /usr/lib/fledge/
+          sudo cp -prv /usr/local/fledge/lib/* /usr/lib/fledge/
+      - name: Download and install Google Unit Test framework
+        run: |
+          sudo apt-get install libgtest-dev
+          cd /usr/src/gtest
+          sudo cmake CMakeLists.txt
+          sudo make
+          sudo apt-get install libgmock-dev
+      - name: Download and install gcovr
+        run: |
+          sudo apt-get install gcovr
+      - name: Run build-wrapper
+        run: |
+          chmod +x mkversion
+          export LD_LIBRARY_PATH=/usr/lib:/usr/local/lib
+          mkdir build
+          cmake -S . -B build -DCMAKE_BUILD_TYPE=Coverage
+          build-wrapper-linux-x86-64 --out-dir ${{ env.BUILD_WRAPPER_OUT_DIR }} cmake --build build/ --config Release
+          cd build 
+          make
+          make hnz_pivot_filter_coverage_sonar
+      - name: Run sonar-scanner
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: |
+          sonar-scanner --define sonar.host.url="${{ env.SONAR_SERVER_URL }}" --define sonar.cfamily.build-wrapper-output="${{ env.BUILD_WRAPPER_OUT_DIR }}" --define sonar.organization="fledge-power" --define sonar.projectKey="fledge-power_fledgepower-filter-hnztopivot" --define sonar.inclusions="src/*,include/*" --define sonar.coverageReportPaths="build/hnz_pivot_filter_coverage_sonar-sonarqube.xml"

.github/workflows/publish.yml

@@ -0,0 +1,75 @@
+name: Publish
+
+# Controls when the workflow will run
+on:
+  push:
+    tags:        
+      - v*-rc* # publish only rc (release candidates), example: v1.0.0-rc0
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+env:
+  IMAGE_REGISTRY: ghcr.io
+  REGISTRY_USER: ${{ github.actor }}
+  REGISTRY_PASSWORD: ${{ secrets.GITHUB_TOKEN }}
+  FLEDGE_IMAGE_NAME: 'fledgepower/fledge_hnz'
+  FLEDGE_GUI_IMAGE_NAME: 'fledgepower/fledge-gui'
+  IMAGE_TAG: 'latest'
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      # Download and install Docker
+      - name: Download and install Docker
+        run: |
+          sudo apt-get update
+          sudo apt-get install \
+                  ca-certificates \
+                  curl \
+                  gnupg \
+                  lsb-release
+          curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
+          echo \
+              "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \
+              $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+          sudo apt-get update
+          sudo apt-get install docker-ce docker-ce-cli containerd.io
+
+      # Download fledgepower deployment
+      - name: Download fledgepower deployment
+        env: 
+          FP_DEPLOY_REPO: "https://github.com/fledge-power/fledgepower-deployment.git"
+        run: |
+          git clone ${{ env.FP_DEPLOY_REPO }}
+
+      # Log in to the Container registry ghcr.io
+      - name: Log in to the Container registry
+        uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
+        with:
+          registry: ${{ env.IMAGE_REGISTRY }}
+          username: ${{ env.REGISTRY_USER }}
+          password: ${{ env.REGISTRY_PASSWORD }}
+
+      # Build image
+      - name: Build images
+        run: |
+          cd ./fledgepower-deployment/sHNZ-n104-ubuntu2004/fledge/
+          sudo -E docker build -f fledge.dockerfile -t ${{ env.IMAGE_REGISTRY }}/${{ github.repository_owner }}/${{ env.FLEDGE_IMAGE_NAME }}:${{ env.IMAGE_TAG }} . --label ${{ github.ref }}
+          cd ../fledge-gui
+          sudo -E docker build -f fledge-gui.dockerfile -t ${{ env.IMAGE_REGISTRY }}/${{ github.repository_owner }}/${{ env.FLEDGE_GUI_IMAGE_NAME }}:${{ env.IMAGE_TAG }} . --label ${{ github.ref }}          
+
+      # Push to ghcr.io (Github Image Registry)
+      - name: Push images
+        run: |
+          sudo -E docker push ${{ env.IMAGE_REGISTRY }}/${{ github.repository_owner }}/${{ env.FLEDGE_IMAGE_NAME }}:${{ env.IMAGE_TAG }}
+          sudo -E docker push ${{ env.IMAGE_REGISTRY }}/${{ github.repository_owner }}/${{ env.FLEDGE_GUI_IMAGE_NAME }}:${{ env.IMAGE_TAG }}
+

.gitignore

@@ -30,3 +30,4 @@
 *.exe
 *.out
 *.app
+.vscode/

CMakeLists.txt

@@ -0,0 +1,117 @@
+cmake_minimum_required(VERSION 2.8)
+
+# Set the plugin name to build
+project(hnz_pivot_filter)
+
+# Supported options:
+# -DFLEDGE_INCLUDE
+# -DFLEDGE_LIB
+# -DFLEDGE_SRC
+# -DFLEDGE_INSTALL
+#
+# If no -D options are given and FLEDGE_ROOT environment variable is set
+# then Fledge libraries and header files are pulled from FLEDGE_ROOT path.
+
+list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake")
+
+message(STATUS ${CMAKE_CXX_FLAGS})
+
+if (${CMAKE_BUILD_TYPE} STREQUAL Coverage)
+  message("Coverage is going to be generated")
+  enable_testing()
+  add_subdirectory(tests)
+  include(CodeCoverage)
+  append_coverage_compiler_flags()
+  set(CMAKE_CXX_FLAGS  "${CMAKE_CXX_FLAGS} -O3 --coverage")
+  set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -O3 --coverage")
+  set(GCOVR_ADDITIONAL_ARGS "--exclude-unreachable-branches" "--exclude-throw-branches" )
+
+  setup_target_for_coverage_gcovr_sonar(NAME "${PROJECT_NAME}_coverage_sonar"
+                                      EXECUTABLE RunTests
+                                      DEPENDENCIES RunTests
+                                      BASE_DIRECTORY "${PROJECT_SOURCE_DIR}"
+                                      EXCLUDE "tests/*"
+  )  
+
+  setup_target_for_coverage_gcovr_html(NAME "${PROJECT_NAME}_coverage_html"
+                                       EXECUTABLE RunTests
+                                       DEPENDENCIES RunTests
+                                       BASE_DIRECTORY "${PROJECT_SOURCE_DIR}"
+                                       EXCLUDE "tests/*"
+  )
+else()
+  message("Build without Coverage") 
+
+  set(CMAKE_CXX_FLAGS "-std=c++11 -O3")
+endif()
+
+set(CMAKE_CXX_FLAGS_DEBUG "-O0 -ggdb")
+
+# Generation version header file
+set_source_files_properties(version.h PROPERTIES GENERATED TRUE)
+add_custom_command(
+  OUTPUT version.h
+  DEPENDS ${CMAKE_SOURCE_DIR}/VERSION
+  COMMAND ${CMAKE_SOURCE_DIR}/mkversion ${CMAKE_SOURCE_DIR}
+  COMMENT "Generating version header"
+  VERBATIM
+)
+include_directories(${CMAKE_BINARY_DIR})
+
+
+# Set plugin type (south, north, filter)
+set(PLUGIN_TYPE "filter")
+# Add here all needed Fledge libraries as list
+set(NEEDED_FLEDGE_LIBS common-lib filters-common-lib)
+
+# Find source files
+file(GLOB SOURCES src/*.cpp)
+
+# Find Fledge includes and libs, by including FindFledge.cmak file
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_CURRENT_SOURCE_DIR})
+find_package(Fledge)
+# If errors: make clean and remove Makefile
+if (NOT FLEDGE_FOUND)
+	if (EXISTS "${CMAKE_BINARY_DIR}/Makefile")
+		execute_process(COMMAND make clean WORKING_DIRECTORY ${CMAKE_BINARY_DIR})
+		file(REMOVE "${CMAKE_BINARY_DIR}/Makefile")
+	endif()
+	# Stop the build process
+	message(FATAL_ERROR "Fledge plugin '${PROJECT_NAME}' build error.")
+endif()
+# On success, FLEDGE_INCLUDE_DIRS and FLEDGE_LIB_DIRS variables are set 
+
+
+# Add ./include
+include_directories(include)
+# Add Fledge include dir(s)
+include_directories(${FLEDGE_INCLUDE_DIRS})
+
+# Add Fledge lib path
+link_directories(${FLEDGE_LIB_DIRS})
+# Create shared library
+
+if (FLEDGE_SRC)
+	message(STATUS "Using third-party includes " ${FLEDGE_SRC}/C/thirdparty)
+	include_directories(${FLEDGE_SRC}/C/thirdparty/rapidjson/include)
+endif()
+
+
+# Create shared library
+add_library(${PROJECT_NAME} SHARED ${SOURCES} version.h)
+
+# Add Fledge library names
+target_link_libraries(${PROJECT_NAME} ${NEEDED_FLEDGE_LIBS})
+
+# Add additional libraries
+target_link_libraries(${PROJECT_NAME} -lpthread -ldl)
+
+# Set the build version 
+set_target_properties(${PROJECT_NAME} PROPERTIES SOVERSION 1)
+
+set(FLEDGE_INSTALL "" CACHE INTERNAL "")
+# Install library
+if (FLEDGE_INSTALL)
+	message(STATUS "Installing ${PROJECT_NAME} in ${FLEDGE_INSTALL}/plugins/${PLUGIN_TYPE}/${PROJECT_NAME}")
+	install(TARGETS ${PROJECT_NAME} DESTINATION ${FLEDGE_INSTALL}/plugins/${PLUGIN_TYPE}/${PROJECT_NAME})
+endif()