Merge pull request #13 from norlab-ulaval/feat-extend-dna-version-command-to-provide-more-details-NMO-731

Enhance version command, fix installer and init issues, standardize project naming

Author: RedLeader962

.aiignore

@@ -6,7 +6,7 @@
 /.junie/scratch.md
 /.junie/recipes.md
 
-# ....Dockerized-NorLab Project related............................................................
+# ....dockerized-norlab-project related............................................................
 /external_data/
 /artifact/
 /tests/artifact/

.env.dockerized-norlab-project

@@ -13,62 +13,54 @@
 #
 # =================================================================================================
 
-#PROJECT_PROMPT_NAME="DNA"
-#PROJECT_PROMPT_NAME="DN"
-PROJECT_PROMPT_NAME="dna"
+# ====UI===========================================================================================
+# ....Console prompt...............................................................................
+PROJECT_PROMPT_NAME="dna" # <- N2ST override
+DNA_PROMPT_NAME="${PROJECT_PROMPT_NAME}"
 
+# ....Console splash...............................................................................
 #DNA_SPLASH_NAME_FULL="Dockerized-NorLab"
 #DNA_SPLASH_NAME_FULL="Dockerized-NorLab (DN/DNA)"
-#DNA_SPLASH_NAME_FULL="         Dockerized-NorLab (DN)         "
 #DNA_SPLASH_NAME_FULL=" Dockerized-NorLab project application "
 #DNA_SPLASH_NAME_FULL="Dockerized-NorLab project app"
+#DNA_SPLASH_NAME_FULL="         Dockerized-NorLab (DN)         "
 DNA_SPLASH_NAME_FULL="      Dockerized-NorLab project app     "
 #DNA_SPLASH_NAME_FULL="Dockerized-NorLab project app (DNA)"
 #DNA_SPLASH_NAME_FULL="Dockerized-NorLab app (DNA)"
 DNA_SPLASH_NAME_SMALL="Dockerized-NorLab"
 #DNA_SPLASH_NAME_SMALL="DNA"
 #DNA_SPLASH_NAME_SMALL="·• DNA"
 #DNA_SPLASH_NAME_SMALL="···•· DNA ··••"
-#DNA_SPLASH_NAME_SMALL="    Dockerized-NorLab  "
 #DNA_SPLASH_NAME_SMALL="❄︎ Dockerized-NorLab"
 NBS_SPLASH_NAME="${PROJECT_PROMPT_NAME}-build-system"
 
-# ....Programaticaly fetch source code information.................................................
-# (NICE TO HAVE) ToDo: assessment >> next bloc ↓↓
-PROJECT_PATH="$( git rev-parse --show-toplevel )"
-#PROJECT_GIT_REMOTE_URL="$( git remote get-url origin )"
-#PROJECT_GIT_NAME="$( basename "${PROJECT_GIT_REMOTE_URL}" .git )"
-#PROJECT_SRC_NAME="$( basename ${PROJECT_PATH} )"
-
-# ....Set project related environment variable with their own prefix...............................
-# Note: Those with "PROJECT_" prefix will get eventualy overiden in the case where N2ST is used
-#       as a library. Using generic testing logic require that environment variables with
-#       "PROJECT_" prefix be available.
-DNA_PROMPT_NAME="${PROJECT_PROMPT_NAME}"
+# ....Repository...................................................................................
 DNA_GIT_REMOTE_URL="https://github.com/norlab-ulaval/dockerized-norlab-project"
-DNA_GIT_NAME="dockerized-norlab-project"
-#DNA_SRC_NAME="dockerized-norlab-project"
+DNA_HUMAN_NAME="Dockerized-NorLab project application"
+DNA_TECH_NAME="dockerized-norlab-project"
+
+# ====Internal=====================================================================================
+# ....DNA path.....................................................................................
+PROJECT_PATH="$( git rev-parse --show-toplevel )" # <- N2ST override
+DNA_ROOT="${PROJECT_PATH}"
+DNA_PATH="${DNA_ROOT}/src/bin"
+DNA_LIB_PATH="${DNA_ROOT}/src/lib"
+DNA_LIB_EXEC_PATH="${DNA_LIB_PATH}/core/execute"
+DNA_MOCK_SUPER_PROJECT_ROOT="${DNA_ROOT}/utilities/tmp/dockerized-norlab-project-mock"
 
