Merge pull request #235 from chgeuer/chgeuer/chmod

Remove all `chmod` calls. Fix typos. TenantIDs don't have to be GUIDs.

docs/design-decisions.md

@@ -1,3 +1,3 @@
-## Use of Down.Guard
-Simplify writing guard clauses and make sure they are handled consistantly.
-Dawnhttps://github.com/safakgur/guard
+## Use of `Down.Guard`
+
+- Simplify writing guard clauses and make sure they are handled consistently. https://github.com/safakgur/guard

src/Saas.Admin/Saas.Admin.Client/OAuthBaseClient.cs

@@ -38,13 +38,12 @@ private async Task<string> GetAccessToken(CancellationToken ct)
 
             return accessToken;
         }
-        catch (MsalUiRequiredException ex)
+        catch (MsalUiRequiredException)
         {
             throw;
         }
-        catch (Exception ex)
+        catch (Exception)
         {
-
             throw;
         }
     }

src/Saas.Admin/deployment/act/setup.sh

@@ -19,8 +19,6 @@ echo "Settings execute permissions on necessary scripts files."
 
 sudo mkdir -p "${ACT_SECRETS_DIR}"
 
-sudo chmod +x ${ACT_DIR}/*.sh
-sudo chmod +x ${SCRIPT_DIR}/*.sh >/dev/null 2>&1
 sudo touch ${ACT_SECRETS_FILE}
 sudo chown "${USER}" ${ACT_SECRETS_FILE}
 sudo touch ${ACT_SECRETS_FILE_RG}

src/Saas.Admin/deployment/setup.sh

@@ -4,19 +4,6 @@
 source "./constants.sh"
 
 echo "Setting up the deployment environment."
-echo "Settings execute permissions on necessary scripts files."
-
-(
-    sudo chmod +x ./*.sh
-    sudo chmod +x ./script/*.sh >/dev/null 2>&1
-    sudo chmod +x ./script/*.py
-    sudo chmod +x "${SHARED_MODULE_DIR}"/*.sh
-    sudo chmod +x "${SHARED_MODULE_DIR}"/*.py
-) ||
-    {
-        echo "Failed to set execute permissions on the necessary scripts."
-        exit 1
-    }
 
 repo_base="$(git rev-parse --show-toplevel)" ||
     {
@@ -27,12 +14,6 @@ repo_base="$(git rev-parse --show-toplevel)" ||
 docker_file_folder="${repo_base}/src/Saas.Lib/Deployment.Container"
 
 # redirect to build.sh in the Deployment.Container folder
-sudo chmod +x "${docker_file_folder}/build.sh" ||
-    {
-        echo "Failed to set execute permissions on the 'build.sh'  script."
-        exit 1
-    }
-
 echo "Building the deployment container."
 ./build.sh ||
     {

src/Saas.Admin/readme.md

@@ -34,7 +34,6 @@ Provisioning is easy:
 2. Run these commands:
 
    ```bash
-   sudo chmod +x setup.sh
    ./setup.sh
    ./run.sh
    ```

src/Saas.Application/README.md

@@ -53,7 +53,6 @@ Provisioning is easy:
 2. Run these commands:
 
    ```bash
-   sudo chmod +x setup.sh
    ./setup.sh
    ./run.sh
    ```

src/Saas.Application/deployment/act/setup.sh

@@ -18,9 +18,6 @@ echo "Setting up the SaaS Signup Administration Web App Act deployment environme
 echo "Settings execute permissions on necessary scripts files."
 
 sudo mkdir -p "${ACT_SECRETS_DIR}"
-
-sudo chmod +x ${ACT_DIR}/*.sh
-sudo chmod +x ${SCRIPT_DIR}/*.sh >/dev/null 2>&1
 sudo touch ${ACT_SECRETS_FILE}
 sudo chown "${USER}" ${ACT_SECRETS_FILE}
 sudo touch ${ACT_SECRETS_FILE_RG}

src/Saas.Application/deployment/setup.sh

@@ -4,19 +4,6 @@
 source "./constants.sh"
 
 echo "Setting up the deployment environment."
-echo "Settings execute permissions on necessary scripts files."
-
-(
-    sudo chmod +x ./*.sh
-    sudo chmod +x ./script/*.sh >/dev/null 2>&1
-    sudo chmod +x ./script/*.py
-    sudo chmod +x "${SHARED_MODULE_DIR}"/*.sh
-    sudo chmod +x "${SHARED_MODULE_DIR}"/*.py
-) ||
-    {
-        echo "Failed to set execute permissions on the necessary scripts."
-        exit 1
-    }
 
 repo_base="$(git rev-parse --show-toplevel)" ||
     {
@@ -27,12 +14,6 @@ repo_base="$(git rev-parse --show-toplevel)" ||
 docker_file_folder="${repo_base}/src/Saas.Lib/Deployment.Container"
 
 # redirect to build.sh in the Deployment.Container folder
-sudo chmod +x "${docker_file_folder}/build.sh" ||
-    {
-        echo "Failed to set execute permissions on the 'build.sh'  script."
-        exit 1
-    }
-
 echo "Building the deployment container."
 ./build.sh ||
     {

src/Saas.Identity/Saas.IdentityProvider/deployment/script/init-module.sh

@@ -73,7 +73,6 @@ function check-settings() {
 
     (
         is-guid ".initConfig.subscriptionId" 1>/dev/null &&
-            is-guid ".initConfig.tenantId" 1>/dev/null &&
             value-exist ".initConfig.naming.solutionName" 1>/dev/null &&
             value-exist ".initConfig.naming.solutionPrefix" 1>/dev/null &&
             is-valid-b2c-location ".initConfig.azureb2c.location" 1>/dev/null &&

src/Saas.Identity/Saas.IdentityProvider/deployment/script/init.sh

@@ -84,15 +84,6 @@ function check-prerequisites() {
     fi
 }
 
-function initialize-shell-scripts() {
-    # if not running in a container
-    if ! [ -f /.dockerenv ]; then
-        # ensure the needed scripts are executable
-        sudo chmod +x ${SCRIPT_DIR}/*.sh
-        sudo chmod +x ${SHARED_MODULE_DIR}/*.py
-    fi
-}
-
 function initialize-configuration-manifest-file() {
 
     if [[ ! -s "${CONFIG_FILE}" || ! -f "${CONFIG_FILE}" ]]; then
@@ -147,9 +138,6 @@ function initialize-configuration-manifest-file() {
 # check if prerequisites for running the deployment script are met
 check-prerequisites
 
-# initialize shell scripts ensuring that permissions are set correctly
-initialize-shell-scripts
-
 # initialize configuration manifest file
 initialize-configuration-manifest-file
 

src/Saas.Identity/Saas.IdentityProvider/deployment/setup.sh

@@ -4,17 +4,6 @@
 source "./constants.sh"
 
 echo "Setting up the deployment environment."
-echo "Settings execute permissions on necessary scripts files."
-
-(
-    sudo chmod +x ./*.sh || exit 1
-    sudo chmod +x ./script/*.sh || exit 1
-    sudo chmod +x ./script/*.py || exit 1
-) ||
-    {
-        echo "Failed to set execute permissions on the necessary scripts."
-        exit 1
-    }
 
 repo_base="$(git rev-parse --show-toplevel)" ||
     {
@@ -25,11 +14,6 @@ repo_base="$(git rev-parse --show-toplevel)" ||
 docker_file_folder="${repo_base}/src/Saas.Lib/Deployment.Container"
 
 # redirect to build.sh in the Deployment.Container folder
-sudo chmod +x "${docker_file_folder}/build.sh" ||
-    {
-        echo "Failed to set execute permissions on the 'build.sh'  script."
-        exit 1
-    }
 
 echo "Building the deployment container."
 ./build.sh ||

src/Saas.Identity/Saas.IdentityProvider/deployment/start.sh

@@ -74,12 +74,6 @@ sudo echo "You are logged in with sudo." |
     echo-color \
         --level success
 
-# if not running in a container
-if ! [ -f /.dockerenv ]; then
-    # make sure that the init script is executable
-    chmod +x "$SCRIPT_DIR/init.sh"
-fi
-
 # initialize deployment environment
 "${SCRIPT_DIR}/init.sh" ||
     if [[ $? -eq 2 ]]; then exit 0; fi

src/Saas.Identity/Saas.IdentityProvider/readme.md

@@ -6,7 +6,7 @@ This deployment script provisions and configures the Azure services defining the
 
 Before you begin, you should [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this GitHub repository to you own GitHub account to make it your own.
 
-> Tip: Sign up to GitHub for free: [join](github.com/join).
+> Tip: Sign up to GitHub for free: [join](https://github.com/join).
 
 ### Purpose
 
@@ -56,10 +56,10 @@ No matter the operating system you're using, you will need these tools to be ins
 To begin, please open your GNU Linux terminal to the directory where you've [cloned](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) the [forked](https://docs.github.com/en/get-started/quickstart/fork-a-repo) version of ASDK. Should be something like:
 
 ````bash
-.../src/Saas.Identity/Saas.IdentityProvider/deployment
+cd src/Saas.Identity/Saas.IdentityProvider/deployment
 ````
 
-![image-20230110094801956](.assets/readme/image-20230110094801956-1683889385775-1.png)
+![Screenshot of a Linux console window](.assets/readme/image-20230110094801956-1683889385775-1.png)
 
 > *Tip #1*: If you are on a Windows 10/11 PC and need to access your cloned Git repository one of your local drives, from the WSL Terminal, you can find the drives in the *`mnt`* directory - e.g., like this `cd /mnt/d/<path on d-drive>`.
 >
@@ -82,11 +82,10 @@ az login --scope "https://graph.microsoft.com/.default"
 To run the script you must first setup of the deployment environment and build the container. To do this, run the following commands:
 
 ```bash
-chmod +x setup.sh # only needed the first time to set execute permissions on setup.sh
 ./setup.sh
 ```
 
-![image-20230221115203497](.assets/readme/image-20230221115203497-1683889385776-2.png)
+![Screenshot of a Linux console window after initial setup.sh execution](.assets/readme/image-20230221115203497-1683889385776-2.png)
 
 This will take a few minutes to complete and you will only need to do it once. The container will be named `asdk-script-deployment`. 
 
@@ -102,7 +101,7 @@ When the container build have completed, run the script with the following comma
 ./run.sh
 ```
 
-![image-20230221115249541](.assets/readme/image-20230221115249541-1683889385776-3.png)
+![Screenshot of a Linux console window after initial run.sh execution](.assets/readme/image-20230221115249541-1683889385776-3.png)
 
 This will instantiate the container and mount the current root directory as a number of volumes (i.e., directories) that will become accessible from within the container. 
 
@@ -157,12 +156,12 @@ You may have multiple Azure subscriptions and thus manually choosing which subsc
 Alternatively, get to list of your subscriptions of the tenant that you are logged into by running this az cli command:
 
 ```bash
- az account subscription list --query "[].{DisplayName:displayName, Id:id}" --output table
+az account subscription list --query "[].{DisplayName:displayName, Id:id}" --output table
 ```
 
 ###  Tenant Id
 
-Get the `tenantId`by running the following command:
+Get the `tenantId` by running the following command:
 
 ```bash
 az account show --query tenantId
@@ -193,7 +192,7 @@ Other values in `initConfig`:
 
 ### Running the script 
 
-After you've added the values outlined above, to `config.json`, you're ready to run the script again. 
+After you've added the values outlined above, to `config.json`, you're ready to run the `run.sh` script again. 
 
 While running the script the second time, you will be asked to log in once, and maybe twice. 
 
@@ -233,7 +232,7 @@ The deployment script has run to it's completion and the Identity Framework have
 
 The Identity Framework is gathered in an Azure Resource group. In the Azure Portal it will look something like this: 
 
-![image-20230221121152035](.assets/readme/image-20230221121152035-1683889385777-4.png)
+![Screenshot showing the resource group contents](.assets/readme/image-20230221121152035-1683889385777-4.png)
 
 ### Adding the Other Modules
 

src/Saas.Identity/Saas.Permissions/deployment/act/setup.sh

@@ -19,8 +19,6 @@ echo "Settings execute permissions on necessary scripts files."
 
 sudo mkdir -p "${ACT_SECRETS_DIR}"
 
-sudo chmod +x ${ACT_DIR}/*.sh
-sudo chmod +x ${SCRIPT_DIR}/*.sh >/dev/null 2>&1
 sudo touch ${ACT_SECRETS_FILE}
 sudo chown "${USER}" ${ACT_SECRETS_FILE}
 sudo touch ${ACT_SECRETS_FILE_RG}

src/Saas.Identity/Saas.Permissions/deployment/setup.sh

@@ -4,22 +4,9 @@
 source "./constants.sh"
 
 echo "Setting up the deployment environment."
-echo "Settings execute permissions on necessary scripts files."
 
 echo "${SHARED_MODULE_DIR}"
 
-(
-    sudo chmod +x ./*.sh
-    sudo chmod +x ./script/*.sh >/dev/null 2>&1
-    sudo chmod +x ./script/*.py
-    sudo chmod +x "${SHARED_MODULE_DIR}"/*.sh
-    sudo chmod +x "${SHARED_MODULE_DIR}"/*.py
-) ||
-    {
-        echo "Failed to set execute permissions on the necessary scripts."
-        exit 1
-    }
-
 repo_base="$(git rev-parse --show-toplevel)" ||
     {
         echo "Failed to get the root of the repository."
@@ -28,13 +15,6 @@ repo_base="$(git rev-parse --show-toplevel)" ||
 
 docker_file_folder="${repo_base}/src/Saas.Lib/Deployment.Container"
 
-# redirect to build.sh in the Deployment.Container folder
-sudo chmod +x "${docker_file_folder}/build.sh" ||
-    {
-        echo "Failed to set execute permissions on the 'build.sh'  script."
-        exit 1
-    }
-
 echo "Building the deployment container."
 ./build.sh ||
     {

src/Saas.Identity/Saas.Permissions/readme.md

@@ -30,7 +30,6 @@ Provisioning is an easy two step process:
 
 2. Run these commands:
    ```bash
-   sudo chmod +x setup.sh
    ./setup.sh
    ./run.sh
    ```
@@ -174,7 +173,6 @@ Here are the steps to set things up for deploying the SaaS Permissions Service A
 2. From the directory, run these commands and bash shell scripts:
 
 ```bash
-sudo chmod +c ./setup.sh
 ./setup.sh
 ./run.sh
 ```
@@ -239,7 +237,6 @@ Here are the steps for getting up and running with Act for doing local deploymen
 2. Set up but running the command:
 
    ```bash
-   chmod +x ./setup.sh
    ./setup.sh
    ```
 

src/Saas.SignupAdministration/README.md

@@ -35,7 +35,6 @@ Provisioning is easy:
 2. Run these commands:
 
    ```bash
-   sudo chmod +x setup.sh
    ./setup.sh
    ./run.sh
    ```

src/Saas.SignupAdministration/deployment/act/setup.sh

@@ -15,12 +15,9 @@ done
 source "../constants.sh"
 
 echo "Setting up the SaaS Signup Administration Web App Act deployment environment."
-echo "Settings execute permissions on necessary scripts files."
 
 sudo mkdir -p "${ACT_SECRETS_DIR}"
 
-sudo chmod +x ${ACT_DIR}/*.sh
-sudo chmod +x ${SCRIPT_DIR}/*.sh >/dev/null 2>&1
 sudo touch ${ACT_SECRETS_FILE}
 sudo chown "${USER}" ${ACT_SECRETS_FILE}
 sudo touch ${ACT_SECRETS_FILE_RG}