project_generator.cpp

Go to the documentation of this file.

/***************************************
        Auteur : Pierre Aubert
        Mail : pierre.aubert@lapp.in2p3.fr
        Licence : CeCILL-C
****************************************/
 
#include "parser_toml.h"
#include "cmakelist_generator.h"
#include "gitlab_doc.h"
#include "wrapper_generator.h"
#include "project_generator.h"
 
 
bool project_generator_loadConfig(ProjectConfig & config, const PPath & descriptionFile){
        DicoValue dico;
        if(!parser_toml(dico, descriptionFile)){
                std::cerr << "project_generator : cannot parse config file '"<<descriptionFile<<"'" << std::endl;
                return false;
        }
        DicoValue * mapProject = dico.getMap("project");
        if(mapProject == NULL){
                std::cerr << "project_generator_loadConfig : Missing [project] in config file '"<<descriptionFile<<"'" << std::endl;
                return false;
        }
        //TODO : It should be better to tell if there are missing values, but it's late ...
        config.name = phoenix_get_string(*mapProject, "name", "MyAwesomeProject");
        config.url = phoenix_get_string(*mapProject, "url", "need and url");
        config.version = phoenix_get_string(*mapProject, "version", "0.0.1");
        config.description = phoenix_get_string(*mapProject, "description", "A very important project");
        config.mainBranch = phoenix_get_string(*mapProject, "main_branch", "master");
        config.runnerTag = phoenix_get_string(*mapProject, "runner_tag", "");   //Could be MUST_big_runner
        return true;
}
 
 
bool project_generator_cmakeListsSrc(const PPath & fileName, const PString & projectName, const PString & libName){
        PString body;
        body += getCMakeListsHeader();
        
        body += "file(GLOB "+libName+"_SRC \"${CMAKE_CURRENT_SOURCE_DIR}/*.cpp\")\n";
        body += "phoenix_add_library("+libName+" ${"+libName+"_SRC})\n";
        body += "target_link_libraries("+libName+" phoenix_type_stream phoenix_data_stream)\n";
 
        body += "install(TARGETS "+libName+" LIBRARY DESTINATION ${LIBRARY_DIRECTORY} ARCHIVE DESTINATION ${LIBRARY_DIRECTORY})\n";
 
        body += "file(GLOB headers \"${CMAKE_CURRENT_SOURCE_DIR}/*.h\")\n";
 
        body += "install(FILES ${headers} DESTINATION include/"+projectName+")\n";
        
        return fileName.saveFileContent(body);
}
 
 
bool project_generator_cmakeListsTest(const PPath & fileName, const PString & baseConfigClassName){
        PString body;
        body += getCMakeListsHeader();
        
        body += "add_subdirectory(TEST_"+baseConfigClassName.toUpper()+")\n\n";
        
        return fileName.saveFileContent(body);
}
 
 
bool project_generator_cmakeListsMain(const PPath & fileName, const ProjectConfig & projectConfig, const PString & baseConfigClassName){
        PString body;
        body += getCMakeListsHeader();
        
        body += "cmake_minimum_required(VERSION 3.10)\n";
        body += "project("+projectConfig.name+")\n";
 
        body += "\nfind_package(PhoenixCMake REQUIRED)\n\n";
 
        body += "phoenix_base_project(\""+projectConfig.name+"\" \""+projectConfig.version+"\"\n";
        body += "\t\t\""+projectConfig.description+"\"\n";
        body += "\t\t\""+projectConfig.url+"\")\n\n";
 
        body += "pull_extra_module(\"PhoenixDataStream\" \"https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS2/PhoenixDataStream.git\")\n";
        body += "pull_extra_module(\"PhoenixTypeStream\" \"https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS2/PhoenixTypeStream.git\")\n\n";
 
        body += "phoenix_include_directories(\n";
        body += "\t${CMAKE_CURRENT_SOURCE_DIR}\n";
        body += "\t${CMAKE_CURRENT_BINARY_DIR}\n";
        body += "\t${CMAKE_CURRENT_SOURCE_DIR}/src\n";
        body += ")\n\n";
        body += "phoenix_create_find("+projectConfig.name+" "+projectConfig.name.toLower()+" "+baseConfigClassName+".h "" PhoenixDataStream PhoenixTypeStream)\n\n";
        body += "add_subdirectory(src)\n\n";
        body += "phoenix_tests()\n";
        
        return fileName.saveFileContent(body);
}
 
 
bool project_generator_readme(const PPath & fileName, const ProjectConfig & projectConfig){
        PString body, mainBranch(projectConfig.mainBranch);
        body += "![PLIBS_9 logo](doc/logo.png)\n\n";
        
        body += "----\n";
        body += "[![pipeline status]("+projectConfig.url+"/badges/"+mainBranch+"/pipeline.svg)]("+projectConfig.url+"/-/commits/"+mainBranch+")\n";
        body += "[![coverage report]("+projectConfig.url+"/badges/"+mainBranch+"/coverage.svg)]("+projectConfig.url+"/-/commits/"+mainBranch+")\n\n";
        
        body += "# Remarks\n\n";
        body += "This project was generated automatically by [phoenix_filegenerator](https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS2/PhoenixFileGenerator)\n";
        body += "using [phoenix_generator](https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS2/PhoenixGenerator) library\n\n";
        
        body += "# Code\n\n";
        body += "Version : " + projectConfig.version + "\n\n";
        body += projectConfig.url + "\n\n";
        body += "# Description\n\n";
        body += projectConfig.description + "\n\n";
        
        PString docPagesUrl = getGitlabDocUrl(projectConfig.url);
        if(docPagesUrl != ""){
                body += "# Documentation\n\n";
                body += "[See the pages documentation](" + docPagesUrl + ")\n\n";
        }
        body += "# Requirements\n\n";
        body += "- c++ compiler (tested with g++ 11,12 and clang 14)\n";
        body += "- [PhoenixCMake](https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS2/PhoenixCMake)\n";
        body += "- cmake > 3\n";
        body += "- make\n\n";
 
        body += "# Installation for Users\n\n";
 
        body += "```sh\n";
        body += "git clone "+projectConfig.url+".git\n";
        body += "cd "+projectConfig.name+"\n";
        body += "./install.sh\n";
        body += "```\n\n";
 
        return fileName.saveFileContent(body);
}
 
 
bool project_generator_gitignore(const PPath & fileName){
        PString body;
        body += "build\n";
        body += "build2\n";
        body += ".kdev4/\n";
        body += "*.kdev4\n";
        body += ".tmp_project/\n";
        body += "tmp_project/\n\n";
        return fileName.saveFileContent(body);
}
 
 
bool project_generator_gitlabci(const PPath & fileName, const ProjectConfig & projectConfig){
        PString specificRunnerTag;
        if(projectConfig.runnerTag != ""){
                specificRunnerTag += "        tags:\n";
                specificRunnerTag += "                - "+projectConfig.runnerTag+"\n";
        }
        
        PString body;
        body += "\n";
        body += getCMakeListsHeader();
        body += "\nstages:\n";
        body += "- BuildTestinstall\n";
        body += "- DocCoverage\n";
        body += "- deploy\n\n";
        
        body += "dailyBuildMasterAll:\n";
        body += "        image: gitlab-registry.in2p3.fr/cta-lapp/phoenix_libs2/phoenixcmake/phoenix_cmake_ubuntu_2204:latest\n";
        body += "        stage: BuildTestinstall\n";
        body += "        script:\n";
        body += "        - export LD_LIBRARY_PATH=/usr/lib\n";
        body += "        - env\n";
        body += "        - mkdir -p build\n";
        body += "        - cd build\n";
        body += "        - >\n";
        body += "                cmake ..\n";
        body += "                -DCMAKE_INSTALL_PREFIX=/usr\n";
        body += "                -DSELF_TESTS_MODE=yes\n";
        body += "                -DCMAKE_MODULE_PATH=/usr/share/cmake/Modules\n";
        body += "        - make all\n";
        body += "        - make install\n";
        body += "        - make test\n";
        body += "        only:\n";
        body += "        - branches\n";
        body += "        - tags\n";
        body += specificRunnerTag;
        body += "\n";
        
        body += "TestCoverage:\n";
        body += "        image: gitlab-registry.in2p3.fr/cta-lapp/phoenix_libs2/phoenixcmake/phoenix_cmake_ubuntu_2204:latest\n";
        body += "        stage: DocCoverage\n";
        body += "        script:\n";
        body += "        - export LD_LIBRARY_PATH=/usr/lib\n";
        body += "        - env\n";
        body += "        - mkdir -p build coverage\n";
        body += "        - cd build\n";
        body += "        - >\n";
        body += "                cmake ..\n";
        body += "                -DCMAKE_INSTALL_PREFIX=/usr\n";
        body += "                -DSELF_TESTS_MODE=yes\n";
        body += "                -DCMAKE_BUILD_TYPE=Coverage\n";
        body += "                -DCMAKE_MODULE_PATH=/usr/share/cmake/Modules\n";
        body += "        - make all\n";
        body += "        - make install\n";
        body += "        - make test\n";
        body += "        - ./uninstall_"+projectConfig.name.toLower()+"\n";
        body += "        - cd ../coverage\n";
        body += "        - gcovr -r ../ --exclude-throw-branches --html cov_report.html --html-details\n";
        body += "        - gcovr -r ../ --exclude-throw-branches --xml Coverage.xml\n";
        body += "        - gcovr -r ../ --exclude-throw-branches\n";
        body += "        coverage: '/TOTAL.*\\s+(\\d+\\%)$/'\n";
        body += "        artifacts:\n";
        body += "                paths:\n";
        body += "                - coverage\n";
        body += "                expire_in: 8d\n";
        body += "        only:\n";
        body += "        - branches\n";
        body += "        - tags\n";
        body += specificRunnerTag;
        body += "\n";
        body += "Doc:\n";
        body += "        image: gitlab-registry.in2p3.fr/cta-lapp/phoenix_libs2/phoenixcmake/phoenix_cmake_ubuntu_2204:latest\n";
        body += "        stage: DocCoverage\n";
        body += "        script:\n";
        body += "        - export LD_LIBRARY_PATH=/usr/lib\n";
        body += "        - env\n";
        body += "        - rm -fr build public\n";
        body += "        - mkdir -p build\n";
        body += "        - mkdir -p public\n";
        body += "        - cd build\n";
        body += "        - >\n";
        body += "                cmake ..\n";
        body += "                -DCMAKE_INSTALL_PREFIX=/usr\n";
        body += "                -DDOC_MODE=yes\n";
        body += "                -DCMAKE_MODULE_PATH=/usr/share/cmake/Modules\n";
        body += "        - make all\n";
        body += "        - make doc\n";
        body += "        - scp -r doc/html/* ../public\n";
        body += "        artifacts:\n";
        body += "                paths:\n";
        body += "                - public\n";
        body += "                expire_in: 8d\n";
        body += "        only:\n";
        body += "        - branches\n";
        body += "        - tags\n";
        body += specificRunnerTag;
        body += "\n";
        body += "pages:\n";
        body += "        stage: deploy\n";
        body += "        image: gitlab-registry.in2p3.fr/cta-lapp/phoenix_libs2/phoenixcmake/phoenix_cmake_ubuntu_2204:latest\n";
        body += "        script:\n";
        body += "        - mv coverage public/\n";
        body += "        artifacts:\n";
        body += "                paths:\n";
        body += "                - public\n";
        body += "                expire_in: 8d\n";
        body += specificRunnerTag;
        body += "\n";
        
        return fileName.saveFileContent(body);
}
 
 
bool project_generator(const PPath & descriptionFile, const PPath & configFile, bool isPythonWrapper){
        //First, let's read the toml config of the project
        ProjectConfig projectConfig;
        if(!project_generator_loadConfig(projectConfig, descriptionFile)){
                std::cerr << "project_generator : cannot parse project description file '"<<descriptionFile<<"'" << std::endl;
                return false;
        }
        //Then, let's create the hierarchy
        PPath mainProjectDir(projectConfig.name);
        if(!mainProjectDir.createDirectory()){
                std::cerr << "project_generator : cannot create main directory of project '"<<mainProjectDir<<"'" << std::endl;
                return false;
        }
        //And src dir
        PPath mainProjectSrc(mainProjectDir / PPath("src"));
        if(!mainProjectSrc.createDirectory()){
                std::cerr << "project_generator : cannot create source directory of project '"<<mainProjectSrc<<"'" << std::endl;
                return false;
        }
        //Let's generate sources
        PString className = configFile.getFileName().eraseExtension();
        if(!saveParserClassConfig(mainProjectSrc / className, configFile, true, true, true, mainProjectDir, projectConfig.name.toLower())){
                std::cerr << "project_generator : can't save file '"<<className<<"'[.h or .cpp]" << std::endl;
                return false;
        }
        //Now, some CMakeLists.txt of the sources
        PPath cmakeListsSrc(mainProjectSrc / PPath("CMakeLists.txt"));
        if(!project_generator_cmakeListsSrc(cmakeListsSrc, projectConfig.name, projectConfig.name.toLower())){return false;}
        //The main CMakeLists
        PPath cmakeListsMain(mainProjectDir / PPath("CMakeLists.txt"));
        if(!project_generator_cmakeListsMain(cmakeListsMain, projectConfig, configFile.getFileName().eraseExtension())){return false;}
        //CMakeLists of the tests
        PPath cmakeListsTest(mainProjectDir / PPath("TESTS/CMakeLists.txt"));
        if(!project_generator_cmakeListsTest(cmakeListsTest, configFile.getFileName().eraseExtension())){return false;}
        //The readme
        PPath readmeFile(mainProjectDir / PPath("README.md"));
        if(!project_generator_readme(readmeFile, projectConfig)){return false;}
        //The gitignore
        PPath gitignoreFile(mainProjectDir / PPath(".gitignore"));
        if(!project_generator_gitignore(gitignoreFile)){return false;}
        
        PPath gitlabciFile(mainProjectDir / PPath(".gitlab-ci.yml"));
        if(!project_generator_gitlabci(gitlabciFile, projectConfig)){return false;}
        if(isPythonWrapper){
                return project_wrapper_generator(projectConfig, configFile);
        }
        return true;
}