Initial version of a C++ development environment for training purposes.

CMakeLists.txt

@@ -0,0 +1,8 @@
+cmake_minimum_required(VERSION 3.20)
+
+project(all)
+enable_testing()
+
+add_subdirectory(example-unittest)
+add_subdirectory(example-library)
+add_subdirectory(example-executable)

README.md

@@ -0,0 +1,10 @@
+
+# Building the docker image
+
+The following command can be used to create the docker container image:
+``docker build -t cpp-devenv-in-docker -f cpp-code-server-devenv.Dockerfile .``
+
+To run the container there is only 2 things it really needs. A password, and a port on which
+code server will be reachable. The port that the image exposes is 8080, we map it to 7501
+``docker run -t -p 7501:8080 -e CODE_SERVER_PASSWD=YourPasswordHere cpp-devenv-in-docker``
+

cpp-code-server-devenv.Dockerfile

@@ -0,0 +1,52 @@
+# A Ubuntu based playground for C++ development in a training context.
+
+FROM ubuntu:latest
+
+# Install:
+#  - some useful tools.
+#  - a debugger.
+#  - some compilers.
+#  - some C++ libraries (boost, google test)
+#
+RUN apt-get update && apt-get install -y \
+    curl \
+    wget \
+    sudo \
+    python3 \
+    build-essential \
+    gdb \
+    git \
+    cmake \
+    ninja-build \
+    gcc-14 \
+    clang \
+    clangd \
+    libboost-all-dev \
+    libgtest-dev \
+    libgmock-dev
+
+# Install Code-Server (VS Code in the browser)
+# TODO: Fix that we are not running random scripts from the web.
+RUN curl -fsSL https://code-server.dev/install.sh | sh
+
+# Install some extensions we are going to use
+RUN code-server --install-extension ms-python.python && \
+    code-server --install-extension ms-vscode.cmake-tools && \
+    code-server --install-extension kylinideteam.cppdebug
+
+WORKDIR /workspace
+ADD CMakeLists.txt      .
+ADD example-executable example-executable
+ADD example-library    example-library
+ADD example-unittest   example-unittest
+
+WORKDIR /root
+ADD --chmod=544 docker-helper/entrypoint.py .
+ADD --chmod=544 docker-helper/entrypoint.sh .
+ADD --chmod=444 docker-helper/config.yaml .config/code-server/config.yaml
+
+# Expose port for Code-Server
+EXPOSE 8080
+
+# Start Code-Server on container launch
+CMD ["/root/entrypoint.sh"]

docker-helper/config.yaml

@@ -0,0 +1,4 @@
+bind-addr: 0.0.0.0:8080
+auth: password
+password: 0a520bf60575a012f41bf571
+cert: false

docker-helper/entrypoint.py

@@ -0,0 +1,40 @@
+#! /usr/bin/python3
+import argparse
+import yaml
+import os
+import subprocess
+import sys
+
+def runcmd(command):
+    print('RUN ' + command)
+    process = subprocess.Popen(command, stdout=subprocess.PIPE, shell=True)
+    for line in iter(process.stdout.readline, b''):  # b'' indicates EOF
+        print(line.decode('utf-8'), end='')
+
+# Read environment variable
+parser = argparse.ArgumentParser()
+parser.add_argument('--password')
+args = parser.parse_args()
+
+
+new_password = args.password
+if not isinstance(new_password , str):
+    print('ERROR: expect the password to be a string')
+    sys.exit(1)
+
+
+# Read code-server configuration and adjust the password according to ENV
+code_server_config_path = '.config/code-server/config.yaml';
+
+code_server_config = None
+with open(code_server_config_path, 'r') as file:
+    code_server_config = yaml.safe_load(file)
+
+if code_server_config is not None:
+    code_server_config['password'] = new_password
+    with open(code_server_config_path, 'w') as file:
+        yaml.dump(code_server_config, file)
+
+runcmd('code-server /workspace')
+
+sys.exit(0)

docker-helper/entrypoint.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+./entrypoint.py --password=$CODE_SERVER_PASSWD

example-executable/CMakeLists.txt

@@ -0,0 +1,13 @@
+cmake_minimum_required(VERSION 3.20)
+
+project(empty-executable)
+
+add_executable(
+    ${PROJECT_NAME}
+    main.cpp
+)
+
+set_property(
+    TARGET ${PROJECT_NAME}
+    PROPERTY CXX_STANDARD 23
+)

example-executable/main.cpp

@@ -0,0 +1,7 @@
+#include <iostream>
+
+int main(int argc, char** argv)
+{
+    std::cout << "Hello World" << std::endl;
+    return 1;
+}

example-library/CMakeLists.txt

@@ -0,0 +1,19 @@
+cmake_minimum_required(VERSION 3.20)
+
+project(example-library)
+
+add_library(
+    ${PROJECT_NAME}
+    ./src/sum.cpp
+    ./include/sum.h
+)
+
+set_property(
+    TARGET ${PROJECT_NAME}
+    PROPERTY CXX_STANDARD 23
+)
+
+target_include_directories(
+    ${PROJECT_NAME}
+    PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include
+)

example-library/include/sum.h

@@ -0,0 +1,6 @@
+#pragma once
+
+namespace example_library
+{
+    int sum(int a, int b);
+}

example-library/src/sum.cpp

@@ -0,0 +1,11 @@
+#include "sum.h"
+
+namespace example_library
+{
+
+int sum(int a, int b)
+{
+    return a + b;
+}
+
+}

example-unittest/CMakeLists.txt

@@ -0,0 +1,26 @@
+cmake_minimum_required(VERSION 3.20)
+
+find_package(GTest REQUIRED)
+include(GoogleTest)
+
+project(empty-unittest)
+add_test(NAME ${PROJECT_NAME} COMMAND ${PROJECT_NAME})
+
+add_executable(
+    ${PROJECT_NAME}
+    test.cpp
+)
+
+set_property(
+    TARGET ${PROJECT_NAME}
+    PROPERTY CXX_STANDARD 23
+)
+
+target_link_libraries(
+    ${PROJECT_NAME}
+    PUBLIC
+    example-library
+    GTest::gtest_main
+    GTest::gmock
+
+)

example-unittest/test.cpp

@@ -0,0 +1,8 @@
+#include <gmock/gmock.h>
+#include <gtest/gtest.h>
+#include "sum.h"
+
+TEST(Example, OK)
+{
+    EXPECT_EQ(42, example_library::sum(2, 40));
+}