Feature/improve azure function (#4)

bastgau · web-flow · commit 8346942a364b · 2024-04-19T14:51:38.000+02:00
Installation scripts improved.
Fix issue about the Azure Function Application.
Complete missing documentation.
diff --git a/.devcontainer/install/03-generate-file-vscode-extensions-json.sh b/.devcontainer/install/03-generate-file-vscode-extensions-json.sh
@@ -13,12 +13,12 @@ echo -e "${BLUE}#############################################################${E
 mkdir -p $SOURCE_PATH
 mkdir -p "$WORKSPACE_PATH/.vscode"
 
+echo -e "\n${GREEN}> Generate file '.vscode/extensions.json'.${ENDCOLOR}\n"
+
 if [ -f "$WORKSPACE_PATH/.vscode/extensions.json" ]; then
-    echo -e "\n${YELLOW}Nothing to do because file is already existing.\n${ENDCOLOR}"
+    echo -e "${YELLOW}Nothing to do because file is already existing.\n${ENDCOLOR}"
 else
 
-    echo -e "\n${GREEN}> Generate file '.vscode/extensions.json'.${ENDCOLOR}\n"
-
     # Create initial file.
     merged_content=$(echo '{"recommendations": []}' | jq '.')
 
@@ -30,14 +30,6 @@ else
         merged_content=$(echo "$merged_content" | jq ".recommendations += $content")
     fi
 
-    # Add extensions specifically for the default formatter.
-    defaultFormatter=$(jq -r '.customizations.vscode.settings."editor.defaultFormatter"' $WORKSPACE_PATH/.devcontainer/devcontainer.json);
-
-    if [ "$defaultFormatter" == "ms-python.autopep8" ] || [ "$defaultFormatter" == "ms-python.black-formatter" ] || [ "$defaultFormatter" == "eeyore.yapf" ]; then
-        content="[\"$defaultFormatter\"]"
-        merged_content=$(echo "$merged_content" | jq ".recommendations += $content")
-    fi
-
     # Add other extensions.
     if [ -f "$WORKSPACE_PATH/.devcontainer/templates/default/config/extensions.json" ]; then
         content=$(cat $WORKSPACE_PATH/.devcontainer/templates/default/config/extensions.json)
@@ -51,3 +43,16 @@ else
     echo -e "Done.\n"
 
 fi
+
+# Add extensions specifically for the default formatter in 'devcontainer.json' file.
+defaultFormatter=$(jq -r '.customizations.vscode.settings."editor.defaultFormatter"' $WORKSPACE_PATH/.devcontainer/devcontainer.json);
+
+if [ "$defaultFormatter" == "ms-python.autopep8" ] || [ "$defaultFormatter" == "ms-python.black-formatter" ] || [ "$defaultFormatter" == "eeyore.yapf" ]; then
+    exist=`cat $WORKSPACE_PATH/.devcontainer/devcontainer.json | jq ".customizations.vscode.extensions | contains([\"$defaultFormatter\"])"`
+    if [ $exist == 'false' ]; then
+        echo -e "${GREEN}> Update file '.devcontainer/devcontainer.json'.${ENDCOLOR}\n"
+        cat $WORKSPACE_PATH/.devcontainer/devcontainer.json | jq ".customizations.vscode.extensions += [\"$defaultFormatter\"]" > /tmp/devcontainer.json
+        mv /tmp/devcontainer.json $WORKSPACE_PATH/.devcontainer/devcontainer.json
+        echo -e "Done.\n"
+    fi
+fi
diff --git a/.devcontainer/install/27-install-requirements-app-python.sh b/.devcontainer/install/27-install-requirements-app-python.sh
@@ -1,13 +1,12 @@
 #!/bin/bash
 
-# ignored: azure-function-python
 # ignored: poetry-dependency-manager
 
 . "$WORKSPACE_PATH/tools/color.sh"
 
 echo -e "\n${BLUE}#############################################################${ENDCOLOR}"
 echo -e "${BLUE}#####                                                   #####${ENDCOLOR}"
-echo -e "${BLUE}#####  Install requirements.txt (app-python version)    #####${ENDCOLOR}"
+echo -e "${BLUE}#####  Install requirements.txt                         #####${ENDCOLOR}"
 echo -e "${BLUE}#####                                                   #####${ENDCOLOR}"
 echo -e "${BLUE}#############################################################${ENDCOLOR}"
 
diff --git a/.devcontainer/install/27-install-requirements-azure-function-python.sh b/.devcontainer/install/27-install-requirements-azure-function-python.sh
diff --git a/.devcontainer/install/85-extension-installation.sh b/.devcontainer/install/85-extension-installation.sh
@@ -45,7 +45,7 @@ if [ "$defaultFormatter" == "ms-python.autopep8" ] || [ "$defaultFormatter" == "
 
         quantity=(`code --list-extensions --show-versions 2>/dev/null | grep "$defaultFormatter" | wc -l`)
 
-        if [ "$quantity" == "0" ]; then
+        if [ "$quantity" == "-1" ]; then
 
             echo -e "\n${RED}The extension has not been automatically installed.${ENDCOLOR}"
             echo -e "\n${BLUE}To install the extension manually, you can in the sidebar on the left, in the 'extension' menu (ctrl+shift+x) search for the extension from its extension id which is:${ENDCOLOR} '$defaultFormatter'\n"
@@ -67,12 +67,12 @@ if [ "$defaultFormatter" == "ms-python.autopep8" ] || [ "$defaultFormatter" == "
 
             quantity=(`code --list-extensions --show-versions 2>/dev/null | grep "$defaultFormatter_id" | wc -l`)
 
-            if [ "$quantity" == "0" ]; then
+            if [ "$quantity" == "-1" ]; then
                 echo -e "${RED}The extension seems not to be installed. Please check again!${ENDCOLOR}"
                 echo -e "${RED}Failure to adhere to a common code formatting tool in a Python project can lead to style inconsistencies, merge conflicts, and reduced team productivity.${ENDCOLOR}\n"
                 echo -e "${RED}Despite this anomaly, the container installation processus will continue.${ENDCOLOR}"
-            else
-                echo -e "Done. Extension is installed."
+            # else
+                # echo -e "Done. Extension is installed."
             fi
 
         fi
diff --git a/.devcontainer/install/86-fix-mypy-extension.sh b/.devcontainer/install/86-fix-mypy-extension.sh
@@ -14,11 +14,11 @@ ORIGINAL_FILE_1="$HOME/.vscode-server/extensions/ms-python.mypy-type-checker-202
 ORIGINAL_FILE_2="$HOME/.vscode-server/extensions/ms-python.mypy-type-checker-2023.6.0/bundled/tool/lsp_server.py"
 
 if [ -f "$ORIGINAL_FILE_1" ]; then
-    $ORIGINAL_FILE=$ORIGINAL_FILE_1
+    ORIGINAL_FILE=$ORIGINAL_FILE_1
 fi
 
 if [ -f "$ORIGINAL_FILE_2" ]; then
-    $ORIGINAL_FILE=$ORIGINAL_FILE_2
+    ORIGINAL_FILE=$ORIGINAL_FILE_2
 fi
 
 if [ -f "$ORIGINAL_FILE" ]; then
diff --git a/.devcontainer/install/__65-generate-file-vscode-launch-json.sh__ b/.devcontainer/install/__65-generate-file-vscode-launch-json.sh__
diff --git a/.devcontainer/templates/app-python/config/launch.json b/.devcontainer/templates/app-python/config/launch.json
@@ -1,7 +1,7 @@
 [
     {
         "name": "Execute module '{project_name}'",
-        "type": "python",
+        "type": "debugpy",
         "request": "launch",
         "module": "{project_name}"
     }
diff --git a/.devcontainer/templates/azure-function-python/config/extensions.json b/.devcontainer/templates/azure-function-python/config/extensions.json
@@ -1,4 +1 @@
-[
-    "ms-azuretools.vscode-azurefunctions",
-    "ms-python.python"
-]
+[]
diff --git a/.devcontainer/templates/azure-function-python/config/launch.json b/.devcontainer/templates/azure-function-python/config/launch.json
@@ -1,7 +1,7 @@
 [
     {
         "name": "Attach to Python Functions: {project_name}",
-        "type": "python",
+        "type": "debugpy",
         "request": "attach",
         "port": 9091,
         "preLaunchTask": "Azure Function - Start: {project_name}",
diff --git a/.devcontainer/templates/default/config/launch.json b/.devcontainer/templates/default/config/launch.json
@@ -1,7 +1,7 @@
 [
     {
         "name": "Python: File",
-        "type": "python",
+        "type": "debugpy",
         "request": "launch",
         "program": "${file}",
         "console": "integratedTerminal",
diff --git a/docs/dev-container-configuration/01-duplicate-configuration-example-file.md b/docs/dev-container-configuration/01-duplicate-configuration-example-file.md
@@ -2,7 +2,21 @@
 
 # Duplicate configuration example file
 
-Before you begin, you need to rename the file named *'devcontainer.json-example'* located in the *'.devcontainer/'* directory to *'devcontainer.json'*.
+Before you begin, you need to create a *'devcontainer.json'* file and a *'Dockerfile'* file in the directory *'.devcontainer/'*.
+
+If you want to create a python application, you need to copy/paste the following files into the directory: *'.devcontainer/'*.
+
+```
+.devcontainer/templates/app-python/devcontainer.json
+.devcontainer/templates/app-python/Dockerfile
+```
+
+If you want to create an application based on Azure Functions, you must copy/paste the following files into the directory: *'.devcontainer/'*:
+
+```
+.devcontainer/templates/azure-function-python/devcontainer.json
+.devcontainer/templates/azure-function-python/Dockerfile
+```
 
 The new tree should look like :
 
@@ -15,6 +29,8 @@ The new tree should look like :
 └── install.sh
 ````
 
+
+
 Now we will mainly modify this file.
 
 ###### **▶ Next step: [Configure a packaging and dependency manager](./02-configure-packaging-dependency-manager.md)**

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`[`
`2`	`2`	`{`
`3`	`3`	`"name": "Execute module '{project_name}'",`
`4`		`- "type": "python",`
	`4`	`+ "type": "debugpy",`
`5`	`5`	`"request": "launch",`
`6`	`6`	`"module": "{project_name}"`
`7`	`7`	`}`
-Original file line number
+Diff line change
@@ @@ -1,4 +1 @@ @@
 -[
 -    "ms-azuretools.vscode-azurefunctions",
 -    "ms-python.python"
 -]
 +[]
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`[`
`2`	`2`	`{`
`3`	`3`	`"name": "Attach to Python Functions: {project_name}",`
`4`		`- "type": "python",`
	`4`	`+ "type": "debugpy",`
`5`	`5`	`"request": "attach",`
`6`	`6`	`"port": 9091,`
`7`	`7`	`"preLaunchTask": "Azure Function - Start: {project_name}",`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`[`
`2`	`2`	`{`
`3`	`3`	`"name": "Python: File",`
`4`		`- "type": "python",`
	`4`	`+ "type": "debugpy",`
`5`	`5`	`"request": "launch",`
`6`	`6`	`"program": "${file}",`
`7`	`7`	`"console": "integratedTerminal",`