Merge remote-tracking branch 'origin/main' into v1-bug-fixes

Author: Prajwal-Microsoft

.github/workflows/codeql.yml

@@ -0,0 +1,92 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL Advanced"
+
+on:
+  push:
+    branches: [ "main", dev, demo ]
+  pull_request:
+    branches: [ "main", dev, demo ]
+  schedule:
+    - cron: '38 9 * * 2'
+
+jobs:
+  analyze:
+    name: Analyze (${{ matrix.language }})
+    # Runner size impacts CodeQL analysis time. To learn more, please see:
+    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
+    #   - https://gh.io/supported-runners-and-hardware-resources
+    #   - https://gh.io/using-larger-runners (GitHub.com only)
+    # Consider using larger runners or machines with greater resources for possible analysis time improvements.
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    permissions:
+      # required for all workflows
+      security-events: write
+
+      # required to fetch internal or private CodeQL packs
+      packages: read
+
+      # only required for workflows in private repositories
+      actions: read
+      contents: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - language: csharp
+          build-mode: none
+        # CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift'
+        # Use `c-cpp` to analyze code written in C, C++ or both
+        # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
+        # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
+        # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis,
+        # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.
+        # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how
+        # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+        build-mode: ${{ matrix.build-mode }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+    # If the analyze step fails for one of the languages you are analyzing with
+    # "We were unable to automatically build your code", modify the matrix above
+    # to set the build mode to "manual" for that language. Then modify this step
+    # to build your code.
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+    - if: matrix.build-mode == 'manual'
+      shell: bash
+      run: |
+        echo 'If you are using a "manual" build mode for one or more of the' \
+          'languages you are analyzing, replace this with the commands to build' \
+          'your code, for example:'
+        echo '  make bootstrap'
+        echo '  make release'
+        exit 1
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/sync-branches.yml

@@ -17,6 +17,10 @@ _textdb/
 ##
 ## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore
 
+# .NET C#
+appsettings.json
+
+
 # User-specific files
 *.rsuser
 *.suo

.gitignore

@@ -11,7 +11,7 @@ The user interaction and flow of information are as follows:
 
 **1 Upload / Register Document for AI analysis**
 
-Note: The user can be one of these roles: Sustainability Manager, Head of Extra-Financial Reporting, or other designated person in the organization.  
+Note: The user has a designated role in the organization, such as Sustainability Manager, Head of Extra-Financial Reporting, or Chief Sustainability Officer.  
 
 The user logs into the Power App and uploads a sustainability reports he & his (she & her) colleagues would use to create Benchmarking & Gap Analysis reports. Power Automate sends these documents to backend services so they are ready to be processed. 
 
@@ -41,7 +41,7 @@ Once the output document is successfully created in the backend, power automate
 
 **4 User Accesses the Output Documents**
 
-Note: The user can be one of these roles: Sustainability Manager, Head of Extra-Financial Reporting, or Chief Sustainability Officer, or other designated person in the organization, as long as the user is added to the Teams channel. 
+Note: The user needs to be added to the Teams channel prior to use below features. 
 
 After the document is available in SharePoint, the user gets a notification in Teams from a custom copilot. At this point, the user can view the document by clicking a hyperlink from Teams or he can choose to chat with the copilot to get insights about the generated document.
 

Deployment/docs/ArchitectureDescription.md

@@ -0,0 +1,28 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT License.
+using System.ComponentModel;
+
+namespace Tester.ConsoleApp
+{
+    enum Choice
+    {
+        [Description("1. List Registered Documents")]
+        ListRegisteredDocuments,
+        [Description("2. Register Documents")]
+        RegisterDocuments,
+        [Description("3. Delete Registered Documents in Azure")]
+        DeleteDocuments,
+        [Description("4. Perform Gap Analysis")]
+        GapAnalysis,
+        [Description("5. Get All Gap Analysis Results")]
+        GetAllGapAnalysisResults,
+        [Description("6. Perform Benchmark Analysis")]
+        BenchMarks,
+        [Description("7. Get All Benchmark Analysis Results")]
+        GetAllBenchMarksResults,
+        [Description("8. Test API Connection")]
+        TestApiConnection,
+        [Description("9. Exit")]
+        Exit
+    }
+}

Deployment/images/readme/architecture.png

