added custome rootfile support. adjusted for CRs

Author: zaowang-ms

.gitignore renamed to azure-pipeline/.gitignore

@@ -7,10 +7,10 @@ pool:
 steps:  
 - task: nginx-config-push@0
   inputs:
-    serviceConnectionName: '(sercive-connection-name)'
-    resourceGroupName: '(resource-group-name)'
-    subscriptionId: '(subscription-id)'
-    deploymentName: '(deployment-name)'
-    sourceConfigFolderPath: '(config-folder-file-path)'
-    targetConfigFolderPath: '/etc/nginx/'
-
+    serviceConnectionName: '(Enter the name of the service connection to Azure)'
+    resourceGroupName: '(Enter the name of the Azure resource group of the deployment)'
+    subscriptionId: '(Enter the Azure subscription ID of the deployment)'
+    deploymentName: '(Enter the name for this deployment)'
+    configDirectoryInRepo: '(Enter the relative path to the Nginx configuration directory in the repository)'
+    configDirectoryInDeployment: '(Enter the target path for the Nginx configuration directory in the deployment environment, e.g., /etc/nginx)'
+    rootConfigFileName: '(Enter the name of the root configuration file and make sure it is in the config directory. e.g., nginx.conf)'

azure-pipeline/.taskkey

@@ -35,12 +35,13 @@ pool:
 steps:  
 - task: nginx-config-push@0
   inputs:
