Skip to content
This repository has been archived by the owner on Apr 30, 2022. It is now read-only.

Commit

Permalink
Merge pull request #282 from Magenic/JonR_DocumentationUpdates
Browse files Browse the repository at this point in the history
Repair Documentation Links
  • Loading branch information
jason-edstrom authored May 22, 2020
2 parents 4ff24cc + 3b301ea commit 9646263
Show file tree
Hide file tree
Showing 74 changed files with 1,549 additions and 1,574 deletions.
2 changes: 1 addition & 1 deletion docs/JMAQS_1/ComingSoon.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# <img src="resources/maqslogo.ico" height="32" width="32"> Coming Soon
# <img src="resources/jmaqslogo.jpg" height="32" width="32"> Coming Soon
Empty file added docs/JMAQS_1/GettingStarted.md
Empty file.
Empty file added docs/JMAQS_1/Installation.md
Empty file.
12 changes: 6 additions & 6 deletions docs/JMAQS_1/Introduction.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# <img src="resources/maqslogo.ico" height="32" width="32"> MAQS
# <img src="resources/jmaqslogo.jpg" height="32" width="32"> MAQS

## Introduction to MAQS
MAQS stands for Magenic's automation quick start.
## Introduction to JMAQS
JMAQS is Magenic's Java based automation quick start.

It …
- is a modular test automation framework
- can be used as the base for your automation project or individual pieces can be used to enhance existing frameworks
- is maintained/extended by Magenic volunteers

The main idea behind MAQS is to avoid **reinventing the wheel**. Most automation engagements have you doing the same basic steps to get a functioning framework implemented. Utilizing project templates, NuGet, and utility libraries we are able to have a functioning framework up and running in minutes, almost entirely removing on the initial time investment on implementing an automation solution.
The main idea behind JMAQS is to avoid **reinventing the wheel**. Most automation engagements have you doing the same basic steps to get a functioning framework implemented. Utilizing project templates, NuGet, and utility libraries we are able to have a functioning framework up and running in minutes, almost entirely removing on the initial time investment on implementing an automation solution.

To download either versions of MAQS, navigate towards the installation section
To download either versions of JMAQS, navigate towards the installation section

![MAQS](resources/maqsfull.jpg)
![JMAQS](resources/maqsfull.png)
Empty file added docs/JMAQS_1/JMAQS-FAQ.md
Empty file.
6 changes: 3 additions & 3 deletions docs/JMAQS_1/License.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# <img src="resources/maqslogo.ico" height="32" width="32"> License
# <img src="resources/jmaqslogo.jpg" height="32" width="32"> License
The MIT License (MIT)
Copyright (c) 2019 Magenic
Copyright (c) 2020 Magenic

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

![MAQS](resources/maqsfull.jpg)
![MAQS](resources/maqsfull.png)
67 changes: 56 additions & 11 deletions docs/JMAQS_1/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,70 @@
- [ii. Manager Store](JMAQS_1/ComingSoon.md)

- ii. Utilities
- [i. Generic Wait](JMAQS_1/ComingSoon.md)
- [ii. Logger](JMAQS_1/ComingSoon.md)
- [iii. Config](JMAQS_1/ComingSoon.md)
- [iv. FAQ](JMAQS_1/ComingSoon.md)
- [i. Helper](JMAQS_1/ComingSoon.md)
- [ii. Logger](JMAQS_1/utilties/Logger.md)
- [iii. Performance](JMAQS_1/ComingSoon.md)

- iii. Selenium
- [i. Basics](JMAQS_1/ComingSoon.md)
- [i. Features](JMAQS_1/Selenium/SeleniumFeatures.md)
- [ii. Base Test](JMAQS_1/Selenium/SeleniumBaseTest.md)
- [iii. Test Object](JMAQS_1/Selenium/SeleniumTestObject.md)
- [iv. Config](JMAQS_1/Selenium/SeleniumConfig.md)
- [v. Utilities](JMAQS_1/Selenium/SeleniumUtilities.md)
- [vi. Driver Manager](JMAQS_1/Selenium/SeleniumDriverManager.md)
- [vii. Lazy Element](JMAQS_1/ComingSoon.md)
- [viii. Find](JMAQS_1/Selenium/UIFind.md)
- [ix. Waits](JMAQS_1/Selenium/UIWait.md)
- [x. Event Handler](JMAQS_1/Selenium/EventHandler.md)
- [xi. Action Builder](JMAQS_1/Selenium/ActionBuilder.md)
- [xii. Element Handler](JMAQS_1/Selenium/ElementHandler.md)
- [xiii. Web Driver Factory](JMAQS_1/Selenium/WebDriverFactory.md)
- [xiv. Find Factory](JMAQS_1/Selenium/UIFindFactory.md)
- [xv. Wait Factory](JMAQS_1/Selenium/UIWaitFactory.md)
- [xvi. Fluent Wait Factory](JMAQS_1/Selenium/FluentWaitFactory.md)
- [xvii. FAQ](JMAQS_1/Selenium/SeleniumFAQ.md)