@@ -0,0 +1,91 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT License.
+
+using System.Security.Cryptography.X509Certificates;
+using Spectre.Console;
+
+namespace Tester.ConsoleApp.Functions
+{
+    public static class ApiConnection
+    {
+        public static async void TestConnection(Uri uri)
+        {
+            // Create a custom HttpClientHandler to handle SSL certificate validation
+            var handler = new HttpClientHandler
+            {
+                ServerCertificateCustomValidationCallback = (message, cert, chain, sslPolicyErrors) =>
+                {
+                    // Here you can add custom logic to validate the certificate
+                    // For example, you can check the certificate thumbprint, issuer, etc.
+                    // Returning true will bypass the SSL certificate validation
+                    if (cert == null)
+                    {
+                        AnsiConsole.WriteLine("No Server Certificate Found");
+                        return false;
+                    }
+                    return ValidateCertificate(cert);
+                }
+            };
+
+            // Create an HttpClient using the custom handler
+            using (var client = new HttpClient(handler))
+            {
+                // Set the base address of the API
+                client.BaseAddress = uri;
+                try
+                {
+                    // Make a GET request to the API
+                    HttpResponseMessage response = await client.GetAsync("/api/endpoint");
+                    // Check if the response is successful
+                    if (response.IsSuccessStatusCode)
+                    {
+                        // Read the response content
+                        string content = await response.Content.ReadAsStringAsync();
+                        //AnsiConsole.WriteLine("\nTest Connection Response Content: " + content);
+                    }
+                    AnsiConsole.WriteLine("API Connection is successful.");
+                }
+                catch (Exception ex)
+                {
+                    //AnsiConsole.WriteLine("\nTest Connection Failed with Exception (check your appsettings.json and services): " + ex.Message);
+                    AnsiConsole.WriteLine("Test Connection Failed with Exceptions. Check your appsettings.json and API services.");
+                  }
+            }
+        }
+
+        // Validate the SSL certificate
+        static bool ValidateCertificate(X509Certificate2 cert)
+        {
+            // Add custom validation logic here
+            // For example, check the certificate thumbprint, issuer, expiration date, etc.
+            //AnsiConsole.WriteLine("Certificate Subject: " + cert.Subject);
+            //AnsiConsole.WriteLine("Certificate Issuer: " + cert.Issuer);
+            //AnsiConsole.WriteLine("Certificate Thumbprint: " + cert.Thumbprint);
+            //AnsiConsole.WriteLine("Certificate Expiration: " + cert.NotAfter);
+            //AnsiConsole.WriteLine(); // Write a new line
+
+            // Example: Validate the certificate thumbprint. This is just an example, you should use a valid thumbprint.
+            string expectedThumbprint = "B89BB8B0BEF4B6CF59A472284B4F8F234525302B";
+            if (cert.Thumbprint == expectedThumbprint)
+            {
+                return true;
+            }
+
+            // Example: Validate the certificate issuer. This is just an example, you should use a valid issuer.
+            string expectedIssuer = "Kubernetes Ingress Controller Fake Certificate";
+            if (cert.Issuer == expectedIssuer)
+            {
+                return true;
+            }
+
+            // Example: Validate the certificate expiration date
+            if (DateTime.Now < cert.NotAfter)
+            {
+                return true;
+            }
+
+            // If none of the validation checks pass, return false
+            return false;
+        }
+    }
+}

Deployment/images/services/tester_app_document_id.png

@@ -0,0 +1,40 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT License.
+
+namespace Tester.ConsoleApp.Functions
+{
+    public class AppConfig
+    {
+        public string JobOwner { get; set; }
+        public string Type { get; set; }
+        public string disclosureNumber { get; set; }
+        public string disclosureName { get; set; }
+        public string disclosureRequirement { get; set; }
+        public string disclosureRequirementDetail { get; set; }
+        public string disclosureAnnex { get; set; }
+
+        // Constructor to initialize properties
+        public AppConfig(string myJobOwner, string myType, string myDisclosureNumber, string myDisclosureName, string myDisclosureRequirement, string myDisclosureRequirementDetail, string myDisclosureAnnex)
+        {
+            JobOwner = myJobOwner;
+            Type = myType;
+            disclosureNumber = myDisclosureNumber;
+            disclosureName = myDisclosureName;
+            disclosureRequirement = myDisclosureRequirement;
+            disclosureRequirementDetail = myDisclosureRequirementDetail;
+            disclosureAnnex = myDisclosureAnnex;
+        }
+
+        // Parameterless constructor for deserialization
+        public AppConfig()
+        {
+            JobOwner = string.Empty;
+            Type = string.Empty;
+            disclosureNumber = string.Empty;
+            disclosureName = string.Empty;
+            disclosureRequirement = string.Empty;
+            disclosureRequirementDetail = string.Empty;
+            disclosureAnnex = string.Empty;
+        }
+    }
+}