-    serviceConnectionName: '(sercive-connection-name)'
-    resourceGroupName: '(resource-group-name)'
-    subscriptionId: '(subscription-id)'
-    deploymentName: '(deployment-name)'
-    sourceConfigFolderPath: '(config-folder-file-path)'
-    targetConfigFolderPath: '/etc/nginx/'
+    serviceConnectionName: '(Enter the name of the service connection to Azure)'
+    resourceGroupName: '(Enter the name of the Azure resource group of the deployment)'
+    subscriptionId: '(Enter the Azure subscription ID of the deployment)'
+    deploymentName: '(Enter the name for this deployment)'
+    configDirectoryInRepo: '(Enter the relative path to the Nginx configuration directory in the repository)'
+    configDirectoryInDeployment: '(Enter the target path for the Nginx configuration directory in the deployment environment, e.g., /etc/nginx/)'
+    rootConfigFileName: '(Enter the name of the root configuration file and make sure it is in the config directory. e.g., nginx.conf)'
 
 ```
 
@@ -49,7 +50,7 @@ What is needed right now is to get values of the needed variables with following
 
 ##### 1. Get your NGINX configuration file ready in the repository.
 
-Upload your NGINX configuration files onto any folder of your Azure DevOps repository. Then update the ‘sourceConfigFolderPath’ to the path of the configuration folder in your repository. Note that the name of the main file of the NGINX configuration folder should be “nginx.conf”, and the ‘targetConfigFolderPath’ would usually be /etc/nginx/.
+Upload your NGINX configuration files onto any folder of your Azure DevOps repository. Then update the ‘configDirectoryInRepo’ to the path of the configuration folder in your repository. 
 
 ![Image](images/readme-guidline-01.png)
 

azure-pipeline/example.yml

@@ -13,31 +13,36 @@ import {
 import {
     validatedEnvVar,
     validatedAuthParams,
-} from './utils/common';
+} from './utils/validation';
 import { 
     ClientSecretCredential,
     AuthenticationError,
 } from '@azure/identity';
 import { info } from 'console';
 
-
+/**
+ * Class ConfigUpdater is responsible for updating the Nginx configuration.
+ * It provides methods to authenticate, compress, and upload user-specific configurations
+ * using Azure identity and other utilities.
+*/
 class ConfigUpdater {
 
     private f = new FileHandler;
 
-    // getAuthorizationTokenFromKey():
-    // a function takes user's input given in the .yml file
-    // and request an bearer token for authentication of later authorization
-    // using @azure/identity
-    private getAuthorizationTokenFromKey = async () => {
+    /**
+     * Retrieves the authorization token for later authentication by using Azure identity.
+     * @returns {Promise<any>} The authorization token.
+     * @throws {Error} If the authorization parameters validation fails.
+     * @throws {AuthenticationError} If the access token fetch fails.
+    */
+    private getAuthorizationTokenFromKey = async (
+        tenantID: string,
+        clientID: string,
+        servicePrincipalKey: string
+    ) => {
         try {
-            const params = {
-                tenantID:  validatedAuthParams('tenantid'),
-                clientID:  validatedAuthParams('servicePrincipalId'),
-                servicePrincipalKey: validatedAuthParams('servicePrincipalKey'),
-            }
             const clientSecretCredential: ClientSecretCredential = new ClientSecretCredential(
-                params.tenantID, params.clientID, params.servicePrincipalKey
+                tenantID, clientID, servicePrincipalKey
             );
             const accessToken = await clientSecretCredential.getToken(SCOPE);
             if (!accessToken) {
@@ -51,9 +56,10 @@ class ConfigUpdater {
         }
     }
 
-    // getConvertedFileObject():
-    // compress config file folder
-    // and make it ready for sending it to backend
+    /**
+     * Compresses the configuration file folder and prepares it for sending to the backend.
+     * @returns {Promise<Object>} An object containing properties related to the compressed file.
+     */
     private getConvertedFileObject = async () => {
         const file = await this.f.compressFile(
             validatedEnvVar(INPUT.source),
@@ -62,26 +68,35 @@ class ConfigUpdater {
         );
         return {
             properties: {
-                rootFile: `${validatedEnvVar(INPUT.target)}nginx.conf`,
+                rootFile: `${validatedEnvVar(INPUT.target)}/${validatedEnvVar(INPUT.rootFile)}`.replace(/\/\/+/g, '/'),
                 package: {
                     data: this.f.convertFileToBase64String(file),
                 }
             }
         };
     }
 
-    // getRequestConfig():
-    // make up the bearer token from user's input
+    /**
+     * Constructs the request configuration, including the bearer token from the user's input.
+     * @returns {Promise<AxiosRequestConfig>} The request configuration.
+     */
     private getRequestConfig = async () => {
-        const token = await this.getAuthorizationTokenFromKey();
+        const token = await this.getAuthorizationTokenFromKey(
+            validatedAuthParams('tenantid'),
+            validatedAuthParams('servicePrincipalId'),
+            validatedAuthParams('servicePrincipalKey'),
+        );
         const config: AxiosRequestConfig = { headers: {
             Authorization: `Bearer ${token.token}`,
         }}
         return config;
     }
 
-    // getRequestResource():
-    // make up all needed parameters for the uploading api request
+    /**
+     * Constructs the required parameters for the uploading API request.
+     * @returns {Object} An object containing the required parameters for the request,
+     * including subscription ID, resource group name, deployment name, and API version.
+     */
     private getRequestResource = () => {
         return {
             subscriptionId: validatedEnvVar(INPUT.subscription),
@@ -91,8 +106,10 @@ class ConfigUpdater {
         }
     }
 
-    // updateNginxConfig():
-    // main function to compress file, get authentication info, and call the api
+    /**
+     * Main function to compress the file, retrieve authentication info, and call the API to update the Nginx configuration.
+     * @throws {Error} If the Nginx configuration uploading fails.
+    */
     updateNginxConfig = async () => {
         console.log('updateNginxConfig...')
         try {

azure-pipeline/readme.md

@@ -3,8 +3,8 @@
     "id": "4b016be0-afe8-4f76-ace3-d7f0355d9605",
     "name": "nginx-for-azure-config-sync",
     "friendlyName": "nginxconfigpush",
-    "description": "this task is designed for pushing nginx configs from azrue devops repository to azure nginx deployments",
-    "helpMarkDown": "",
+    "description": "This task is designed to synchronize Nginx configurations from an Azure DevOps repository or GitHub repository to NGINXaaS for Azure deployments.",
+    "helpMarkDown": "Use this task to push Nginx configuration files from your repository to your NGINXaaS for Azure deployments",
     "category": "Utility",
     "author": "zaotest",
     "version": {
@@ -21,48 +21,56 @@
             ],
             "type": "connectedService:AzureRM",
             "label": "Azure Service Connection Name",
-            "helpMarkDown": "serviceConnectionName",
+            "helpMarkDown": "Specify the Azure Service Connection to use for authentication.",
             "required": true
         },
         {
             "name": "resourceGroupName",
             "type": "string",
-            "label": "resourceGroupName",
+            "label": "Azure Resource Group Name",
             "defaultValue": "",
             "required": true,
-            "helpMarkDown": "resourceGroupName"
+            "helpMarkDown": "Enter the name of the Azure Resource Group where the Nginx deployment resides."
         },
         {
             "name": "subscriptionId",
             "type": "string",
-            "label": "subscriptionId",
+            "label": "Azure Subscription ID",
             "defaultValue": "",
             "required": true,
-            "helpMarkDown": "subscriptionId"
+            "helpMarkDown": "Enter the ID of the Azure subscription for the deployment."
         },
         {
             "name": "deploymentName",
             "type": "string",
-            "label": "deploymentName",
+            "label": "Deployment Name",
             "defaultValue": "",
             "required": true,
-            "helpMarkDown": "deploymentName"
+            "helpMarkDown": "Enter a name for the deployment that will receive the Nginx configuration."
         },
         {
-            "name": "sourceConfigFolderPath",
+            "name": "configDirectoryInRepo",
             "type": "string",
-            "label": "sourceConfigFolderPath",
+            "label": "Configuration Directory in Repository",
             "defaultValue": "",
             "required": true,
-            "helpMarkDown": "a content type to append to all keys in the configuration file"
+            "helpMarkDown": "Enter the relative path to the Nginx configuration directory in the repository."
         },
         {
-            "name": "targetConfigFolderPath",
+            "name": "configDirectoryInDeployment",
             "type": "string",
-            "label": "targetConfigFolderPath Type",
-            "defaultValue": "",
+            "label": "Configuration Directory in Deployment",
+            "defaultValue": "/etc/nginx",
+            "required": true,
+            "helpMarkDown": "Enter the target path for the Nginx configuration directory in the deployment environment."
+        },
+        {
+            "name": "rootConfigFileName",
+            "type": "string",
+            "label": "Root Configuration File Name",
+            "defaultValue": "nginx.conf",
             "required": true,
-            "helpMarkDown": "targetConfigFolderPath"
+            "helpMarkDown": "Enter the name of the root configuration file, such as 'nginx.conf', within the configuration directory."
         }
     ],
     "execution": {

azure-pipeline/src/index.ts

@@ -7,10 +7,10 @@ export const OUTPUT_PATH: string = './uploading-file.tar.gz';
 
 export const INPUT = {
     connection: 'AZURESUBSCRIPTIONENDPOINT',
-    source: 'SOURCECONFIGFOLDERPATH',
-    target: 'TARGETCONFIGFOLDERPATH',
-    subscription: 'SUBSCRIPTIONID',
     resource: 'RESOURCEGROUPNAME',
+    subscription: 'SUBSCRIPTIONID',
     deployment: 'DEPLOYMENTNAME',
-
+    source: 'CONFIGDIRECTORYINREPO',
+    target: 'CONFIGDIRECTORYINDEPLOYMENT',
+    rootFile: 'ROOTCONFIGFILENAME',
 }

azure-pipeline/src/task.json

@@ -1,7 +1,20 @@
 import tar from 'tar';
+import fs from 'fs';
 
+/**
+ * Class FileHandler provides utility functions to handle file operations,
+ * such as compressing a file and converting it to a Base64 string.
+*/
 export class FileHandler {
 
+    /**
+     * Compresses a file at the given source path using gzip and tar, and writes the compressed file to the specified output path.
+     * @param sourcePath {string} The path of the source file to compress.
+     * @param prefix {string} The prefix to use in the compressed file name.
+     * @param outputPath {string} The path where the compressed file will be saved.
+     * @returns {Promise<string>} The output path of the compressed file.
+     * @throws {Error} If an error occurs during compression.
+    */
     public compressFile = async (
         sourcePath: string,
         prefix: string,
@@ -25,8 +38,12 @@ export class FileHandler {
 
     }
 
+    /**
+     * Reads the file at the given path and converts its content to a Base64 string.
+     * @param file {string} The path of the file to read.
+     * @returns {string} The content of the file as a Base64 string.
+    */
     public convertFileToBase64String = (file: string) => {
-        const fs = require('fs')
         const file_buffer = fs.readFileSync(file);
         return file_buffer.toString('base64');
     }

azure-pipeline/src/utils/constants.ts

@@ -9,7 +9,19 @@ const headers = {
 
 const baseURL = 'https://management.azure.com';
 
+/**
+ * Class SimplifiedHttp provides a simplified interface for HTTP requests.
+ * It encapsulates common configurations and error handling for making HTTP PUT requests.
+ */
 class SimplifiedHttp {
+  /**
+   * Makes an HTTP PUT request to the specified endpoint with the given data and configuration.
+   * @param endpoint {string} The URL of the endpoint to send the request to.
+   * @param data {T} Optional data to be sent in the request body.
+   * @param config {AxiosRequestConfig} Optional configuration object for the request.
+   * @returns {Promise<R>} A promise that resolves to the response of the request.
+   * @throws {any} If an error occurs during the request.
+   */
   put<T = any, R = AxiosResponse<T>>(endpoint: string, data?: T, config?: AxiosRequestConfig): Promise<R> {
     const finalConfig = {
       ...config,