Goal Integrate Google test in the AREG SDK to star developing unit tests.

Motivation The unit tests are used to test small functions / functionalities and it is an effective tool to find and fix bugs. Applications having high rate of unit test code coverage are quite stable. Our minimum goal is to have high rate of code coverage of base module, which contains collection of bases objects.

Background information AREG SDK is possible to compile via cmake. The GTest contains well description how to integrate it in the project via CMakeLists.txt. In addition, there are very many projects that can be an example of integrating GTest.

Summery of changes:

• Comments added to /conf/cmake/ configuration files.
• Some improvements in and replacement in cmake configs.
• New file - pre-project.cmake - added for some settings which must be added before project().

In this phase, I must say some problems might be encountered during cross-compiling for specific scenarios, though I'm trying to solve them.

Open to any modification or suggestion :)

This patch fixes:

• Compiling and linking problems with previous script for Visual Studio

Summary of changes:

• New linking library added.
• Few unused variables have been removed.
• New configurations added to common.cmake.
• Some Linux-specific configurations such as: GCC specific flags, have been removed for Windows.

Tests

Static and shared areg-sdk library has tested and all examples have been compiled and linked correctly both for Visual Studio (Windows) and Makefiles (Linux) build systems.

As always open to any modification :)

Precondition Merged the latest code and cmake changes (issue #28) in the 20220701-candidate branch to make a build.

Actions Make a build using CMake

Expected Compilation with no warnings and errors.

Result When compile examples, see the warning message: WARNING: None of preprocessor defines are set. By default sets EXP_AREG_DLL. See GESwitches.h file of AREG API Core This may happen only when none of these options is set: EXP_AREG_DLL, EXP_AREG_LIB, IMP_AREG_DLL, IMP_AREG_LIB

Note:

1. When compile areg-sdk frameworklibrary as shared library (areg.so / areg.dll) the flag must be EXP_AREG_DLL, all other modules must have flag IMP_AREG_DLL
2. When compile areg-sdk frameworklibrary as static library (areg.a / areg.lib*) the flag must be EXP_AREG_LIB, all other modules must have flag IMP_AREG_LIB

Only in these cases there will be no warning. Otherwise, there will be a problem compiling for Windows OS, which requires precise import / export flags.

Similar to Makefile, there should be integrate CMake

• to compile all project
• generate files in product/gen folder
• Add possibility to include .siml files in CMake automatically to generate sources.

Describe the bug Try to compile codes in VSCode and GCC compiler of 20220701-candidate branch. All projects, except projects 10_locsvc and 11_locmesh are compiled and linked. The mentioned 2 projects failed during linking.

To Reproduce Steps to reproduce the behavior.

• In VSCode select CMakeLists.txt of the root folder and configure.
• After configuration, build all projects.

Expected behavior All projects must be compiled and linked.

Desktop or embedded (please complete the following information):

• OS: Windows 10
• Hardware 64_x86
• Compiler cygwin-gcc
• AREG SDK version: 20220701-candidate branch.

Additional context There were more projects that were not compiling, fixed by linking with libraries. Also tried to compile projects with MS Visual Studio CMake tool, all projects compiled fine.

Brief description on changes

Root cmake created with initializing aliases.

configuration files placed in conf/cmake. some of makefile features which represented in conf/make are not compatible with cmake sysntax, therefore need a little bit polishing. (for instance configuring the platform in user.cmake )

Absolutely open to any changes or resolving any mistake :)

Motivation

1. After compilation, the developer should be able to start any project without additional effort. At this moment, to start IPC project or to configure logging, after compilation with cmake, the developer needs manually create config subdirectory and copy log.init and router.init files in the folder of binaries. For example, compiling with msvc and make automatically do this action.
2. make under Linux compiles and creates binaries with extension .out and msvc compiles binaries with extension .exe.
3. Both, make and msvc compile with incremental build, which is much faster and does not require to recompile all projects.

What to do

1. After compilation of binaries with cmake, create config subfolder in the binary output folder bin (i.e. in bin/config) if it is not existing, and copy files log.init used by logging and router.init used for IPC.
2. When compile under Linux, add .out extension to executable binaries, i.e. the mcrouter is mcrouter.out. No need to make this change for Windows, because the compiler automatically adds extension .exe.
3. Support incremental build with cmake at least for Debug configuration, so that there will be no need to rebuild all projects after each small change.

This closes #64

Description There where 2 critical issues described in bug #64

1. The examples 10 and 11 where not compiling with VS Code under Windows (cygwin compiler).
2. Other compiled applications where immediately crashing on start.

Changes made

1. The examples where not compiling because the compiler was requiring to import ProxyBase::Listener class, even if it is declared as private. The fix is import class: AREG_API class Listener.
2. All examples where crashing creating stackdump files. It required multiple fixes. The reason was static objects that are created before main. Some of them where referring to other objects, which were not initialized yet. And this was causing application crash. The fixe is instead static variables use static methods that return statically created objects like this:

Process & Process::getInstance( void )
{
    static Process _theProcess;
    return _theProcess;
}

CMake build

Good morning @aregtech and @biwiki, hope you're doing well.

I would like to present latest progress on CMake integration to areg-sdk.

Change-logs

• Rest of examples from 10_locsvc through 16_pubfsm added to CMake build routine.
• Generated outputs would be part of product tree.
• Few improvements on configurations happened for better solution.

Next step

• At this point, I believe CMake could be a trustworthy build system for areg-sdk - naturally, after being tested and modified as you desired - and could replace Makefile buiild.
  • Of course, there's always some bugfixes and improvements to make, nevertheless with current state; we could move on for now and rest could be done by small bugfixes.

Test

For testing result I have used following commands:

$ cmake -Bbuild # Creates build directory for cmake configs.
$ cmake --build build -j 4 # Builds areg-sdk core and examples by default.

Output files will stay in product/<build-type> directory tree.

Note

Please test the build system and verify its integrity. Unfortunately, I have not proper windows machine to test Visual Studio build system; therefore, it'll be nice if you could check it out.

As always open to any modification :)

=== NOT READY TO MERGE === Converting String to std::string in the areg base can be done incrementally like this. Still not compilable, but it is quite promising that we can move to std::string step by step.

After creating wiki-pages, make updates of Howto.md

1. Check the preprocessor defines
2. Check the build with make -- check the cross-compile builds.
3. Update the build with cmake
4. Remove build with Eclipse.

There are many minor changes to make to prepare release 1.5. This task does not have concrete feature to implement. It is created to make notes for small changes to release areg-sdk 1.5.

Problem The demonstration of features are in the example folder of AREG SDK. But still there are many objects and many methods that are never tested. In order to test, there is a need to increase amount of unit tests.

Actions The unit tests are integrated and should be implemented in the tests/units. Each .cpp file should contain one test name. The tests are added in the CMakeFiles.txt by calling addTest() method, which automatically includes the tests in the compilation. The testing module is the AREG engine / framework.

Note This ticket cannot be assigned to one person since the topic of unit tests is huge. Please inform for which object / topic you want to create unit test and I'll create a separate ticket and branch, and assign to you.

Goal After implementing the UDP/IP wrapper (issue #32), it should be integrated in the AREG SDK to support communication using UDP/IP.

Motivation The implementation of Multiple channel communication (issue #31) will allow to use different network communication. One of the easiest and fasted way to approve multi-channel communication is integration of the UDP/IP, which in comparison to TCP/IP is faster, but less stable.

Background information The UDP/IP should be configured in the initialization files (issue #67). After setups, the network service should be able to establish UDP/IP connection and use multi-channel communication for messaging.