restructure example projects

Author: lganzzzo

CMakeLists.txt

@@ -1,42 +1,47 @@
 cmake_minimum_required(VERSION 3.1)
-project(project-loader)
+project(crud)
+
+set(CMAKE_CXX_STANDARD 11)
+
+add_library(crud-lib
+        src/AppComponent.hpp
+        src/SwaggerComponent.hpp
+        src/controller/UserController.hpp
+        src/db/Database.cpp
+        src/db/Database.hpp
+        src/db/model/User.hpp
+        src/dto/UserDto.hpp
+)
 
-include(ExternalProject)
+## include directories
 
-#############################################################################
-## load all dependencies
+target_include_directories(crud-lib PUBLIC src)
 
-ExternalProject_Add(oatpp
-        GIT_REPOSITORY "https://github.com/oatpp/oatpp.git"
-        GIT_TAG origin/master
-        CMAKE_ARGS -DOATPP_BUILD_TESTS=OFF
-)
 
-ExternalProject_Add(oatpp_swagger
-        GIT_REPOSITORY "https://github.com/oatpp/oatpp-swagger.git"
-        GIT_TAG origin/master
-        DEPENDS oatpp
-)
+## link libs
+
+find_package(oatpp          0.19.4 REQUIRED)
+find_package(oatpp-swagger  0.19.4 REQUIRED)
 
-ExternalProject_Add(main
-        SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/main
-        INSTALL_COMMAND cmake -E echo "SKIP INSTALL"
-        DEPENDS oatpp oatpp_swagger
+target_link_libraries(crud-lib
+        PUBLIC oatpp::oatpp
+        PUBLIC oatpp::oatpp-swagger
 )
 
-#############################################################################
-## make run command
+## define path to swagger-ui res folder
 
-ExternalProject_Get_Property(main BINARY_DIR)
+add_definitions(-DOATPP_SWAGGER_RES_PATH="${oatpp-swagger_INCLUDE_DIRS}/../bin/oatpp-swagger/res")
 
-add_custom_target(run
-        COMMAND ${BINARY_DIR}/crud-exe
-        DEPENDS main
-        WORKING_DIRECTORY ${BINARY_DIR}
-)
 
-#############################################################################
-## make test command
+## add executables
+
+add_executable(crud-exe src/App.cpp)
+target_link_libraries(crud-exe crud-lib)
+
+add_executable(crud-test
+        test/tests.cpp
+)
+target_link_libraries(crud-test crud-lib)
 
 enable_testing()
-add_test(all-tests ${BINARY_DIR}/crud-test)
+add_test(project-tests ${project_name}-test)

Dockerfile

@@ -2,11 +2,15 @@ FROM lganzzzo/alpine-cmake:latest
 
 ADD . /service
 
+WORKDIR /service/utility
+
+RUN ./install-oatpp-modules.sh
+
 WORKDIR /service/build
 
 RUN cmake ..
 RUN make
 
 EXPOSE 8000 8000
 
-ENTRYPOINT ["make", "run"]
+ENTRYPOINT ["./crud-exe"]

README.md

@@ -13,25 +13,19 @@ 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     // projects CMakeLists.txt
-    |- src/               // source folder
-    |- test/              // test folder
-
-```
-```
+- CMakeLists.txt                        // projects CMakeLists.txt
 - src/
     |
-    |- controller/              // Folder containing UserController where all endpoints are declared
-    |- db/                      // Folder with database mock
-    |- dto/                     // DTOs are declared here
-    |- SwaggerComponent.hpp     // Swagger-UI config
-    |- AppComponent.hpp         // Service config
-    |- Logger.hpp               // Application Logger
-    |- App.cpp                  // main() is here
+    |- controller/                      // Folder containing UserController where all endpoints are declared
+    |- db/                              // Folder with database mock
+    |- dto/                             // DTOs are declared here
+    |- SwaggerComponent.hpp             // Swagger-UI config
+    |- AppComponent.hpp                 // Service config
+    |- Logger.hpp                       // Application Logger
+    |- App.cpp                          // main() is here
+
+- test/                                 // test folder
+- utility/install-oatpp-modules.sh      // utility script to install required oatpp-modules.
     
 ```
 
@@ -41,11 +35,16 @@ This project is using `oatpp` and `oatpp-swagger` modules.
 
 #### Using CMake
 
+**Requires**
+
+- `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 
+$ ./crud-exe        # - run application.
 ```
 
 #### In Docker

azure-pipelines.yml

@@ -14,6 +14,10 @@ jobs:
     workspace:
       clean: all
     steps:
+      - script: |
+          sudo ./install-oatpp-modules.sh
+        displayName: 'install oatpp modules'
+        workingDirectory: utility
       - script: |
           mkdir build
       - script: |
@@ -24,4 +28,4 @@ jobs:
       - script: |
           make test ARGS="-V"
         displayName: 'Test'
-        workingDirectory: build
+        workingDirectory: build