Merge pull request #373 from zzzrst/development

Update documentation and readme with new photos for visualization of potential.
zzzrst · Dec 25, 2023 · 7142a8a · 7142a8a
2 parents 9bdf22e + ef114c5
commit 7142a8a
Show file tree

Hide file tree

Showing 22 changed files with 95 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,14 @@
 # Automation Testing Program
 This is a ``.Net 6`` console application. This repository contains the source code for the Automation Testing Program. This application allows users to create and run tests with different data formats for web applications. Please read the [Documentation](https://zzzrst.github.io/AutomationTestingProgram/.) on how to use and modify the program to your needs.
 
+The framework runs on a Key Word Driven model. 
+
+![Automation Testing Program](docs/img/Test_Progress_Report.png)
+
 ## How to Run
 
 Below are the command line arguments that can be passed in.
 
-
 Mandatory
 
 --setArgs 
@@ -559,3 +562,5 @@ Minor version is updated when methods are added / removed for bug fixes or a hel
 - Change keychain file path to correct file path
 - Sync initial files 
 - Project start date: Jun 27, 2023
+
+![Automation Testing Program](docs/img/Test_Step_with_screenshots_of_failures.png)
diff --git a/docs/articles/intro.html b/docs/articles/intro.html
@@ -70,7 +70,7 @@
 <h1 id="welcome">Welcome!</h1>
 
 <p>This page contains articles about the implemntation for the Automation Test Program as well as how to add your own modules to it.<br>
-Please refer to the <a href="">UML Diagram</a> for a better visualization of the source code.</p>
+<!-- Please refer to the <a href="">UML Diagram</a> for a better visualization of the source code.</p> -->
 <h2 id="testing-data">Testing Data</h2>
 <p>This is how you get what test set/case/step to run.</p>
 <h2 id="automation-framework">Automation Framework</h2>
@@ -143,6 +143,76 @@ <h2 id="running-the-program">Running the program.</h2>
 <li>Defaults to caseArgs</li>
 </ul>
 </li>
+<li>--kvSecrets
+<ul>
+<li>Defaults to no key vault secret to be read</li>
+</ul>
+</li>
+<li>--maxFailures
+  <ul>
+  <li>Defaults to 3</li>
+  </ul>
+</li>
+<li>--maxFailures
+  <ul>
+  <li>Defaults to 3</li>
+</ul>
+</li>
+<li>--notifyList
+  <ul>
+  <li>Defaults to nobody notified</li>
+</ul>
+</li>
+<li>--RunParameters
+  <ul>
+  <li>Defaults to no parameters</li>
+</ul>
+</li>
+<li>--planName
+  <ul>
+  <li>Defaults to devops name with test set, environment, build number</li>
+</ul>
+</li>
+<li>--projectName
+  <ul>
+  <li>Defaults to AutomationAndAccessibility</li>
+</ul>
+</li>
+<li>--azurePAT
+  <ul>
+  <li>Defaults to PAT defined in App.Config</li>
+</ul>
+</li>
+<li>--excecutionURL
+  <ul>
+  <li>Defaults to none</li>
+</ul>
+</li>
+<li>--appConfig
+  <ul>
+  <li>Defaults to none</li>
+</ul>
+</li>
+<li>--testPlanStructure
+  <ul>
+  <li>Defaults to none</li>
+</ul>
+</li>
+<li>--testerContact
+  <ul>
+  <li>Defaults to none</li>
+</ul>
+</li>
+<li>--testerName
+  <ul>
+  <li>Defaults to none</li>
+</ul>
+</li>
+<li>--releaseEnvUri
+  <ul>
+  <li>Defaults to none</li>
+</ul>
+</li>
 </ul>
 <h2 id="environment-variables">Environment Variables</h2>
 <p>Most of these variables are the parameters passed in as well as some additional parameters from test sets.</p>
@@ -244,6 +314,24 @@ <h2 id="test-flow">Test Flow</h2>
 </li>
 <li>END</li>
 </ul>
+<h2 id="devops-config">DevOps Configuration</h2>
+<p>As of December 2023, the Automation Testing Program is now configured to integrate directly with Azure DevOps' Test Plan, Test Case, Test Suite, and Test Run.</p>
+<figure>
+  <img src= "..\img\Test Run Summary.png" alt="Test run summary">
+  <figcaption>Azure DevOps Test Run Summary</figcaption>
+</figure>
+<p></p>
+<p>The program allows a user to launch from Excel format and then produce results directly to Azure .</p>
+<figure>
+  <img src= "..\img\Test Steps Stored in Keyword Driven Format.png" alt="Test run summary">
+  <figcaption>Test Progress Report</figcaption>
+</figure>
+<p></p>
+<p>The program allows a user to launch from Excel format and then produce results directly to Azure .</p>
+<figure>
+  <img src= "..\img\Test_Progress_Report.png" alt="Test run summary">
+  <figcaption>Test Progress Report</figcaption>
+</figure>
 </article>
           </div>
 

diff --git a/docs/img/Customize Test Suite Results.png b/docs/img/Customize Test Suite Results.png
diff --git a/docs/img/Generate Test Step Results.png b/docs/img/Generate Test Step Results.png
diff --git a/docs/img/HTML Report all passed.png b/docs/img/HTML Report all passed.png
diff --git a/docs/img/HTML report with blocked and failures.png b/docs/img/HTML report with blocked and failures.png
diff --git a/docs/img/HTML report with more info drop down.png b/docs/img/HTML report with more info drop down.png
diff --git a/docs/img/Release Run.png b/docs/img/Release Run.png
diff --git a/docs/img/Root Cause Analysis.png b/docs/img/Root Cause Analysis.png
diff --git a/docs/img/Run Attachment for Log.png b/docs/img/Run Attachment for Log.png
diff --git a/docs/img/Test Run Summary with AODA and Failures.png b/docs/img/Test Run Summary with AODA and Failures.png
diff --git a/docs/img/Test Run Summary.png b/docs/img/Test Run Summary.png
diff --git a/docs/img/Test Run.png b/docs/img/Test Run.png
diff --git a/docs/img/Test Step Result.png b/docs/img/Test Step Result.png
diff --git a/docs/img/Test Steps Stored in Keyword Driven Format.png b/docs/img/Test Steps Stored in Keyword Driven Format.png
diff --git a/docs/img/Test Steps with Failure marked as a test case failure.png b/docs/img/Test Steps with Failure marked as a test case failure.png
diff --git a/docs/img/TestPlan.png b/docs/img/TestPlan.png
diff --git a/docs/img/Test_Plan_Suites_Execution.png b/docs/img/Test_Plan_Suites_Execution.png
diff --git a/docs/img/Test_Points.png b/docs/img/Test_Points.png
diff --git a/docs/img/Test_Progress_Report.png b/docs/img/Test_Progress_Report.png
diff --git a/docs/img/Test_Step_with_screenshots_of_failures.png b/docs/img/Test_Step_with_screenshots_of_failures.png
diff --git a/docs/img/Text Run Report.png b/docs/img/Text Run Report.png