- iv. Appium
- [i. Basics](JMAQS_1/ComingSoon.md)
- [i. Features](JMAQS_1/Appium/AppiumFeatures.md)
- [ii. Base Test](JMAQS_1/Appium/AppiumBaseTest.md)
- [iii. Test Object](JMAQS_1/Appium/AppiumTestObject.md)
- [iv. Driver Factory](JMAQS_1/Appium/AppiumDriverFactory.md)
- [v. Config](JMAQS_1/Appium/AppiumConfig.md)
- [vi. Utilities](JMAQS_1/Appium/AppiumUtilities.md)
- [vii. Driver Manager](JMAQS_1/Appium/MobileDriverManager.md)
- [viii. FAQ](JMAQS_1/Appium/AppiumFAQ.md)

- v. Database
- [i. Basics](JMAQS_1/ComingSoon.md)

- vi. WebServices
- [i. Basics](JMAQS_1/ComingSoon.md)
- [i. Features](JMAQS_1/database/DatabaseFeatures.md)
- [ii. Driver](JMAQS_1/database/DatabaseDriver.md)
- [iii. Config](JMAQS_1/database/DatabaseConfig.md)
- [vi. Connection Factory](JMAQS_1/database/ConnectionFactory.md)
- [v. Constants](JMAQS_1/database/Constants.md)
- [vi. Driver Manager](JMAQS_1/database/DatabaseDriverManager.md)
- [vii. Database Persistence Info](JMAQS_1/database/DatabasePersistenceUnitInfo.md)
- [viii. Providers](JMAQS_1/database/Providers.md)
- [viii. FAQ](JMAQS_1/database/DatabaseFAQ.md)
- vi. WebServices JDK 8
- [i. Features](JMAQS_1/WebService/WebServiceFeatures.md)
- [ii. Base Test](JMAQS_1/WebService/WebServiceBaseTest.md)
- [iii. Test Object](JMAQS_1/WebService/WebServiceTestObject.md)
- [iv. Driver](JMAQS_1/WebService/WebServiceDriver.md)
- [v. Config](JMAQS_1/WebService/WebServiceConfig.md)
- [vi. Utilities](JMAQS_1/WebService/WebServiceUtilities.md)
- [viii. Driver Manager](JMAQS_1/WebService/WebServiceDriverManager.md)
- [ix. MediaType](JMAQS_1/WebService/MediaType.md)
- [xi. FAQ](JMAQS_1/WebService/WebServiceFAQ.md)

- vii. BaseTest
- [i. Basics](JMAQS_1/ComingSoon.md)
- [i. Features](JMAQS_1/Base/BaseFeatures.md)
- [ii. Base Test](JMAQS_1/Base/BaseTest.md)
- [iii. Test Object](JMAQS_1/Base/BaseTestObject.md)
- [iv. Driver Manager](JMAQS_1/Base/DriverManager.md)
- [v. Manager Dictionary](JMAQS_1/Base/ManagerDictionary.md)
- [vi. Extendable Test](JMAQS_1/Base/BaseExtendableTest.md)
- [vii. Base Generic Test](JMAQS_1/Base/BaseGenericTest.md)
- [viii. FAQ](JMAQS_1/Base/BaseFAQ.md)

- [FAQ](JMAQS_1/ComingSoon.md)
- [License](JMAQS_1/License.md)
34 changes: 34 additions & 0 deletions docs/JMAQS_1/appium/AppiumBaseTest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# <img src="resources/jmaqslogo.jpg" height="32" width="32"> Base Appium Test

## Overview
The BaseAppiumTest has methods that sets up the webdriver, gets the mobile driver, tears down the appium driver, and creates a new test object.

# Available calls
[GetAppiumDriver](#GetAppiumDriver)
[BeforeLoggingTeardown](#BeforeLoggingTeardown)
[CreateNewTestObject](#CreateNewTestObject)

## GetAppiumDriver
This method gets the default Appium/Mobile driver.
```java
public AppiumDriver<WebElement> getAppiumDriver() {
return this.getTestObject().getAppiumDriver();
}
```

## BeforeLoggingTeardown
Takes a screen shot if needed and tear down the appium driver. It is called during teardown.
```java
this.beforeLoggingTeardown(resultType);
```

## CreateNewTestObject
This method creates a new Appium test object based on the mobile device.
```java
protected void createNewTestObject() {
this.setTestObject(new AppiumTestObject(this::getMobileDriver, this.createLogger(),
this.getFullyQualifiedTestClassName()));
}

this.CreateNewTestObject();
```
Loading

0 comments on commit 9646263

Please sign in to comment.