-# ....Set dependencies path........................................................................
+# ....Dependencies path............................................................................
 N2ST_PATH="${PROJECT_PATH}/utilities/norlab-shell-script-tools"
 NBS_PATH="${PROJECT_PATH}/utilities/norlab-build-system"
 
-NBS_VERSION="$(cat ${NBS_PATH}/version.txt)"
-N2ST_VERSION="$(cat ${N2ST_PATH}/version.txt)"
-
-# ====DNA==========================================================================================
+# ====Version======================================================================================
+# ....DNA..........................................................................................
 DNA_VERSION="$(cat ${PROJECT_PATH}/version.txt)"
 DNA_CONFIG_SCHEME_VERSION=1
 
-# ....internal.....................................................................................
-DNA_ROOT="${PROJECT_PATH}"
-
-DNA_PATH="${DNA_ROOT}/src/bin"
-DNA_LIB_PATH="${DNA_ROOT}/src/lib"
-DNA_LIB_EXEC_PATH="${DNA_LIB_PATH}/core/execute"
-DNA_MOCK_SUPER_PROJECT_ROOT="${DNA_ROOT}/utilities/tmp/dockerized-norlab-project-mock"
+# ....Dependencies.................................................................................
+NBS_VERSION="$(cat ${NBS_PATH}/version.txt)"
+N2ST_VERSION="$(cat ${N2ST_PATH}/version.txt)"
 
-# ....dev..........................................................................................
+# ====Dev==========================================================================================
 DNA_DEBUG=false
 DNA_CLEAR_CONSOLE_ACTIVATED=false
-

.junie/plans/dna_stand_alone_refactoring_guideline.md

@@ -1,4 +1,4 @@
-# Dockerized-NorLab Project stand-alone refactoring guidelines
+# Dockerized-NorLab-Project stand-alone refactoring guidelines
 
 Stand-alone version with a PATH-accessible bash script approach
 This approach maintains the current bash script structure but makes it accessible from anywhere via the system `PATH`.

.junie/plans/offline_mode_analysis_report.md

@@ -2,7 +2,7 @@
 
 ## Executive Summary
 
-This report analyzes the Dockerized-NorLab Project (DNA) repository to identify implementation details that would prevent users from running `dna` in offline mode. After careful review and correction of initial misconceptions, the analysis shows that DNA can operate in offline mode with minimal or no modifications required.
+This report analyzes the Dockerized-NorLab project application (DNA) repository to identify implementation details that would prevent users from running `dna` in offline mode. After careful review and correction of initial misconceptions, the analysis shows that DNA can operate in offline mode with minimal or no modifications required.
 
 ## Key Findings
 

.junie/plans/readme_improvement_plan.md

@@ -27,7 +27,7 @@ The expected sections order should be the following:
 - _Description_
 - _What it does_
 - _Getting started_
-  - _Install Dockerized-NorLab Project app `dna`_
+  - _Install Dockerized-NorLab-Project app `dna`_
   - _Make a repository ready to use with DNA_
   - _Create, run and stop DN container_
 - _Why_

.junie/recipes.md

@@ -8,6 +8,7 @@ Execute all unit-tests and all integration tests before submiting.
 Add/refactor/improve TODO 
 Check if it introduce any breaking change in the code base by runnning both unit-tests and integration tests.
 Propose source code change if relevant. 
+Update Markdown documention accordingly. 
 
 Inspire yourself with `TODO`.
 
@@ -20,6 +21,7 @@ Create at least one test case per command argument and/or options.
 Test relevant option and arguments combinaison.
 You can mock their corresponding functions as the intended purposes of this test file is for unit-testing the CLI functionalities.
 Propose source code change if relevant. 
+Update Markdown documention accordingly. 
 Execute all unit-tests and all integration tests before submiting.
 
 ## Improve/refactor source code
@@ -32,6 +34,7 @@ Create at least one test case per new command argument and/or options, update cu
 Test relevant option and arguments combinaison.
 Check if it introduce any breaking change in the code base by runnning both unit-tests and integration tests.
 Propose source code change if relevant.
+Update Markdown documention accordingly. 
 Execute all unit-tests and all integration tests before submiting.
 
 ## Modify proposed tests solutions 

.junie/scratch.md

@@ -1,6 +1,15 @@
 
 # Scratch
 
