Merge pull request #13 from Mazurel/Cmake-multi-platform-CI

Mazurel · web-flow · commit bc6f5fe09787 · 2024-10-21T20:07:41.000+02:00
Basic CI Support
diff --git a/.github/workflows/cmake-multi-platform.yml b/.github/workflows/cmake-multi-platform.yml
@@ -0,0 +1,77 @@
+name: CMake on multiple platforms
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      # Set fail-fast to false to ensure that feedback is delivered for all matrix combinations.
+      fail-fast: false
+
+      # Currently supported:
+      # - Linux + GCC
+      # - Linux + CLANG
+      # Planned:
+      # - Windows + CL
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        build_type: [Release]
+        c_compiler: [gcc, clang, cl]
+        include:
+          - os: ubuntu-latest
+            c_compiler: gcc
+            cpp_compiler: g++
+          - os: ubuntu-latest
+            c_compiler: clang
+            cpp_compiler: clang++
+        exclude:
+          - os: windows-latest
+            c_compiler: cl
+          - os: windows-latest
+            c_compiler: gcc
+          - os: windows-latest
+            c_compiler: clang
+          - os: ubuntu-latest
+            c_compiler: cl
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: "recursive"
+          fetch-depth: 1
+
+      # Dependecies needed only for Linux - Modbus Communication
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libnet1-dev
+        if: matrix.os == 'ubuntu-latest'
+
+      - name: Set reusable strings
+        id: strings
+        shell: bash
+        run: |
+          echo "build-output-dir=${{ github.workspace }}/build" >> "$GITHUB_OUTPUT"
+
+      - name: Configure CMake
+        run: >
+          cmake -B ${{ steps.strings.outputs.build-output-dir }}
+          -DCMAKE_CXX_COMPILER=${{ matrix.cpp_compiler }}
+          -DCMAKE_C_COMPILER=${{ matrix.c_compiler }}
+          -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
+          -DMODBUS_EXAMPLE=ON
+          -DMODBUS_TESTS=ON
+          -DMODBUS_COMMUNICATION=${{ matrix.os == 'windows-latest' && 'OFF' || matrix.os == 'ubuntu-latest' && 'ON' }}
+          -S ${{ github.workspace }}
+
+      - name: Build
+        run: cmake --build ${{ steps.strings.outputs.build-output-dir }} --config ${{ matrix.build_type }}
+
+      - name: Test
+        run: ${{ steps.strings.outputs.build-output-dir }}/tests/Google_Tests_run
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -3,7 +3,11 @@ project(protocolConverter)
 
 set(CMAKE_CXX_STANDARD 17)
 
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -Werror -pedantic")
+if (MSVC)
+    add_compile_options(/W3)
+else()
+    add_compile_options(-Wall -Wextra -Werror -pedantic)
+endif()
 
 option(MODBUS_EXAMPLE "Build example program" OFF)
 option(MODBUS_TESTS "Build tests" OFF)
diff --git a/include/MB/modbusRequest.hpp b/include/MB/modbusRequest.hpp
@@ -71,7 +71,7 @@ class ModbusRequest {
     }
 
     /**
-     * Simple constructor, that allows to create "dummy" ModbusResponse
+     * Simple constructor, that allows to create "dummy" ModbusRequest
      * object. May be useful in some cases.
      */
     explicit ModbusRequest(
@@ -80,7 +80,15 @@ class ModbusRequest {
         uint16_t address = 0, uint16_t registersNumber = 0,
         std::vector<ModbusCell> values = {}) noexcept;
 
-    ModbusRequest(const ModbusRequest &) = default;
+    /**
+    * Copy constructor for the response.
+    */
+    ModbusRequest(const ModbusRequest&);
+
+    /**
+    * Equal operator for the response.
+    */
+    ModbusRequest& operator=(const ModbusRequest &);
 
     //! Returns string representation of object
     [[nodiscard]] std::string toString() const noexcept;
diff --git a/include/MB/modbusResponse.hpp b/include/MB/modbusResponse.hpp
@@ -80,7 +80,15 @@ class ModbusResponse {
         uint16_t address = 0, uint16_t registersNumber = 0,
         std::vector<ModbusCell> values = {});
 
-    ModbusResponse(const ModbusResponse &) = default;
+    /**
+     * Copy constructor for the response.
+     */
+    ModbusResponse(const ModbusResponse&);
+
+    /**
+    * Equal operator for the response.
+    */
+    ModbusResponse& operator=(const ModbusResponse &);
 
     //! Converts object to it's string representation
     [[nodiscard]] std::string toString() const;
diff --git a/include/MB/modbusUtils.hpp b/include/MB/modbusUtils.hpp
@@ -233,4 +233,8 @@ inline void pushUint16(std::vector<uint8_t> &buffer, const uint16_t val) {
     buffer.push_back(low);
 }
 
+//! Ignore some value explicitly
+template<typename T>
+inline void ignore_result(T&& v) { (void)v; }
+
 } // namespace MB::utils
