.gitignore

@@ -27,3 +27,13 @@
 *.exe
 *.out
 *.app
+bin/
+build/
+
+.nse_depinfo
+
+# Eclipse
+.cproject
+.project
+.settings
+

.gitlab-ci.yml

+image:
+        name: harbor.skao.int/production/ska-tango-images-tango-dsconfig:1.5.5
+
+stages:
+  - build
+  - test
+
+build_job:
+  stage: build
+  tags:
+    - docker
+  before_script:
+    - sudo apt update && sudo apt -y --no-install-recommends install build-essential cmake pkg-config libboost-thread-dev
+  script:
+    - mkdir build && cd build
+    - cmake -DBUILD_TESTS=ON ..
+    - make
+  artifacts:
+    paths:
+      - build/alarm-handler-srv
+      - build/bin/testdevice-srv
+    expire_in: 1 week
+
+test_load_job:
+  stage: test
+  tags:
+    - docker
+  before_script:
+    - sudo apt update && sudo apt -y --no-install-recommends install libboost-thread-dev
+  script:
+    - sleep 10
+    - /usr/local/bin/DataBaseds 2 -ORBendPoint giop:tcp::10000 &
+    - sleep 10
+    - exit_code=2
+    - json2tango -w -a -u ./test/ah_config.json || exit_code=$?
+    - if [ ${exit_code} -ne 2 ]; then echo "Tango DB configuration failed!" ; else echo "Tango DB configuration succedeed!"; fi
+    - ./build/alarm-handler-srv 01 &
+    - ./build/bin/testdevice-srv 01 &
+    - sleep 5
+    - python ./test/load-alarm-conf.py --device=alarm/handler/01 --load="tag=test0;formula=(alarm/test/01/condition == 1);on_delay=0;off_delay=0;priority=high;shlvd_time=0;group=gr_test;message=Test alarm;url=;on_command=;off_command=;enabled=1"
+    - sleep 1
+    - python ./test/check-alarm-conf.py --device=alarm/handler/01 --alarm="tag=test0;formula=(alarm/test/01/condition == 1);on_delay=0;off_delay=0;priority=high;shlvd_time=0;group=gr_test;message=Test alarm;url=;on_command=;off_command=;enabled=1"
+  needs: ["build_job"]
+  services:
+    - name: harbor.skao.int/production/ska-tango-images-tango-db:10.4.16
+      alias: tangodb
+
+

.gitlab-ci.yml_multi_stage

+image:
+  name: harbor.skao.int/production/ska-tango-images-tango-dsconfig:1.5.5
+
+# The following variables are automatically passed down to the tangodb container
+# as well as the tangodatabaseds container and available within each.
+variables:
+  MYSQL_ROOT_PASSWORD: "secret"
+  MYSQL_DATABASE: "tango"
+  MYSQL_USER: "tango"
+  MYSQL_PASSWORD: "tango"
+  MYSQL_HOST: "tangodb"
+  TANGO_HOST: "localhost:10000"
+
+stages:
+  - build
+  - conf
+  - test
+
+services:
+  - name: harbor.skao.int/production/ska-tango-images-tango-db
+    alias: tangodb
+#  - name: harbor.skao.int/production/ska-tango-images-tango-cpp
+#    alias: tangodatabaseds
+#    entrypoint: ["/usr/local/bin/DataBaseds"]
+#    command: ["2","-ORBendPoint giop:tcp::10000"]
+
+build_job:
+  stage: build
+  before_script:
+    #TODO: remove procps use for ps
+    - sudo apt update && sudo apt -y --no-install-recommends install build-essential cmake pkg-config libboost-thread-dev procps
+  script:
+    #- make
+    - mkdir build && cd build
+    - cmake ..
+    - make
+  artifacts:
+    paths:
+      - build/alarm-handler-srv
+    expire_in: 1 week
+  #    # depending on your build setup it's most likely a good idea to cache outputs to reduce the build time
+  #    cache:
+  #      paths:
+  #        - build/CMakeFiles/
+
+configure_and_run_job:
+  stage: conf
+  script:
+    - sleep 10
+    - /usr/local/bin/DataBaseds 2 -ORBendPoint giop:tcp::10000 &
+    - sleep 10
+    - exit_code=2
+    - json2tango -w -a -u ./test/ah_config.json || exit_code=$?
+    # json2tango returns 2 if values written to DB
+    - if [ ${exit_code} -ne 2 ]; then echo "Tango DB configuration failed!" ; else echo "Tango DB configuration succedeed!"; fi
+    - sleep 5
+  artifacts:
+    paths:
+      - build/alarm-handler-srv
+    expire_in: 1 week
+  needs: ["build_job"]
+  #services:
+  #  - name: harbor.skao.int/production/ska-tango-images-tango-db
+  #    alias: tangodb
+
+test_job:
+  stage: test
+  before_script:
+    #TODO: remove procps use for ps
+    - sudo apt update && sudo apt -y --no-install-recommends install libboost-thread-dev procps
+  script:
+    - /usr/local/bin/DataBaseds 2 -ORBendPoint giop:tcp::10000 &
+    - sleep 10
+    - ./build/alarm-handler-srv 01 &
+    - sleep 10
+    - ps -ef | grep alarm-handler-srv | grep -v grep
+    - sleep 5
+  needs: ["configure_and_run_job"]
+