+Update bats test at `tests/tests_bats/test_version.bats` considering change made to `src/lib/commands/version.bash`.
+Follow guidelines at `.junie/guidelines.md`.
+Create at least one test case per new command argument and/or options, update current tests cases otherwise.
+Propose source code change if relevant. 
+Update Markdown documention accordingly. 
+Check if it introduce any breaking change in the code base by runnning both unit-tests and integration tests.
+
+---
+
 Read and implement the updated plan at `.junie/plans/documentation_updates_proposal.md`.
 Follow guidelines at `.junie/guidelines.md`.
 

Vagrantfile

@@ -148,20 +148,20 @@ Vagrant.configure("2") do |config|
 
   # Ressetting
   rm -f /usr/local/bin/dna
-  sed -i '/# >>>> Dockerized-NorLab Project (start)/,/# <<<< Dockerized-NorLab Project (end)/d' "${HOME}/.bashrc"
-  sed -i '/# >>>> Dockerized-NorLab Project CUDA (start)/,/# <<<< Dockerized-NorLab Project CUDA (end)/d' "${HOME}/.bashrc"
-  sed -i '/# >>>> Dockerized-NorLab Project DEV alias (start)/,/# <<<< Dockerized-NorLab Project DEV alias (end)/d' "${HOME}/.bashrc"
+  sed -i '/# >>>> dockerized-norlab-project (start)/,/# <<<< dockerized-norlab-project (end)/d' "${HOME}/.bashrc"
+  sed -i '/# >>>> dockerized-norlab-project CUDA (start)/,/# <<<< dockerized-norlab-project CUDA (end)/d' "${HOME}/.bashrc"
+  sed -i '/# >>>> dockerized-norlab-project DEV alias (start)/,/# <<<< dockerized-norlab-project DEV alias (end)/d' "${HOME}/.bashrc"
 
   echo -e "\nSet DEV aliases\n"
   {
       echo "" ;
-      echo "# >>>> Dockerized-NorLab Project DEV alias (start)" ;
+      echo "# >>>> dockerized-norlab-project DEV alias (start)" ;
       echo "alias dna-dna-cd='cd /opt/dockerized-norlab-project'" ;
 #       echo "alias dna-mock-cd='cd /opt/dockerized-norlab-project/utilities/tmp/dockerized-norlab-project-mock'" ;
       echo "alias dna-mock-empty-cd='cd /opt/dockerized-norlab-project-mock-EMPTY'" ;
       echo "alias dna-test-symlink='tree -L 1 -a /usr/local/bin/'" ;
       echo "alias dna-test-bashrc='tail -n 20 ~/.bashrc'" ;
-      echo "# <<<< Dockerized-NorLab Project DEV alias (end)" ;
+      echo "# <<<< dockerized-norlab-project DEV alias (end)" ;
       echo "" ;
   } >> /home/vagrant/.bashrc
 

documentation/command/version.md

@@ -1,6 +1,6 @@
 # dna version
 
-Show Dockerized-NorLab Project version information.
+Show Dockerized-NorLab project application version information.
 
 ## Synopsis
 
@@ -10,58 +10,88 @@ dna version [OPTIONS]
 
 ## Description
 
-The `dna version` command displays the current version of the Dockerized-NorLab Project (DNA) application. This is useful for troubleshooting, compatibility checking, and ensuring you're running the expected version.
+The `dna version` command displays the current version of Dockerized-NorLab project application. This is useful for troubleshooting, compatibility checking, and ensuring you're running the expected version.
 
 ## Options
 
 | Option | Description |
 |--------|-------------|
+| `--short`, `-s` | Show version number only |
+| `--all`, `-a` | Show detailed version information |
 | `--help`, `-h` | Show help message and exit |
 
-## Examples
+## Output Examples
 
-### Basic Version Display
+### Default Version Display
 
 ```bash
-# Show DNA version
-dna version
+$ dna version
+Dockerized-NorLab project application version 1.2.3
 ```
 
-### Output Example
+### Short Version Display
+Show only version number
 
 ```bash
-$ dna version
-Dockerized-NorLab Project version: 1.2.3
+$ dna version --short
+1.2.3
+```
+
+### Detailed Version Display
+Show comprehensive version information
+
+```bash
+dna version --all
+$ dna version --all
+Dockerized-NorLab project application:
+  Version: 1.2.3
+  Config scheme version: 1
+  Submodule version:
+    norlab-shell-script-tools: 2.0.0
+    norlab-build-system: 3.0.0
+  Local repository:
+    Current branch: main
+    Current commit: abc123def456
+  Host architecture and OS: linux/amd64
 ```
 