diff --git a/src/Serial/connection.cpp b/src/Serial/connection.cpp
@@ -3,6 +3,7 @@
 // Licensed under: MIT License <http://opensource.org/licenses/MIT>
 
 #include "Serial/connection.hpp"
+#include "modbusUtils.hpp"
 #include <sys/poll.h>
 
 using namespace MB::Serial;
@@ -139,7 +140,7 @@ std::vector<uint8_t> Connection::send(std::vector<uint8_t> data) {
     // most cases)
     tcflush(_fd, TCOFLUSH);
     // Write
-    write(_fd, data.begin().base(), data.size());
+    utils::ignore_result(write(_fd, data.begin().base(), data.size()));
     // It may be a good idea to use tcdrain, although it has tendency to not
     // work as expected tcdrain(_fd);
 
diff --git a/src/TCP/connection.cpp b/src/TCP/connection.cpp
@@ -3,6 +3,7 @@
 // Licensed under: MIT License <http://opensource.org/licenses/MIT>
 
 #include "TCP/connection.hpp"
+#include <cstdint>
 #include <sys/poll.h>
 #include <sys/socket.h>
 
@@ -25,16 +26,16 @@ std::vector<uint8_t> Connection::sendRequest(const MB::ModbusRequest &req) {
     std::vector<uint8_t> rawReq;
     rawReq.reserve(6);
 
-    rawReq.push_back(reinterpret_cast<const uint8_t *>(&_messageID)[1]);
-    rawReq.push_back(reinterpret_cast<const uint8_t *>(&_messageID)[0]);
+    rawReq.push_back(static_cast<const uint8_t&&>(reinterpret_cast<const uint8_t *>(&_messageID)[1]));
+    rawReq.push_back(static_cast<uint8_t>(_messageID));
     rawReq.push_back(0x00);
     rawReq.push_back(0x00);
 
     std::vector<uint8_t> dat = req.toRaw();
 
     uint32_t size = dat.size();
-    rawReq.push_back(reinterpret_cast<uint16_t *>(&size)[1]);
-    rawReq.push_back(reinterpret_cast<uint16_t *>(&size)[0]);
+    rawReq.push_back(static_cast<const uint16_t&&>(reinterpret_cast<const uint16_t *>(&size)[1]));
+    rawReq.push_back(static_cast<uint16_t>(size));
 
     rawReq.insert(rawReq.end(), dat.begin(), dat.end());
 
@@ -47,16 +48,16 @@ std::vector<uint8_t> Connection::sendResponse(const MB::ModbusResponse &res) {
     std::vector<uint8_t> rawReq;
     rawReq.reserve(6);
 
-    rawReq.push_back(reinterpret_cast<const uint8_t *>(&_messageID)[1]);
-    rawReq.push_back(reinterpret_cast<const uint8_t *>(&_messageID)[0]);
+    rawReq.push_back(static_cast<const uint8_t&&>(reinterpret_cast<const uint8_t *>(&_messageID)[1]));
+    rawReq.push_back(static_cast<uint8_t>(_messageID));
     rawReq.push_back(0x00);
     rawReq.push_back(0x00);
 
     std::vector<uint8_t> dat = res.toRaw();
 
     uint32_t size = dat.size();
-    rawReq.push_back(reinterpret_cast<uint16_t *>(&size)[1]);
-    rawReq.push_back(reinterpret_cast<uint16_t *>(&size)[0]);
+    rawReq.push_back(static_cast<const uint16_t&&>(reinterpret_cast<const uint16_t *>(&size)[1]));
+    rawReq.push_back(static_cast<uint16_t>(size));
 
     rawReq.insert(rawReq.end(), dat.begin(), dat.end());
 
@@ -69,16 +70,16 @@ std::vector<uint8_t> Connection::sendException(const MB::ModbusException &ex) {
     std::vector<uint8_t> rawReq;
     rawReq.reserve(6);
 
-    rawReq.push_back(reinterpret_cast<const uint8_t *>(&_messageID)[1]);
-    rawReq.push_back(reinterpret_cast<const uint8_t *>(&_messageID)[0]);
+    rawReq.push_back(static_cast<const uint8_t&&>(reinterpret_cast<const uint8_t *>(&_messageID)[1]));
+    rawReq.push_back(static_cast<uint8_t>(_messageID));
     rawReq.push_back(0x00);
     rawReq.push_back(0x00);
 
     std::vector<uint8_t> dat = ex.toRaw();
 
     uint32_t size = dat.size();
-    rawReq.push_back(reinterpret_cast<uint16_t *>(&size)[1]);
-    rawReq.push_back(reinterpret_cast<uint16_t *>(&size)[0]);
+    rawReq.push_back(static_cast<const uint16_t&&>(reinterpret_cast<const uint16_t *>(&size)[1]));
+    rawReq.push_back(static_cast<uint16_t>(size));
 
     rawReq.insert(rawReq.end(), dat.begin(), dat.end());
 
diff --git a/src/modbusRequest.cpp b/src/modbusRequest.cpp
@@ -30,6 +30,23 @@ ModbusRequest::ModbusRequest(uint8_t slaveId, utils::MBFunctionCode functionCode
     }
 }
 
+ModbusRequest::ModbusRequest(const ModbusRequest& reference) :
+    _slaveID(reference.slaveID()),
+    _functionCode(reference.functionCode()),
+    _address(reference.registerAddress()),
+    _registersNumber(reference.numberOfRegisters()),
+    _values(reference.registerValues()){ }
+
+
+ModbusRequest& ModbusRequest::operator=(const ModbusRequest &reference) {
+    this->_slaveID = reference.slaveID();
+    this->_functionCode = reference.functionCode();
+    this->_address = reference.registerAddress();
+    this->_registersNumber = reference.numberOfRegisters();
+    this->_values = reference.registerValues();
+    return *this;
+}
+
 ModbusRequest::ModbusRequest(const std::vector<uint8_t> &inputData, bool CRC) {
     try {
         if (inputData.size() < 3)
diff --git a/src/modbusResponse.cpp b/src/modbusResponse.cpp
@@ -30,6 +30,23 @@ ModbusResponse::ModbusResponse(uint8_t slaveId, utils::MBFunctionCode functionCo
     }
 }
 
+ModbusResponse::ModbusResponse(const ModbusResponse& reference) :
+    _slaveID(reference.slaveID()),
+    _functionCode(reference.functionCode()),
+    _address(reference.registerAddress()),
+    _registersNumber(reference.numberOfRegisters()),
+    _values(reference.registerValues()){ }
+
+
+ModbusResponse& ModbusResponse::operator=(const ModbusResponse &reference) {
+    this->_slaveID = reference.slaveID();
+    this->_functionCode = reference.functionCode();
+    this->_address = reference.registerAddress();
+    this->_registersNumber = reference.numberOfRegisters();
+    this->_values = reference.registerValues();
+    return *this;
+}
+
 ModbusResponse::ModbusResponse(std::vector<uint8_t> inputData, bool CRC) {
     try {
         if (inputData.size() < 3)

Original file line number	Diff line number	Diff line change
`@@ -233,4 +233,8 @@ inline void pushUint16(std::vector<uint8_t> &buffer, const uint16_t val) {`
`233`	`233`	`buffer.push_back(low);`
`234`	`234`	`}`
`235`	`235`
	`236`	`+//! Ignore some value explicitly`
	`237`	`+template<typename T>`
	`238`	`+inline void ignore_result(T&& v) { (void)v; }`
	`239`	`+`
`236`	`240`	`} // namespace MB::utils`