CMakeLists.txt

+# Functions and Pre-build  -----------------------------------
+
+# Stop messy in source builds
+set(CMAKE_DISABLE_IN_SOURCE_BUILD ON)
+set(CMAKE_DISABLE_SOURCE_CHANGES  OFF)
+
+if ( ${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_BINARY_DIR} )
+    message( FATAL_ERROR "In-source builds not allowed. Please make a new directory (called a build directory) and run CMake from there. You may need to remove CMakeCache.txt." )
+endif()
+
+# Start Build Config -----------------------------------
+cmake_minimum_required(VERSION 3.8)
+set(CMAKE_SKIP_RPATH true)
+set(CMAKE_VERBOSE_MAKEFILE ON)
+set(CMAKE_COLOR_MAKEFILE ON)
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+# Output name for the final binary
+set(AH_NAME "alarm-handler-srv")
+
+# Versioning
+set(VERSION_MAJOR "1")
+set(VERSION_MINOR "0")
+set(VERSION_PATCH "0")
+set(VERSION_METADATA "")
+set(VERSION_STRING ${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH})
+
+# Add any include paths from the command line
+list(APPEND INCLUDE_PATHS ${CMAKE_INCLUDE_PATH})
+list(APPEND INCLUDE_PATHS ${CMAKE_SOURCE_DIR})
+list(APPEND LIBRARY_PATHS ${CMAKE_LIBRARY_PATH})
+
+# Start the project
+project(alarm_handler VERSION ${VERSION_STRING} LANGUAGES CXX)
+
+
+# Build options
+option(ENABLE_CLANG "Enable clang code and layout analysis" OFF)
+option(BUILD_TESTS "Build tests" OFF)
+
+# arch install definitions
+include(GNUInstallDirs)
+
+message(STATUS "Searching for libraries...")
+
+# Variable to contain a list of all the libs we depend on
+set(AH_LIBRARIES) 
+
+# allow pkg-config to search the CMAKE_PREFIX_PATH 
+set(PKG_CONFIG_USE_CMAKE_PREFIX_PATH ON)
+list(APPEND CMAKE_PREFIX_PATH "/usr")
+
+# Find Dependencies  -----------------------------------
+
+# Find tango if it has not already been found. Returns an interface library
+# called TangoInterfaceLibrary
+set(CMAKE_MODULE_PATH "${CMAKE_MODULE_PATH};${CMAKE_CURRENT_SOURCE_DIR}/cmake")
+find_package(Tango)
+
+set(Boost_USE_STATIC_LIBS OFF) 
+set(Boost_USE_MULTITHREADED ON)  
+set(Boost_USE_STATIC_RUNTIME OFF) 
+find_package(Boost 1.65.0 COMPONENTS thread) 
+
+# Code Analysis -----------------------------------
+if(ENABLE_CLANG)
+    set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+    # To find clang, find_program will search your PATH environment variable.
+    # Ensure if you have a non-standard clang install, that it has been added
+    # to your path.
+    find_program(CLANG_TIDY_EXE 
+        NAMES "clang-tidy" 
+        DOC "Path to clang-tidy executable")
+
+    if(NOT CLANG_TIDY_EXE)
+        message(STATUS "clang-tidy not found.")
+    else(NOT CLANG_TIDY_EXE)
+        message(STATUS "clang-tidy found: ${CLANG_TIDY_EXE}")
+        set(DO_CLANG_TIDY "${CLANG_TIDY_EXE}")
+    endif(NOT CLANG_TIDY_EXE)
+endif(ENABLE_CLANG)
+
+# Source  -----------------------------------
+
+add_subdirectory(src)
+
+# Build Targets  -----------------------------------
+
+# Executable --------
+add_executable(alarm_handler ${SRC_FILES})
+
+target_link_libraries(alarm_handler 
+    PRIVATE 
+        TangoInterfaceLibrary
+	${Boost_LIBRARIES}
+	)
+
+target_include_directories(alarm_handler 
+    PRIVATE 
+        $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/src>
+        ${INCLUDE_PATHS}
+        "${PROJECT_BINARY_DIR}"
+	${Boost_INCLUDE_DIRS})
+
+if(NOT (CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang" OR CMAKE_CXX_COMPILER_ID STREQUAL "Clang"))
+    set_target_properties(alarm_handler
+        PROPERTIES
+        OUTPUT_NAME ${AH_NAME}
+        LINK_FLAGS "-Wl,--no-undefined"
+        CXX_STANDARD 17)
+else()
+    set_target_properties(alarm_handler
+        PROPERTIES
+        OUTPUT_NAME ${AH_NAME}
+        LINK_FLAGS ""
+        CXX_STANDARD 17)
+endif()
+
+if(DO_CLANG_TIDY)
+    set_target_properties(alarm_handler 
+        PROPERTIES 
+            CXX_CLANG_TIDY ${DO_CLANG_TIDY})
+endif(DO_CLANG_TIDY)
+
+target_compile_options(alarm_handler 
+    PRIVATE "$<$<CONFIG:DEBUG>:-g>")
+
+# Install Config -----------------------------------
+install(
+    TARGETS alarm_handler
+    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR})
+
+message(STATUS "Configured alarm-handler project")
+
+
+# Tests -----------------------------------
+if(BUILD_TESTS)
+    add_subdirectory(test)
+endif(BUILD_TESTS)
+

Makefile

+NAME_SRV = alarm-handler-srv
+
+
+
+CXXFLAGS +=
+
+
+LDFLAGS +=  -lboost_thread
+
+include ../makefiles/Make-9.3.3.in

README.md

-# alarm
-Elettra Alarms
+# Alarm-handler
+Elettra alarm-handler Tango device
+
+
+## Building and Installation
+
+In its simplest form, clone the repository and assuming a standard install for all dependencies:
+
+```
+mkdir build
+cd build
+cmake ../
+make
+make install
+```
+
+### pkg-config Settings
+
+The build system uses pkg-config to find some dependencies, for example Tango. If Tango is not installed to a standard location, set PKG_CONFIG_PATH, i.e.
+
+```bash
+export PKG_CONFIG_PATH=/non/standard/tango/install/location
+...
+cmake ../
+...
+```
+
+The pkg-config path can also be set with the cmake argument CMAKE_PREFIX_PATH. This can be set on the command line at configuration time, i.e.:
+
+```bash
+...
+cmake -DCMAKE_PREFIX_PATH=/non/standard/tango/install/location ../
+...
+```
+
+### Project Flags
+
+| Flag | Setting | Default | Description |
+|------|-----|-----|-----|
+| BUILD_TESTS | ON/OFF | OFF | Build test devices under test directory |
+
+### Standard CMake Flags
+
+The build system is CMake therefore standard CMake flags can be used to influence the build and installation process. The following is a list of common useful CMake flags and their use:
+
+| Flag | Use |
+|------|-----|
+| CMAKE_INSTALL_PREFIX | Standard CMake flag to modify the install prefix. |
+| CMAKE_INCLUDE_PATH | Standard CMake flag to add include paths to the search path. |
+| CMAKE_LIBRARY_PATH | Standard CMake flag to add paths to the library search path |
+
+
+## Legacy Building
+
+Using Elettra makefiles, clone both alarm-handler and makefile repositories, then call make:
+
+```bash
+git clone http://gitlab.elettra.eu/cd/ds/makefiles.git
+git clone http://gitlab.elettra.eu/cs/ds/alarm-handler.git
+cd alarm-handler
+make
+```

cmake/FindLibraries.cmake

+include(CMakeParseArguments)
+
+function(find_libraries)
+
+    # Parse the parameters
+    set(MULTIVALUEARGS LIBRARIES SEARCH_PATHS)
+    cmake_parse_arguments(FIND_LIBRARIES "" "" "${MULTIVALUEARGS}" ${ARGN})
+
+    # Clear the found libraries
+    unset(FOUND_LIBRARIES PARENT_SCOPE)
+
+    foreach(LIB ${FIND_LIBRARIES_LIBRARIES})
+
+        # try the user provided paths first
+        find_library(FOUND_LIB_${LIB} ${LIB} PATHS ${FIND_LIBRARIES_SEARCH_PATHS} NO_DEFAULT_PATH)
+
+        # if we could not find it, drop to the system paths
+        if(NOT FOUND_LIB_${LIB})
+            find_library(FOUND_LIB_${LIB} ${LIB})
+        endif(NOT FOUND_LIB_${LIB})
+
+        if(FOUND_LIB_${LIB})
+            message(STATUS "Found " ${LIB} " at: " ${FOUND_LIB_${LIB}})
+            list(APPEND FOUND_LIBRARIES ${FOUND_LIB_${LIB}})
+        else()
+            message(FATAL "Could not find " ${LIB})
+        endif(FOUND_LIB_${LIB})
+        
+    endforeach(LIB ${LIBRARIES})
+
+    set(FOUND_LIBRARIES ${FOUND_LIBRARIES} PARENT_SCOPE)
+endfunction(find_libraries)
\ No newline at end of file

cmake/FindTango.cmake

+if(NOT TARGET TangoInterfaceLibrary)
+
+    # Ensure pkg-config is installed 
+    find_package(PkgConfig REQUIRED)
+
+    # Now search for the tango.pc file, this is a required dependency
+    message(STATUS "Search for TANGO package config...")
+    pkg_search_module(TANGO REQUIRED tango>=9.2.5)
+    message(STATUS "Found tango version ${TANGO_VERSION} at ${TANGO_PREFIX}")
+
+    include(FindLibraries)
+    find_libraries(LIBRARIES ${TANGO_LIBRARIES} SEARCH_PATHS ${TANGO_LIBRARY_DIRS})
+
+    # Create an interface library to represent the tango linkage
+    add_library(TangoInterfaceLibrary INTERFACE)
+
+    set_target_properties(TangoInterfaceLibrary 
+        PROPERTIES 
+            INTERFACE_INCLUDE_DIRECTORIES "${TANGO_INCLUDE_DIRS}"
+            INTERFACE_LINK_LIBRARIES "${FOUND_LIBRARIES}"
+            INTERFACE_COMPILE_OPTIONS "${TANGO_CFLAGS}")
+
+    message(STATUS "Configured Tango Interface for TANGO version ${TANGO_VERSION}")
+endif(NOT TARGET TangoInterfaceLibrary)
\ No newline at end of file

docs/Formula.md

+# Formula syntax
+The formula is an expression with operators, operands and functions. Operands can be variables, constant values, or other expression optionally enclosed by parentheses.
+
+## Operands
+
+### Variables
+
+- Attributes names with or without fqdn (e.g. ```tango://host:port/name/of/dev/attr```, ```name/of/dev/attr```)
+- attribute properties ```.quality```, ```.alarm```, ```.normal``` so that
+  - ```name/of/dev/attr.quality``` returns the Tango quality (the integer value) of the attribute
+  - ```name/of/dev/attr.alarm``` returns true if the attribute ==UNACK or ==ACK
+  - ```name/of/dev/attr.normal``` returns true if the attribute ==NORM or ==RTNUN
+
+### Constants
+
+- Real numbers (e.g. ```name/of/dev/attr >= 35```, ```name/of/dev/attr < -23.5```)
+- Hexadecimal numbers (e.g. ```name/of/dev/attr != 0xaf```, ```name/of/dev/attr & 0x1A```)
+- Strings as any character between an opening and a closing ' (e.g. ```name/of/dev/status == 'The device is in ON state.'```)
+- Tango states enum labels (*ON, OFF, CLOSE, OPEN, INSERT, EXTRACT, MOVING, STANDBY, FAULT, INIT, RUNNING, ALARM, DISABLE, UNKNOWN*) (e.g. ```name/of/dev/state == FAULT```)
+- Tango quality enum labels (*ATTR_VALID, ATTR_INVALID, ATTR_WARNING, ATTR_ALARM, ATTR_CHANGING*) (e.g. ```name/of/dev/attr.quality == ATTR_ALARM```)
+- Alarm state enum labels (*NORM, UNACK, ACKED, RTNUN, SHLVD, DSUPR, OOSRV*) (e.g. ```name/of/dev/alarm_attr != NORM```)
+
+### Expressions
+
+- A combination of operands and operators enclosed by parentheses
+
+## Operators
+
+### Binary Math
+- Multiplication ```*```
+- Division ```/```
+- Addition ```+```
+- Subtraction ```-```
+### Binary Comparison
+- Equal ```==```
+- Not equal ```!=```
+- Greater than ```>```
+- Greater than or equal to  ```>=```
+- Less than ```<```
+- Less than or equal to  ```<=```
+### Binary Logical
+- Logical AND ```&&```
+- Logical OR ```||```
+### Binary Bitwise
+- Left shift ```<<```
+- Right shift ```>>```
+- Bitwise AND ```&```
+- Bitwise OR ```|```
+- Bitwise XOR ```^```
+### Unary Math
+- Minus ```-```
+### Unary Logical
+- Logical NOT ```!```
+
+### Binary operators order of precedence
+
+```
+*, /, +, -, <<, >>, <=, >=, >, <, ==, !=, &, |, ^, &&, ||
+```
+
+## Functions
+
+### Unary Functions
+- Absolute value of X ```abs(X)```
+- Sine of X ```sin(X)```
+- Cosine of X ```cos(X)```
+
+### Binary Functions
+- Minimum between two values X and Y ```min(X,Y)```
+- Maximum between two values X and Y ```max(X,Y)```
+- Power: X raised to the power of Y ```pow(X,Y)```
+
+### Ternary Functions
+- Conditional operator: if X then Y else Z ```X ? Y : Z```
+
+### Reduce Functions
+- Reduce OR: reduce array X applying logical OR to each element ```OR(X)```
+- Reduce AND: reduce array X applying logical AND to each element ```OR(X)```
+
+# Attributes types
+
+The following types of attribute are supported:
+
+```
+Scalar, Spectrum, Image
+```
+
+with data types:
+
+```
+DevBoolean, DevUChar, DevShort, DevUShort, DevLong, DevULong, DevLong64, DevULong64, DevFloat, DevDouble, DevString, DevState, DevEnum
+```
+
+```DevEncoded``` is not supported.
+
+The read part of every attribute is internally extracted in a vector of double with the ```extract_read``` method of the ```DeviceAttribute``` class. In this ways operations between attribute with different data types and sizes can be performed with the following constraints:
+- DevString attributes can only be compared with 'equal' or 'not equal' operators to DevString attributes or string constants
+- Binary operators can operate on arrays if both operands have the same size, or one of the two has size equal to one.
+
+# Operation on arrays
+
+## Indexes to access elements
+
+- A single element of a one-dimensional array attribute (Spectrum) can be extracted with a single index between square brackets (e.g. ```name/of/dev/attr[ind]```).
+- A single element of a two-dimensional array attribute (Image) can be extracted with two indexes between square brackets (e.g. ```name/of/dev/attr[ind_row][ind_column]```).
+- A one-dimensional array can be extracted from a two-dimensional array attribute (Image) with a single index between square brackets (e.g. ```name/of/dev/attr[ind_row]```).
+
+## Lists and ranges of indexes to slice arrays
+Indexes can be specified as a comma separated list and/or hyphen-separated range (e.g. ```[i0,i1-i2,...]```).
+In this way:
+- A slice can be extracted from a one-dimensional array with a list and/or range of indexes between square brackets (e.g. ```name/of/dev/1Dattr[i0,i1-i2,...]```).
+- A subset of rows can be extracted from a two-dimensional array with a list and/or range of indexes for the first dimension (e.g. ```name/of/dev/2Dattr[i0,i1-i2,...]```).
+- A single column slice can be extracted from a two-dimensional array with a list and/or range of indexes for the first dimension and a single index for the second dimension (e.g. ```name/of/dev/2Dattr[i0,i1-i2,...][i3]```).
+- A single row slice can be extracted from a two-dimensional array with a single index for the first dimension and list/range of indexes for the second dimension (e.g. ```name/of/dev/2Dattr[i0][i1-i2,i3,...]```).
+- An array slice can be extracted from a two-dimensional array with a list and/or range of indexes for both the first and second dimensions (e.g. ```name/of/dev/2Dattr[i0-i1,...][i2,i3,...]```).
+- To specify all elements of one dimension index -1 can be used (e.g. Column 3 of all rows of 2D array ```name/of/dev/2Dattr[-1][3]```).
+
+If any index exceeds actual dimensions of the array, the formula is evaluated to ERROR with an out of bounds exception.
+
+No check is done on the order and uniqueness of indexes, so it is allowed to concatenate duplicated and out of order elements/rows/columns (e.g. ```name/of/dev/2Dattr[0-2,1,0,..]``` evaluates to an array with rows 0,1,2,1,0 of 2Dattr)
+
+## Limitations
+
+- It is not possible to specify array constants (e.g. ```name/of/dev/attr > [val1,val2]```).
+- It is not possible to use indexes on expressions (e.g. ```(any_expression)[ind]```).
+
+## Unary operators and functions
+
+Unary operators and functions are applied to every element of the array
+
+## Binary operators and functions
+
+- If both operands have the same size, operators are applied element by element. Result is an array with the same size.
+- If one operand has size one, operators apply it to every element of the other operand. Result is an array with the same size.
+- Otherwise an exception is raised and the formula is evaluated to the *ERROR* state with the Reason, Descrption and Origin DevFailed fields properly filled.
+
+## Ternary Function
+- Conditional operator: if X then Y else Z. X is implicitly reduced with *OR* to have a boolean value, then Y or Z are evaluated depending on the result
+
+# Formula result
+Every formula produce a boolean result in the following way:
+1. each element of the array is tested as not equal to zero in order to have an array of booleans
+2. the array of boolean is reduced with OR (i.e. if at least one element of the array is TRUE, the result is TRUE) 
+
+# Errors
+
+If a formula cannot be evaluated, the corresponding alarm is set to the *ERROR* value with the Reason, Description and Origin DevFailed fields properly filled.
+Possible errors are:
+- Errors coming from the event system for one or more attributes involved in the formula
+- Errors coming from evaluation of array with different sizes
+- Errors coming from indexes out of bound while extracting elements from arrays
+- Unexpected errors while evaluating formulas