+## Version Information
+
+### Version Format
+
+DNA follows semantic versioning (SemVer):
+- **Format**: `MAJOR.MINOR.PATCH`
+- **Example**: `1.2.3`
+  - `1` - Major version (breaking changes)
+  - `2` - Minor version (new features, backward compatible)
+  - `3` - Patch version (bug fixes, backward compatible)
+
+### Version Source
+
+The version information is obtained from:
+- **Environment Variables**: DNA_VERSION, DNA_CONFIG_SCHEME_VERSION, N2ST_VERSION, NBS_VERSION
+- **Git Repository**: Current branch and commit information
+- **System**: Host architecture and OS information
+
+
 ## Use Cases
 
 ### Version Verification
 
 ```bash
-# Check current DNA version
-dna version
-
-# Verify version in scripts
-DNA_VERSION=$(dna version | grep -o '[0-9]\+\.[0-9]\+\.[0-9]\+')
-echo "Running DNA version: $DNA_VERSION"
+# Get just the version number for scripts
+$ echo "Running DNA version: $(dna version --short)"
+Running DNA version: 1.2.3
 ```
 
 ### Compatibility Checking
 
 ```bash
 # Check version before running commands
-dna version
-dna build develop  # Ensure compatibility
-```
-
-### Troubleshooting
-
-```bash
-# Include version in bug reports
-echo "DNA Version: $(dna version)"
-echo "Docker Version: $(docker --version)"
-echo "System: $(uname -a)"
+$ dna version --all | grep -e "Config scheme version"
+Config scheme version: 1
+$ cat .dockerized_norlab/.env.dockerized-norlab-project-mock | grep DNA_CONFIG_SCHEME_VERSION
+DNA_CONFIG_SCHEME_VERSION=1
 ```
 
 ### CI/CD Integration
@@ -74,23 +104,19 @@ docker --version
 docker-compose --version
 ```
 
-## Version Information
-
-### Version Format
-
-DNA follows semantic versioning (SemVer):
-- **Format**: `MAJOR.MINOR.PATCH`
-- **Example**: `1.2.3`
-  - `1` - Major version (breaking changes)
-  - `2` - Minor version (new features, backward compatible)
-  - `3` - Patch version (bug fixes, backward compatible)
-
-### Version Source
+### Troubleshooting
 
-The version is read from:
-- **File**: `${DNA_ROOT}/version.txt`
-- **Location**: DNA installation directory
-- **Format**: Plain text file containing version string
+```bash
+# Include comprehensive version information in bug reports
+cat > "mock_bug_report.log" << EOF
+=== DNA Version Information ===
+$(dna version --all)
+
+=== Docker Information ===
+Docker Version: $(docker --version)
+Docker Compose Version: $(docker-compose --version)
+EOF
+```
 
 ## Integration with Other Tools
 
@@ -100,12 +126,16 @@ The version is read from:
 #!/bin/bash
 # Check DNA version compatibility
 REQUIRED_VERSION="1.2.0"
-CURRENT_VERSION=$(dna version | grep -o '[0-9]\+\.[0-9]\+\.[0-9]\+')
+CURRENT_VERSION=$(dna version --short)
 
-if [[ ${CURRENT_VERSION} -lt ${REQUIRED_VERSION} ]]; then
+if [[ ${CURRENT_VERSION} < ${REQUIRED_VERSION} ]]; then
     echo "Error: DNA version ${CURRENT_VERSION} is too old. Required: ${REQUIRED_VERSION}"
     exit 1
 fi
+
+# Get detailed information for logging
+echo "=== DNA Environment ==="
+dna version --all
 ```
 
 ### Docker Image Tagging
@@ -151,19 +181,6 @@ echo "Generated with DNA version: $(dna version)" >> README.md
 
 ### Permission Issues
 
-**Problem**: Cannot read version file.
-
-**Solutions**:
-1. **Check permissions**: Verify file permissions
-   ```bash
-   ls -la ${DNA_ROOT}/version.txt
-   ```
-
-2. **Fix permissions**: Correct file permissions if needed
-   ```bash
-   chmod 644 ${DNA_ROOT}/version.txt
-   ```
-
 ### Incorrect Version Display
 
 **Problem**: Version shows unexpected value.
@@ -178,6 +195,8 @@ echo "Generated with DNA version: $(dna version)" >> README.md
 2. **Check version file**: Manually inspect version file
    ```bash
    cat ${DNA_ROOT}/version.txt
+   # compare with 
+   dna version --short
    ```
 
 ## Version History and Compatibility