restructure example projects

Author: lganzzzo

CMakeLists.txt

@@ -2,44 +2,85 @@ cmake_minimum_required(VERSION 3.1)
 
 set(project_name example-postgresql) ## rename your project here
 
-project(${project_name}-loader)
+project(${project_name})
 
-include(ExternalProject)
+set(CMAKE_CXX_STANDARD 11)
 
-#############################################################################
-## load all dependencies
+add_library(${project_name}-lib
+        src/App.cpp
+        src/AppComponent.hpp
+        src/ServiceComponent.hpp
+        src/SwaggerComponent.hpp
+        src/controller/UserController.cpp
+        src/controller/UserController.hpp
+        src/db/Database.cpp
+        src/db/Database.hpp
+        src/dto/ConfigDto.hpp
+        src/dto/ErrorDto.hpp
+        src/dto/UserDto.hpp
+)
+
+target_include_directories(${project_name}-lib PUBLIC src)
+
+## link libs
+
+find_package(oatpp          0.19.4 REQUIRED)
+find_package(oatpp-swagger  0.19.4 REQUIRED)
 
-ExternalProject_Add(oatpp
-        GIT_REPOSITORY "https://github.com/oatpp/oatpp.git"
-        GIT_TAG origin/master
-        CMAKE_ARGS -DOATPP_BUILD_TESTS=OFF
+target_link_libraries(${project_name}-lib
+        PUBLIC oatpp::oatpp
+        PUBLIC oatpp::oatpp-test
+        PUBLIC oatpp::oatpp-swagger
 )
 
-ExternalProject_Add(oatpp_swagger
-        GIT_REPOSITORY "https://github.com/oatpp/oatpp-swagger.git"
-        GIT_TAG origin/master
-        DEPENDS oatpp
+add_definitions(
+        # Path to swagger-ui resources #
+        -DOATPP_SWAGGER_RES_PATH="${oatpp-swagger_INCLUDE_DIRS}/../bin/oatpp-swagger/res"
+
+        # Path to config file #
+        -DCONFIG_PATH="${CMAKE_CURRENT_LIST_DIR}/resources/config.json"
 )
 
-ExternalProject_Add(main
-        SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/main
-        INSTALL_COMMAND cmake -E echo "SKIP INSTALL"
-        DEPENDS oatpp oatpp_swagger
+#################################################################
+## link postgresql client
+
+include(FindPkgConfig)
+
+set(ENV{PKG_CONFIG_PATH} "/usr/local/pgsql/lib/pkgconfig:$ENV{PKG_CONFIG_PATH}") ## change this if needed
+
+pkg_check_modules(PKG_PQ REQUIRED libpq)
+
+message("PKG_PQ_INCLUDE_DIRS=${PKG_PQ_INCLUDE_DIRS}")
+message("PKG_PQ_LIBRARY_DIRS=${PKG_PQ_LIBRARY_DIRS}")
+message("PKG_PQ_LIBRARIES=${PKG_PQ_LIBRARIES}")
+
+target_include_directories(${project_name}-lib
+        PUBLIC ${PKG_PQ_INCLUDE_DIRS}
 )
 
-#############################################################################
-## make run command
+link_directories(
+        ${PKG_PQ_LIBRARY_DIRS}
+)
 
-ExternalProject_Get_Property(main BINARY_DIR)
+target_link_libraries(${project_name}-lib
+        PUBLIC ${PKG_PQ_LIBRARIES}
+)
 
-add_custom_target(run
-        COMMAND ${BINARY_DIR}/${project_name}-exe
-        DEPENDS main
-        WORKING_DIRECTORY ${BINARY_DIR}
+#################################################################
+
+## add executables
+
+add_executable(${project_name}-exe
+        src/App.cpp
 )
+target_link_libraries(${project_name}-exe ${project_name}-lib)
+add_dependencies(${project_name}-exe ${project_name}-lib)
 
-#############################################################################
-## make test command
+add_executable(${project_name}-test
+        test/tests.cpp
+)
+target_link_libraries(${project_name}-test ${project_name}-lib)
+add_dependencies(${project_name}-test ${project_name}-lib)
 
 enable_testing()
-add_test(all-tests ${BINARY_DIR}/${project_name}-test)
+add_test(project-tests ${project_name}-test)

Dockerfile

@@ -4,11 +4,15 @@ RUN apk add postgresql-dev
 
 ADD . /service
 
+WORKDIR /service/utility
+
+RUN ./install-oatpp-modules.sh
+
 WORKDIR /service/build
 
 RUN cmake ..
 RUN make
 
 EXPOSE 8000 8000
 
-ENTRYPOINT ["make", "run"]
+ENTRYPOINT ["./example-postgresql-exe"]

README.md

@@ -5,30 +5,26 @@ Example of a production grade entity service storing information in PostgreSQL.
 *Dockerfile and docker-compose.yaml files included.*
 
 #### More about oat++:
+
 - Website: [https://oatpp.io](https://oatpp.io)
 - Docs: [https://oatpp.io/docs/start](https://oatpp.io/docs/start)
 - Oat++ Repo: [https://github.com/oatpp/oatpp](https://github.com/oatpp/oatpp)
 
 ## Overview
+
 This project is using `oatpp` and `oatpp-swagger` modules.
 
 ### Project layout
 
 ```
 
-|- CMakeLists.txt               // project loader script. load and build dependencies 
-|- main/                        // main project directory
-|    |
-|    |- CMakeLists.txt          // project's CMakeLists.txt
-|    |- src/                    // source folder
-|    |- test/                   // test folder
-|    |- resources/
-|         |
-|         |- config.json        // configuration file with configuration profiles
-|
-|- Dockerfile                   // Dockerfile
-|- docker-compose.yaml          // Docker-compose with this service and postgresql
-
+- CMakeLists.txt                        // projects CMakeLists.txt
+- src/                                  // source folder
+- test/                                 // test folder
+- utility/install-oatpp-modules.sh      // utility script to install required oatpp-modules.
+- resources/config.json                 // configuration file with configuration profiles
+- Dockerfile                            // Dockerfile
+- docker-compose.yaml                   // Docker-compose with this service and postgresql
 ```
 ```
 - src/
@@ -50,15 +46,21 @@ This project is using `oatpp` and `oatpp-swagger` modules.
 
 ### Using CMake
 
-**Requires libpq installed**. To install libpq:  
-- On Mac `$ brew install libpq`
-- On Alpine `$ apk add postgresql-dev`
-- On Ubuntu - goto [Install PostgreSQL Client From Sources](#install-postgresql-client-from-sources)
+**Requires** 
+
+- libpq installed. To install libpq:  
+   - On Mac `$ brew install libpq`
+   - On Alpine `$ apk add postgresql-dev`
+   - On Ubuntu - goto [Install PostgreSQL Client From Sources](#install-postgresql-client-from-sources)
+   
+- `oatpp` and `oatpp-swagger` modules installed. You may run `utility/install-oatpp-modules.sh` 
+script to install required oatpp modules.   
 
 ```
 $ mkdir build && cd build
 $ cmake ..
-$ make run        ## Download, build, and install all dependencies. Run project
+$ make 
+$ ./example-postgresql-exe  # - run application.
 ```
 
 *PostgreSQL is expected running as for `dev` config profile*

azure-pipelines.yml

@@ -14,9 +14,12 @@ jobs:
     workspace:
       clean: all
     steps:
+      - script: |
+          sudo ./install-oatpp-modules.sh
+        displayName: 'install oatpp modules'
+        workingDirectory: utility
       - script: |
           mkdir build
-      - task: CMake@1
       - script: |
           cmake ..
           sudo make
@@ -25,4 +28,4 @@ jobs:
       - script: |
           make test ARGS="-V"
         displayName: 'Test'
-        workingDirectory: build
+        workingDirectory: build