Rename binaries according to new rules (QC-164) (#153)

* Rename binaries according to new rules (kebab-case)

* change name of modulesHelper.sh

* fix indentation

* Fix the broken merge

Author: Barthelemy

Framework/CMakeLists.txt

@@ -142,6 +142,20 @@ set(
 
 set(
   EXE_NAMES
+  o2-qc-info-service
+  o2-qc-info-service-dump
+  o2-qc-run-basic
+  o2-qc-run-advanced
+  o2-qc-run-readout
+  o2-qc-run-merger-test
+  o2-qc-run-readout-for-data-dump
+  o2-qc-repository-benchmark
+)
+
+# These were the original names before the convention changed.
+# We will get rid of them but for the time being we want to create symlinks to avoid confusion.
+set(
+  EXE_OLD_NAMES
   qcInfoService
   qcInfoServiceDump
   qcRunBasic
@@ -152,19 +166,29 @@ set(
   repositoryBenchmark
 )
 
+# As per https://stackoverflow.com/questions/35765106/symbolic-links-cmake
+macro(install_symlink filepath sympath)
+  install(CODE "execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink ${filepath} ${sympath})")
+  install(CODE "message(\"-- Created symlink: ${sympath} -> ${filepath}\")")
+endmacro(install_symlink)
+
 list(LENGTH EXE_SRCS count)
 math(EXPR count "${count}-1")
 foreach(i RANGE ${count})
   list(GET EXE_SRCS ${i} src)
   list(GET EXE_NAMES ${i} name)
+  list(GET EXE_OLD_NAMES ${i} oldname)
   add_executable(${name} ${src})
   target_link_libraries(${name} PRIVATE QualityControl CURL::CURL)
+  install_symlink(${CMAKE_INSTALL_FULL_BINDIR}/${name} ${CMAKE_INSTALL_FULL_BINDIR}/${oldname})
 endforeach()
 
 # ---- Gui ----
 
 set(DATADUMP "")
 if(GLFW_FOUND)
+  set(DATADUMP "o2-qc-data-dump")
+
   set(
     GUI_SRCS
     src/imgui/imgui.cpp
@@ -178,13 +202,11 @@ if(GLFW_FOUND)
     src/runDataDump.cxx
   )
 
-  add_executable(dataDump ${GUI_SRCS})
-
-  target_link_libraries(dataDump PRIVATE QualityControl GLFW::GLFW)
+  add_executable(${DATADUMP} ${GUI_SRCS})
 
-  set(DATADUMP "dataDump")
+  target_link_libraries(${DATADUMP} PRIVATE QualityControl GLFW::GLFW)
 else()
-  message(STATUS "GLFW not found, DataDump will not be built")
+  message(STATUS "GLFW not found, ${DATADUMP} will not be built")
 endif()
 
 # ---- Tests ----
@@ -277,7 +299,7 @@ install(
 
 # ---- Extra scripts ----
 
-install(PROGRAMS script/qcDatabaseSetup.sh DESTINATION bin)
+install(PROGRAMS script/o2-qc-database-setup.sh DESTINATION bin)
 install(
   FILES
     example-default.json

…mework/script/benchmark_machine_setup.sh …/script/o2-qc-benchmark-machine-setup.shFramework/script/benchmark_machine_setup.sh renamed to Framework/script/o2-qc-benchmark-machine-setup.sh Framework/script/benchmark_machine_setup.sh renamed to Framework/script/o2-qc-benchmark-machine-setup.sh

@@ -140,17 +140,17 @@ function create_check {
 }
 
 function print_usage {
-  echo "Usage: ./modulesHelper.sh -m MODULE_NAME [OPTION]
+  echo "Usage: ./o2-qc-module-configurator.sh -m MODULE_NAME [OPTION]
 
 Generate template QC module and/or tasks, checks.
 If a module with specified name already exists, new tasks and checks are inserted to the existing one.
 Please follow UpperCamelCase convention for modules', tasks' and checks' names.
 
 Example:
 # create new module and some task
-./modulesHelper.sh -m MyModule -t SuperTask
+./o2-qc-module-configurator.sh -m MyModule -t SuperTask
 # add one task and two checks
-./modulesHelper.sh -m MyModule -t EvenBetterTask -c HistoUniformityCheck -c MeanTest
+./o2-qc-module-configurator.sh -m MyModule -t EvenBetterTask -c HistoUniformityCheck -c MeanTest
 
 Options:
  -h               print this message

…k/script/benchmark_results_extraction.sh …pt/o2-qc-benchmark-results-extraction.shFramework/script/benchmark_results_extraction.sh renamed to Framework/script/o2-qc-benchmark-results-extraction.sh Framework/script/benchmark_results_extraction.sh renamed to Framework/script/o2-qc-benchmark-results-extraction.sh

@@ -55,8 +55,8 @@ enabled=1
 In 3 separate terminals, do respectively
 
 1. `readout.exe file:///absolute/path/to/config.cfg`
-2. `qcRunReadoutForDataDump --batch`
-3. `dataDump --mq-config $QUALITYCONTROL_ROOT/etc/dataDump.json --id dataDump --control static`
+2. `o2-qc-run-readout-for-data-dump --batch`
+3. `o2-qc-data-dump --mq-config $QUALITYCONTROL_ROOT/etc/dataDump.json --id dataDump --control static`
 
 ### Configuration
 
@@ -83,7 +83,7 @@ and `$QUALITYCONTROL_ROOT/etc/dataDump.json`.
    ```
    sudo systemctl start mariadb # for CC7, check for your specific OS
    alienv enter qcg/latest
-   qcDatabaseSetup.sh
+   o2-qc-database-setup.sh
    ```
 
 ## Local CCDB setup
@@ -183,19 +183,19 @@ The JSON for all tasks looks like :
 ```
 ### Usage
 ```
-qcInfoService -c /absolute/path/to/InformationService.json -n information_service \
+o2-qc-info-service -c /absolute/path/to/InformationService.json -n information_service \
               --id information_service --mq-config /absolute/path/to/InformationService.json
 ```
 
-The `qcInfoService` can provide fake data from a file. This is useful
+The `o2-qc-info-service` can provide fake data from a file. This is useful
 to test the clients. Use the option `--fake-data-file` and provide the
 absolute path to the file. The file `infoServiceFake.json` is provided
 as an example.
 
 To check what is being output by the Information Service, one can
 run the InformationServiceDump :
 ```
-qcInfoServiceDump -c /absolute/path/to/InformationService.json -n information_service_dump \
+o2-qc-info-service-dump -c /absolute/path/to/InformationService.json -n information_service_dump \
                   --id information_service_dump --mq-config /absolute/path/to/InformationService.json
                   --request-task myTask1
 ```

Framework/script/benchmark.sh Framework/script/o2-qc-benchmark.shFramework/script/benchmark.sh renamed to Framework/script/o2-qc-benchmark.sh

@@ -169,7 +169,7 @@ In case one needs to sample at a very high rate, or even monitor 100% of the dat
 }
 ```
 
-The file `basic-no-sampling.json` is provided as an example. To test it, you can run `qcRunBasic` with the option `--no-data-sampling` (it makes it use this config file instead of `basic.json`).
+The file `basic-no-sampling.json` is provided as an example. To test it, you can run `o2-qc-run-basic` with the option `--no-data-sampling` (it makes it use this config file instead of `basic.json`).
 
 ### Code Organization
 
@@ -185,19 +185,19 @@ The Quality Control uses _plugins_ to load the actual code to be executed by the
 
 Before starting to develop the code, one should create a new module if it does not exist yet. Typically each detector team should prepare a module.
 
-The script `modulesHelper.sh`, in the directory _Modules_, is able to prepare a new module or to add a new _Task_ or a new _Check_ to an existing module. It must be run from __within QualityControl/Modules__. See the help message below:
+The script `o2-qc-module-configurator.sh`, in the directory _Modules_, is able to prepare a new module or to add a new _Task_ or a new _Check_ to an existing module. It must be run from __within QualityControl/Modules__. See the help message below:
 ```
-Usage: ./modulesHelper.sh -m MODULE_NAME [OPTION]
+Usage: ./o2-qc-module-configurator.sh -m MODULE_NAME [OPTION]
 
 Generate template QC module and/or tasks, checks.
 If a module with specified name already exists, new tasks and checks are inserted to the existing one.
 Please follow UpperCamelCase convention for modules', tasks' and checks' names.
 
 Example:
 # create new module and some task
-./modulesHelper.sh -m MyModule -t SuperTask
+./o2-qc-module-configurator.sh -m MyModule -t SuperTask
 # add one task and two checks
-./modulesHelper.sh -m MyModule -t EvenBetterTask -c HistoUniformityCheck -c MeanTest
+./o2-qc-module-configurator.sh -m MyModule -t EvenBetterTask -c HistoUniformityCheck -c MeanTest
 
 Options:
  -h               print this message
@@ -210,8 +210,8 @@ For example, if your detector 3-letter code is ABC you might want to do
 ```
 # we are in ~/alice
 cd QualityControl/Modules
-./modulesHelper.sh -m Abc # create the module
-./modulesHelper.sh -t RawDataQcTask # add a task
+./o2-qc-module-configurator.sh -m Abc # create the module
+./o2-qc-module-configurator.sh -t RawDataQcTask # add a task
 ```
 
 ## Test run
@@ -238,7 +238,7 @@ Change the lines as indicated below :
 Now we can run it
 
 ```
-qcRunBasic
+o2-qc-run-basic
 ```
 
 You should see the QcTask at qcg-test.cern.ch with an object `Example` updating.

Framework/script/qcDatabaseSetup.sh Framework/script/o2-qc-database-setup.shFramework/script/qcDatabaseSetup.sh renamed to Framework/script/o2-qc-database-setup.sh

@@ -58,7 +58,7 @@ The _Producer_ is a random data generator. In a more realistic setup it would be
 
 To run it simply do
 
-    qcRunBasic
+    o2-qc-run-basic
 
 Thanks to the Data Processing Layer (DPL, more details later) it is a single process that steers all the _devices_, i.e. processes making up the workflow. A window should appear that shows a graphical representation of the workflow. The output of any of the processes is available by double clicking a box. If a box is red it means that the process has stopped, probably abnormaly.
 
@@ -67,7 +67,7 @@ Thanks to the Data Processing Layer (DPL, more details later) it is a single pro
 __Repository and GUI__
 
 The data is stored in the [ccdb-test](ccdb-test.cern.ch:8080/browse) at CERN. If everything works fine you should see the objects being published in the QC web GUI (QCG) at this address : [https://qcg-test.cern.ch/?page=objectTree](https://qcg-test.cern.ch/?page=objectTree). The link brings you to the hierarchy of objects (see screenshot below). Open "QcTask" (the task you are running) and click on "example" which is the name of your histogram. The plot should be displayed on the right. If you wait a bit and hit "REFRESH NOW" in the far left menu you should see it changing from time to time (see second screenshot below). 
-Please note that anyone running qcRunBasic publishes the same object and you might see the one published by someone else. 
+Please note that anyone running o2-qc-run-basic publishes the same object and you might see the one published by someone else. 
 
 ![alt text](images/basic-qcg1.png)
 ![alt text](images/basic-qcg2.png)
@@ -110,7 +110,7 @@ readout.exe file://$READOUT_ROOT/etc/readout.cfg
 
 Start the QC and DS (DataSampling) workflow :
 ```
-qcRunReadout
+o2-qc-run-readout
 ```
 
 The data sampling is configured to sample 1% of the data as the readout should run by default at full speed.
@@ -123,7 +123,7 @@ The payload received is a 2MB (configurable) data page made of CRU pages (8kB).
 __Configuration file__
 
 The configuration file is installed in `$QUALITYCONTROL_ROOT/etc`. Each time you rebuild the code, `$QUALITYCONTROL_ROOT/etc/readout.json` is overwritten by the file in the source directory (`~/alice/QualityControl/Framework/readout.json`).
-To avoid this behaviour and preserve the changes you do to the configuration, you can copy the file and specify the path to it with the parameter `--config-path` when launch `qcRunReadout`.
+To avoid this behaviour and preserve the changes you do to the configuration, you can copy the file and specify the path to it with the parameter `--config-path` when launch `o2-qc-run-readout`.
 
 To change the fraction of the data being monitored, change the option `fraction`.