Merge pull request #5 from noprd/staging

Staging ---> Main

Author: noprd

.gitignore

@@ -8,6 +8,7 @@
 # ----------------------------------------------------------------
 
 !/README.md
+!/ISSUES.md
 !/LICENCE
 !/justfile
 !/Cargo.toml

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "example-rust"
-version = "0.0.0"
+version = "0.0.0-a"
 edition = "2021"
 rust-version = "1.80.1"
 authors = [

Cargo.toml

@@ -6,7 +6,7 @@ FROM rust:1.80.1-slim AS stage-basic
 
 ARG USER
 ARG APP
-ARG WORKDIR
+ARG WD
 ARG HTTP_IP
 ARG HTTP_PORT
 ARG HTTP_USER
@@ -21,11 +21,11 @@ RUN groupadd --gid 999 ${USER} \
     && useradd --uid 1001 --gid 999 --create-home ${USER}
 
 # Running instance should own the code, as task automation leads to changes.
-COPY . ${WORKDIR}
-RUN chown -R ${USER}:${USER} ${WORKDIR}
+COPY . ${WD}
+RUN chown -R ${USER}:${USER} ${WD}
 
 USER root
-WORKDIR ${WORKDIR}
+WORKDIR ${WD}
 COPY . .
 
 FROM stage-basic AS stage1

Dockerfile

@@ -0,0 +1,35 @@
+# Issues #
+
+## Posix bug ##
+
+### Description ###
+
+When expanding the environment variable `WD`
+from [docker-compose.yaml](docker-compose.yaml) in [Dockerfile](Dockerfile),
+and running `docker compose up --build -d ...`
+(see [justfile](justfile) > command: `just docker-build`)
+paths like `/usr/home/myapp` would be bafflingly
+replaced by `C:/Program Files/Git/usr/home/myapp`.
+
+### Diagnosis ###
+
+This bug occurs on Windows when using the Git Bash console
+as is a known issue, see <https://github.com/git-for-windows/build-extra/blob/main/ReleaseNotes.md>.
+
+### Solution ###
+
+Whilst there a new release of Git Bash may solve this issue,
+a work around that work with older versions is to simply replace
+
+```.env
+DOCKER_WORKDIR="/usr/home/${DOCKER_APP}"
+```
+
+via
+
+```.env
+DOCKER_WORKDIR="//usr/home/${DOCKER_APP}"
+```
+
+in the [.env](templates/template.env) file.
+By replacing `//` by `/`, such forced expansions are avoided.

ISSUES.md

@@ -146,4 +146,12 @@ docker system prune
 
 > [!WARNING]
 > The latter command clears _all_ docker images, containers, etc.
-> not just for this project.
+> not just for this project##
+
+## References ##
+
+Some of the source code (see [src/main.rs](src/main.rs))
+was initially adapted from the code in [@alfredodeza/rust-azure-function](https://github.com/alfredodeza/rust-azure-function).
+In our repository, we refactored this and took things in a completely different direction.
+We wrote the task scripts ([justfile](justfile)),
+docker infrastructure, etc. completely independently.

README.md

@@ -1 +1 @@
-0.0.0
+0.0.0-a

dist/VERSION

@@ -22,7 +22,7 @@ services:
       args:
         USER: "${DOCKER_USER}"
         APP: "${DOCKER_APP}"
-        WORKDIR: "${DOCKER_WORKDIR}"
+        WD: "${DOCKER_WORKDIR}"
         HTTP_IP: "0.0.0.0"
         # NOTE: only this is different
         HTTP_PORT: ${DOCKER_PORT_CONTAINER}

docker-compose.yaml

@@ -103,12 +103,6 @@ setup:
     @mkdir -p ".vscode"
     @- cp -n "templates/template.env" ".env"
     @- cp -n "templates/template-config.yaml" "setup/config.yaml"
-    @- cp -n "templates/template-extensions.json" ".vscode/extensions.json"
-    @- cp -n "templates/template-launch.json" ".vscode/launch.json"
-    @- cp -n "templates/template-settings.json" ".vscode/settings.json"
-    @- cp -n "templates/template-tasks.json" ".vscode/tasks.json"
-    @- cp -n "templates/template-host.json" "host.json"
-    @- cp -n "templates/template-local.settings.json" "local.settings.json"
 
 build:
     @echo "TASK: BUILD"

justfile

@@ -20,7 +20,8 @@ HTTP_PASSWORD="test1234"
 
 DOCKER_CONTAINER="example_rust"
 DOCKER_APP="${PROJECT_NAME}"
-DOCKER_WORKDIR="/usr/home/${DOCKER_APP}"
+# NOTE: '//' only necessary on windows to avoid a posix bug which expands paths in an undesirable way
+DOCKER_WORKDIR="//usr/home/${DOCKER_APP}"
 DOCKER_USER="nops"
 DOCKER_PORT_HOST=${HTTP_PORT}
 DOCKER_PORT_CONTAINER=8000