25 |
34 |
35 |
36 |
37 |
--------------------------------------------------------------------------------
/daksha/asgi.py:
--------------------------------------------------------------------------------
1 | """
2 | Daksha
3 | Copyright (C) 2021 myKaarma.
4 | opensource@mykaarma.com
5 | This program is free software: you can redistribute it and/or modify
6 | it under the terms of the GNU Affero General Public License as published by
7 | the Free Software Foundation, either version 3 of the License, or
8 | (at your option) any later version.
9 | This program is distributed in the hope that it will be useful,
10 | but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | GNU Affero General Public License for more details.
13 | You should have received a copy of the GNU Affero General Public License
14 | along with this program. If not, see
26 | 
27 |
28 |
27 |
29 |
33 | 30 | Recording... 31 |
32 |
28 |
48 |
49 | )
50 | }
51 |
52 | export default DakshaRecorderStartingPage;
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | Contributing to Daksha
2 | ===============================================
3 |
4 | ------------------------------------------------------------------------------
5 |
6 | Thank you for taking the time to contribute! Please follow the following guidelines while contributing to this project.
7 |
8 | ## General:
9 | - If it's a major feature/change please create an [issue](https://github.com/mykaarma/daksha/issues) and discuss with project members.
10 | - Create a fork of Daksha on github (http://help.github.com/fork-a-repo/) and initiate a pull request to [main](https://github.com/mykaarma/daksha/tree/main) branch for submitting your change/feature.
11 |
12 |
13 | ## Python Code Quality Standards:
14 | - All code should compile and run for **Python 3.8**.
15 | - Maximum line length is 120 characters.
16 | - Indentation should be made with 4 spaces, not tabs.
17 | - For any non-trivial code, include comments.
18 | - Follow the logging conventions used in the rest of the project.
19 | - Tests should be included for any new functionality being added.
20 |
21 | ## License
22 |
23 | By contributing your code, you agree to license your contribution under the terms of the AGPLv3: [LICENSE](LICENSE)
24 |
25 | All files are released with the AGPL v3 license.
26 |
27 | If you are adding a new file it should have a header like this:
28 |
29 | ```
30 | """
31 | Daksha
32 | Copyright (C) 2021 myKaarma.
33 | opensource@mykaarma.com
34 | This program is free software: you can redistribute it and/or modify
35 | it under the terms of the GNU Affero General Public License as published by
36 | the Free Software Foundation, either version 3 of the License, or
37 | (at your option) any later version.
38 | This program is distributed in the hope that it will be useful,
39 | but WITHOUT ANY WARRANTY; without even the implied warranty of
40 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41 | GNU Affero General Public License for more details.
42 | You should have received a copy of the GNU Affero General Public License
43 | along with this program. If not, see
29 | Daksha Recorder
30 |
31 | {
32 | props.setState(dakshaRecorderMainPage);
33 | let url = "";
34 | chrome.tabs.query({ active: true, lastFocusedWindow: true }, tabs => {
35 | url = tabs[0].url;
36 | let obj = {
37 | "type": "start",
38 | "msg": url
39 | }
40 | chrome.tabs.sendMessage(tabs[0].id, obj, () => { return true; });
41 | setBadgeForRecording();
42 | });
43 |
44 | }}>
45 | START RECORDING
46 |
47 |
32 |
58 |
59 | )
60 | }
61 |
62 | export default DakshaRecorderCustomHardwaitPage;
--------------------------------------------------------------------------------
/daksha_know-how/QuickStart.md:
--------------------------------------------------------------------------------
1 | # Quick Start
2 |
3 | Welcome to Daksha! This quick start guide will walk you through the process of running your first testcase using Daksha. Follow these three main steps to get started:
4 |
5 | 1. Run the Daksha Server.
6 | 2. Create a `test.yml` using the Daksha Recorder.
7 | 3. Send an API request to Daksha.
8 |
9 | ## Using Docker (Recommended for Users)
10 |
11 | ### Run Daksha Server
12 |
13 | - Open your terminal or command prompt based on your operating system.
14 | - Clone the [Daksha Repository](https://github.com/mykaarma/daksha):
15 | props.setState(dakshaRecorderMainPage)}>
33 | Back
34 |
35 |
36 |
37 |
57 |
38 | CUSTOM HARD WAIT
39 |
40 |
41 |
42 | func(e.target.value)} />
43 |
44 |
56 | ```git clone https://github.com/mykaarma/daksha.git``` 16 | - Navigate to the directory where you cloned Daksha and open a terminal here. 17 |
```cd daksha``` 18 | - Install Docker Desktop. Refer [Docker Documentation](https://docs.docker.com/compose/install/) 19 | - Start the Docker engine. 20 | - Create a test-data directory. 21 |
```mkdir test-data``` 22 | - Inside the test-data directory create a db-data directory. The database files will reside in this directory. 23 |
```mkdir test-data/db-data``` 24 | - Run the command `docker-compose up -d` to initiate the build and deploy the project. 25 | For macOS the command will be `docker compose up -d`. 26 | - You now have the daksha server running. 27 | 28 | ### Create a test YAML file using the Daksha Recorder 29 | 30 | - Open chrome web store and add [Daksha Recorder Extension](https://chrome.google.com/webstore/detail/daksha-recorder/gmpmpceenkghjdlelhgepnknlijllfom?utm_source=ext_sidebar&hl=en-GB) to your chrome. 31 | - Please refer to this [video recording](https://youtu.be/4FRdS2iJZoQ?t=986) for creating a test.yml using Daksha Recorder. 32 | - Download the test YAML (HelloWorld.yml) from Daksha Recorder. 33 | - The following configs are user specific , so the recorder keeps them empty.You will need to edit the downloaded YAML file to add the following values. 34 | ``` 35 | config: 36 | env: local 37 | browser: chrome 38 | driverAddress: http://selenium-hub:4444/wd/hub 39 | name: HelloWorld 40 | ``` 41 | Here is an exapmle test YAML file- HelloWorld.yml 42 | - Move this file to the `test-data` directory created in previous step. 43 | 44 | ### Hit API Request 45 | 46 | - Copy the following curl request. Replace the email field and path field in the curl.
Path should be `/test-data/{your file name}`. This is the path of the test.yml that you had copied in the test-data directory and mounted in docker. 47 | ``` 48 | curl --location --request POST 'http://127.0.0.1:8083/daksha/runner' \ 49 | --header 'Content-Type: text/plain' \ 50 | --data-raw '{ 51 | "email": "your.email@mykaarma.com", 52 | "test": { 53 | "source": "local", 54 | "type": "file", 55 | "path": "/daksha/test-data/HelloWorld.yml", 56 | "variables": "" 57 | } 58 | }' 59 | 60 | ``` 61 | 62 | ### See what is happening inside the test 63 | 64 | - Open this url http://localhost:4444/ui#/sessions 65 | - In sessions you will see active session being generated on hitting the API request. 66 | - Click on the video icon and enter password `secret`. You will be able to see what the steps being executed in chrome. 67 | -------------------------------------------------------------------------------- /examples/API_support.yml: -------------------------------------------------------------------------------- 1 | config: 2 | env: local 3 | browser: chrome 4 | driverAddress: D:\Recover\chromedriver_win32\chromedriver.exe 5 | # driverAddress: http://192.168.21.185:4444/wd/hub 6 | name: APISupportTestExample 7 | task: 8 | - make_HTTP_request: 9 | request: 'POST' 10 | url : 'https://fakerestapi.azurewebsites.net/api/v1/Activities' 11 | headers : 12 | accept: text/plain; v=1.0 13 | Content-Type: application/json; v=1.0 14 | data: ' 15 | { 16 | "id": 0, 17 | "title": "string", 18 | "dueDate": "2021-06-23T18:03:18.689Z", 19 | "completed": true 20 | }' 21 | response: 22 | 'status' : 200 #first check the response and then we will move ahead 23 | save: #user need to pass this save key and the values must be passed as lists 24 | - 'key' : "title" 25 | 'save in' : title 26 | - make_HTTP_request: 27 | request : 'GET' 28 | url : 'https://httpbin.org/basic-auth/{{username}}/{{passwd}}' 29 | headers: 30 | accept : 'application/json' 31 | auth: 32 | type : "Basic" #can be Basic, Digest and Proxy 33 | username : "{{ username}}" 34 | password : "{{ passwd }}" 35 | Cookies: 36 | custom_cookie : 37 | 'cookie_name': 'cookie_value' 38 | timeout: 12 #it can be integer or tuple 39 | response: 40 | 'status' : 200 #after making the http request, first check the response and then we will move ahead 41 | save: #user need to pass this save key and the values must be passed as lists 42 | - 'save in' : response_get_body 43 | - make_HTTP_request: 44 | request: 'PUT' 45 | url : 'https://fakerestapi.azurewebsites.net/api/v1/Activities/{{id}}' 46 | headers : 47 | accept: text/plain; v=1.0 48 | Content-Type: application/json; v=1.0 49 | payload: '{ 50 | "id": 1, 51 | "title": "string", 52 | "dueDate": "2021-06-14T03:56:36.635Z", 53 | "completed": true 54 | }' 55 | # response: 56 | # 'status' : 200 #no status code provided 57 | - make_HTTP_request: 58 | request: 'POST' 59 | url : 'https://httpbin.org/post' 60 | headers : 61 | 'accept' : 'application/json' 62 | raw-data: > 63 | { 64 | "form": { 65 | "comments": "fast", 66 | "custemail": "rg@gmail.com", 67 | "custname": "Rg", 68 | "custtel": "783849", 69 | "delivery": "18:30", 70 | "size": "medium", 71 | "topping": [ 72 | "cheese", 73 | "onion", 74 | "mushroom" 75 | ] 76 | } 77 | } 78 | response: 79 | 'status' : 200 #after making the http request, first check the response and then we will move ahead 80 | - make_HTTP_request: 81 | request: 'DELETE' 82 | url : 'https://httpbin.org/delete' 83 | headers : 84 | 'accept' : 'application/json' 85 | response: 86 | 'status' : 201 #status mismatch 87 | save: #user need to pass this save key and the values must be passed as lists 88 | - 'save in' : response_delete_body -------------------------------------------------------------------------------- /recorder/extensions/chrome/src/App.js: -------------------------------------------------------------------------------- 1 | /* 2 | Daksha 3 | Copyright (C) 2021 myKaarma. 4 | opensource@mykaarma.com 5 | This program is free software: you can redistribute it and/or modify 6 | it under the terms of the GNU Affero General Public License as published by 7 | the Free Software Foundation, either version 3 of the License, or 8 | (at your option) any later version. 9 | This program is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | GNU Affero General Public License for more details. 13 | You should have received a copy of the GNU Affero General Public License 14 | along with this program. If not, see
29 |
73 |
74 | )
75 | }
76 |
77 |
78 |
79 | export default DakshaRecorderEndPage;
--------------------------------------------------------------------------------
/engine/thread_executor.py:
--------------------------------------------------------------------------------
1 | """
2 | Daksha
3 | Copyright (C) 2022 myKaarma.
4 | opensource@mykaarma.com
5 | This program is free software: you can redistribute it and/or modify
6 | it under the terms of the GNU Affero General Public License as published by
7 | the Free Software Foundation, either version 3 of the License, or
8 | (at your option) any later version.
9 | This program is distributed in the hope that it will be useful,
10 | but WITHOUT ANY WARRANTY; without even the implied warranty tof
11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | GNU Affero General Public License for more details.
13 | You should have received a copy of the GNU Affero General Public License
14 | along with this program. If not, see
30 | Daksha Recorder
31 |
32 |
33 |
72 | {
34 | props.setState(dakshaRecorderStartingPage);
35 | chrome.tabs.query({ active: true, lastFocusedWindow: true }, tabs => {
36 | let obj = {
37 | "type": "download"
38 | }
39 | chrome.tabs.sendMessage(tabs[0].id, obj, () => { return true; });
40 | })
41 | }}>
42 | DOWNLOAD
43 |
44 | {
45 | props.setState(dakshaRecorderStartingPage);
46 | chrome.tabs.query({ active: true, lastFocusedWindow: true }, tabs => {
47 | let obj = {
48 | "type": "copy_to_clipboard"
49 | }
50 | chrome.tabs.sendMessage(tabs[0].id, obj, () => { return true; });
51 | })
52 | }}>
53 | COPY TO CLIPBOARD
54 |
55 |
71 | element with id="piechart"
137 | var chart = new google.visualization.PieChart(document.getElementById('piechart'));
138 | chart.draw(data, options);
139 | }catch (e) {
140 |
141 | }
142 |
143 |
144 | }
--------------------------------------------------------------------------------
/daksha_know-how/CreateTest.md:
--------------------------------------------------------------------------------
1 | # Writing Your First Test Case with Daksha
2 |
3 | You need to write test case in yml file and it should be in the following format -
4 | ```config:
5 | name:
6 | task:
7 | ```
8 | A complete test case example is given below along with the description of each field and functionality that we are supporting:
9 |
10 | ```
11 | config:
12 | env: remote
13 | browser: chrome
14 | #driverAddress: /Users/IdeaProjects/qa-automation/ui_automation_engine/drivers/chromedriver
15 | driverAddress: http://192.168.21.185:4444/wd/hub
16 | name:TestQA
17 | labels:
18 | team: your_team
19 | alert_type : gchat
20 | task:
21 | - launch_browser
22 | - open_url:
23 | url: https://app.mykaarma.com
24 | - fill_data:
25 | xpath: //*[@id='firstPhaseInputs']//input[@placeholder='Username']
26 | value: '{{ username }}'
27 | - click_button:
28 | xpath: //*[@id='bSignIn']
29 | - fill_data:
30 | xpath: //*[@id='password']
31 | value: '{{ password }}'
32 | - click_button:
33 | xpath: //*[@id='bchromedriverSignIn']
34 | - wait_for:
35 | mode: visibility
36 | xpath: //div[@class='headertoprightDealerName']
37 | - validate_ui_element:
38 | mode: equals
39 | xpath: //div[@class='headertoprightDealerName']
40 | value: myKaarma
41 | - wait_for:
42 | mode: hardwait
43 | value: 20
44 | - click_button:
45 | xpath: //*[text()='Sign Out']
46 | - wait_for:
47 | mode: invisibility
48 | xpath: //div[@class='headertoprightDealerName']
49 |
50 | - quit_browser
51 | ```
52 |
53 |
54 | * **config**-This should contain the browser configurations. It has three fields namely env,browser,driverAddress.
55 | * **env**-It may have two values- remote or local. For witnessing your tests being executed in your device,you can set this to local and then give the browser details in the next 2 fileds. Similarly if you want your test to be executed at a remote browser you can set this to remote.Users can use a VNC client to see the tests being executed in remote browser.
56 | * **browser**-Currently we are supporting chrome only, so the value should be chrome.
57 | * **driverAddress**-You can either give location of your local chrome browser or the url at which your remote chrome browser is hosted.
58 | * **name**- Give a name to your testcase.This will be dispayed in your test report.
59 | * **labels**- This is an optional field. The user can provide labels regarding the test. These will be used in setting up attributes in Report Portal which will help in setting up dashboard.
60 | * **alert_type**- Include this in your yaml if you want to send the test failure alerts to any communication channel like gchat/slack,if not included it will not send any alerts.Currently it supports values - gchat,slack.You will have to set *ALERT_URL* env variable in case you have set *alert_type* in your yaml.
61 | * **task**- This will contain the steps of your test.For writing this section please take a look at the list of functionalities that we are providing in the below list.You can perform simple to complex test cases with a combination of the below functionalities.
62 | * ***launch_browser***: This will launch the browser in the environment and location provided in the config field.You should always include this step in the start of your test case steps.
63 | * ***open_url***: Provide the url of the site that you want to perform tests on.
64 | * ***fill_data***: This has two sub-fields,namely *locator* and *value* . **Locator** can be *xpath, id, css, name, tagname, classname, linktext and partiallinktext*. In **locator** you should provide the type of locator you are providing followed by the webelement where you want to fill the data and in the *value* field provide the data that you want to enter.
65 | * ***'{{ variablename }}'***: This is placeholder variable, you should provide their values through ApiRequest.
66 | * ***click_button***: You need to provide the locator of the webelement that you want to click.
67 | * ***validate_ui_element***: This has 3 field: *mode, locator, value*.In *mode* you can select 3 types of validation method namely **equals,contains and not contains**.In *locator* give the locator of your webelement and in *value* give the text with which you want to validate.
68 | * **refresh_page**: This can be added to refresh the webpage.
69 | * **open_new_tab**: This will open a new tab in your browser.
70 | * **switch_to_tab**: Here the title of the tab to which you want to move to needs to be provided as a subfield.
71 | * **navigate_back**: This can be used to go back to previous page.
72 | * **switch_iframe**: Here you need to provide the **locator** as a subfield and it will switch to that iframe.
73 | * **switch_to_default_iframe**: This will take you to the default frame.
74 | * **execute_js**: Execute any js command in the browser.
75 | * **scroll_to**: You need to provide the locator of the webelement that you want to scroll down/up to.**Locator** can be *xpath, id, css, name, tagname, classname, linktext and partiallinktext*
76 | * **wait-for**: This has 2 fields- mode, value/locator.This has 3 mode : *visibility,invisibility,hardwait*.For *visibility/invisibility* please provide the locator of the webelement that you want to wait for. In case of mode *hardwait*, please provide the value as number of seconds you want to wait for.
77 | * **quit_browser**: You are recommended to add this step at the end of your test case steps to quit the remote or local browser.
78 |
79 |
80 |
81 |
82 |
83 |
84 |
--------------------------------------------------------------------------------
/recorder/extensions/chrome/src/Components/dakshaRecorderMainPage.js:
--------------------------------------------------------------------------------
1 | /*
2 | Daksha
3 | Copyright (C) 2021 myKaarma.
4 | opensource@mykaarma.com
5 | This program is free software: you can redistribute it and/or modify
6 | it under the terms of the GNU Affero General Public License as published by
7 | the Free Software Foundation, either version 3 of the License, or
8 | (at your option) any later version.
9 | This program is distributed in the hope that it will be useful,
10 | but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | GNU Affero General Public License for more details.
13 | You should have received a copy of the GNU Affero General Public License
14 | along with this program. If not, see 
{
35 | props.changeImage(2);
36 | chrome.tabs.query({ active: true, lastFocusedWindow: true }, tabs => {
37 | let obj = {
38 | "type": "pause"
39 | }
40 | chrome.tabs.sendMessage(tabs[0].id, obj, () => { return true; });
41 | removeBadgeForRecording();
42 | })
43 | }
44 | } />
45 | )
46 | else if (props.image === play) {
47 | return (
48 | 
{
49 | props.changeImage(1);
50 | chrome.tabs.query({ active: true, lastFocusedWindow: true }, tabs => {
51 | let obj = {
52 | "type": "resume"
53 | }
54 | chrome.tabs.sendMessage(tabs[0].id, obj, () => { return true; });
55 | setBadgeForRecording();
56 | })
57 | }} />
58 | )
59 | }
60 | }
61 | function DakshaRecorderMainPage(props) {
62 | return (
63 | <>
64 |
For example: Sign in to any of your social media account and sign out or sign in then perform a task and then sign out.
The API request should comprise of the location of the yml file.To summarize in simple terms the working can be divided into two steps - 6 | * [Sending API Request](daksha_know-how/ApiRequest.md) 7 | * [Writing Test Case](daksha_know-how/CreateTest.md) 8 | 9 | You can also auto-generate test yamls through Daksha Recorder [chrome extension](recorder/extensions/chrome/ReadMe.md). 10 | 11 | ## Quickstart 12 | #### ⚠️ Warning (This is not compatible with ARM64 architecture.) 13 | 14 | To run your first test case with Daksha, follow the steps in [QuickStart](daksha_know-how/QuickStart.md). 15 | 16 | ## Building and Running 17 | 18 | ### Using docker 19 | 20 | - Setup a local or remote chromedriver for your tests 21 | - Take a look at [docker-compose.yml](docker-compose.yml) file and create all the necessary [environment variables](#environment-variables). 22 | - Run the command `docker-compose up -d` to initiate the build and deploy the project. 23 | 24 | - NOTE: If you're running the application through docker and intend to run scripts saved locally, make sure to mount the location of test yamls to the container so that test yamls could be accessed from inside of container. 25 | 26 | ### Local deployment (without docker) 27 | 28 | - Download [python 3.8+](https://www.python.org/downloads/) and setup a [virtual environment](https://docs.python.org/3/tutorial/venv.html) 29 | - Install all requirements using `pip install -r requirements.txt` 30 | - (Optional) Create any env variables needed. 31 | - Download Chromedriver (https://chromedriver.chromium.org/downloads) 32 | - Run `.\startup_command.bat` to start the project in case of Windows. 33 | - Run `sh startup_command.sh` to start the project in case of Linux. 34 | - Run `sh startup_command_mac.sh` to start the project in case of MacOS. 35 | 36 | ## Setting up webdriver 37 | We only support chromedriver at this point. 38 | 39 | ### Local Webdriver 40 | Download Chromedriver according to your chrome version from https://chromedriver.chromium.org/downloads. You can later refer this path from your test yml. 41 | 42 | ### Remote Webdriver 43 | Setup selenium grid using https://www.selenium.dev/downloads/. Or if you want to use the dockerized version you can download and run selenium grid images from dockerhub: https://hub.docker.com/u/selenium. 44 | 45 | ## Database 46 | - The user can opt for this functionality if he/she wants to save the test results in the database. 47 | - To enable this, please provide the following environment variables:- 48 | `TEST_RESULT_DB`, `PG_DB`, `PG_USER`, `PG_PASSWORD`, `PG_HOST`, `PG_PORT` 49 | 50 | - We only support Postgresql database at this point. To enable this one has to set the environment variable `TEST_RESULT_DB` to `postgres`. 51 | - This functionality is optional and Daksha workflow does not depend on it. 52 | 53 | ### Deploying Daksha with Database enabled by Docker 54 | - Run the command `docker-compose up -d` to initiate the build and deploy the project. 55 | 56 | ### Deploying Daksha with external Postgressql Database 57 | - This assumes that you have an external Postgresql database up and provide the correct environment variables :- 58 | `TEST_RESULT_DB`, `PG_DB`, `PG_USER`, `PG_PASSWORD`, `PG_HOST`, `PG_PORT` 59 | - Comment out the database service in [docker-compose file](./docker-compose.yml). 60 | - Run the command `docker-compose up -d` to initiate the build and deploy the project. 61 | 62 | ## Cron Jobs 63 | - The user can opt for this functionality if he/she wants to run tests at regulated intervals without hitting the api endpoints. 64 | - To enable this the user has to provide an environment variable `CRON_ENABLED` and set it to `true`. 65 | - If `CRON_ENABLED` is `true` then user has to provide additional environment variables `CRON_FILE_SOURCE` 66 | and `CRON_FILE_PATH`. 67 | - The user has to provide the description of Cron Jobs he/she wants to regulate in a YAML file. This yaml file can be loaded locally or from github. In both cases the necessary environment variables have to be set up accordingly. 68 | - Note that the YAML file containing cron jobs description and the YAML files containing the tests to be executed must not be present in same sub folders in the github branch. 69 | - The format of the yaml file containing the cron jobs description is provided in [CronJob Description](daksha_know-how/CronJobsDescription.md) 70 | 71 | - If the user is deploying the application locally, the CronJob functionality is only supported in Unix-like operating systems like Linux and macOS. 72 | - Windows users need to deploy the application using Docker to avail the CronJob functionality. 73 | 74 | ## Receiving Test Result Data 75 | - The user can recieve the test result data by providing TestUUID. 76 | - In order to utilize this functionality, the user must have chosen the database feature and configured the required environment variables. 77 | - To receive the test result data, the user has to hit a GET request at the endpoint:- 78 | - `http://127.0.0.1:8083/daksha/tests/{testuuid}` if the application is deployed through docker. 79 | - `http://127.0.0.1:8000/daksha/tests/{testuuid}` if the application is deployed locally. 80 | - The user has the option to retrieve test result data for all tests associated with a TestUUID or can specify the desired test name in the query parameters as :- 81 | - `http://127.0.0.1:8083/daksha/tests/{testuuid}?testName={testName}` if the application is deployed through docker. 82 | - `http://127.0.0.1:8000/daksha/tests/{testuuid}?testName={testName}` if the application is deployed locally. 83 | - Different possibles responses are:- 84 | - Status Code 405 : Method not allowed 85 | - Please recheck that the method of the request is GET. 86 | - Status Code 400 : Bad Request 87 | - Please recheck that the TestUUID is entered correctly. 88 | - Please recheck that the Test Names provided in the query parameters are given correctly. 89 | - Please recheck that the database functionality is opted for and all the necessary environment variables are set. 90 | - Status Code 404 : Page not found 91 | - Please recheck that the correct endpoint is being hit. 92 | 93 | ## Report Portal 94 | - Users can choose to integrate Daksha test reports with [Report Portal](https://github.com/reportportal). 95 | - To enable this integration, users need to provide specific environment variables: 96 | `REPORT_PORTAL_ENABLED`, `REPORT_PORTAL_PROJECT_NAME`, `REPORT_PORTAL_ENDPOINT`, `REPORT_PORTAL_TOKEN`. 97 | - To enable this functionality, set the value of `REPORT_PORTAL_ENABLED` to `True`. 98 | - User must have deployed Report Portal through building the [Report Portal Docker Compose file](https://github.com/reportportal/reportportal/blob/master/docker-compose.yml). 99 | - The user can also use the same Postgres server for Report Portal and Daksha.To enable this, Please edit the [Report Portal Docker Compose file](https://github.com/reportportal/reportportal/blob/master/docker-compose.yml) and expose the ports of the Postgres Database before initiating the build. 100 | - This can be done by uncommenting the ports section for postgres service defined in the yml file. 101 | - Users must ensure that the Report Portal service is deployed and that the environment variable values align with the deployed service. 102 | - Run the command `docker-compose up -d` to initiate the build and deploy the project. 103 | 104 | ## #Environment Variables 105 | You can configure the application in a lot of ways by setting the following environment variables: 106 | * **STORAGE_PATH** 107 | * This is the location of directory where reports generated by the application are stored. 108 | * Defaults to 'reports' in current directory. 109 | 110 | * **APACHE_URL** 111 | * If you're using a hosting service (like apache) to host your reports, put the base URL here. 112 | * Make sure that this base url is mapped to whatever location the reports are stored. (governed by **STORAGE_PATH** environment variable) 113 | 114 | * **LOG_FILE** 115 | * This is the location where reports generated by the application are stored. 116 | * Defaults to 'logs/uiengine.log' in current directory. 117 | 118 | * **POSTMARK_TOKEN** 119 | * This is the postmark token which will be used to send reports by email. 120 | * If not set, we'll skip sending the email. 121 | 122 | * **ALERT_URL** 123 | * This is the alert webhook url which will be used to send alerts in gchat/slack. 124 | * If not set, we'll skip sending the alert. 125 | 126 | * **EMAIL_HOST_USER** 127 | * This is the email ID from which reports should be sent. 128 | 129 | * **GIT_USER** 130 | * Github username for logging into github to fetch test yamls. 131 | * Don't set it/Leave it blank if the repo is public and no authentication is needed. 132 | 133 | * **GIT_PASS** 134 | * Github password for logging into github to fetch test yamls. 135 | * Don't set it/Leave it blank if the repo is public and no authentication is needed. 136 | 137 | * **REPO_USER** 138 | * Name of user who owns the github repository containing the test yamls. 139 | * Only one of the variables **REPO_USER** and **REPO_ORG** should be set at a time. 140 | 141 | * **REPO_ORG** 142 | * Name of organization which owns the github repository containing the test yamls. 143 | * Only one of the variables **REPO_USER** and **REPO_ORG** should be set at a time. 144 | 145 | * **REPO_NAME** 146 | * Name of the github repository containing the test yamls. 147 | 148 | * **BRANCH_NAME** 149 | * Name of the branch containing the test yamls in the github repository defined by **REPO_NAME**. 150 | 151 | * **DJANGO_SECRET_KEY** 152 | * Use this variable if you want to override the default value of SECRET_KEY for added security. 153 | 154 | * **ALLOWED_HOSTS** 155 | * Provide a comma separated list of hosts which you'd like to be added to ALLOWED_HOSTS. 156 | 157 | * **TEST_RESULT_DB** 158 | * If you want to use the Postgresql database to save your test reports, create this environment variable and set its value to `postgres`. 159 | * If you set this value as `postgres`, you need to provide additional environment variables. 160 | * If you don't want the database functionality, delete this environment variable or set it to disabled. 161 | 162 | * **PG_DB** 163 | * Name of the database. If this value is not provided, the default name of database will be `postgres`. 164 | 165 | * **PG_USER** 166 | * Name of the User. If this value is not provided, the default name of user will be `postgres`. 167 | 168 | * **PG_PASSWORD** 169 | * Password corresponding to the user. Default password for user postgres is `postgres`. 170 | 171 | * **PG_HOST** 172 | * The host of our database. If this value is not provided, the default host is `localhost`. 173 | 174 | * **PG_PORT** 175 | * Port provided to the database. If this value is not provided, the default port will be `5432`. 176 | 177 | * **CRON_ENABLED** 178 | * If you want to run tests at regulated intervals, set this variable to `true`. 179 | * If you don't want to run cron jobs, delete this environment variable or set it to `false`. 180 | 181 | * **CRON_FILE_SOURCE** 182 | * This value can either be `local` or `git`. It denotes the source of yaml file which contains Cron jobs description. 183 | 184 | * **CRON_FILE_PATH** 185 | * This value should be set to the path of the yaml file which contains cron job description. 186 | 187 | * **REPORT_PORTAL_ENABLED** 188 | * This value should be set to `True` if the user wants the Test reports to be displayed in Report Portal. 189 | 190 | * **REPORT_PORTAL_ENDPOINT** 191 | * This value should be set to the URL of the ReportPortal server where the client should connect to. 192 | 193 | * **REPORT_PORTAL_PROJECT_NAME** 194 | * This values should be set to the name of the specific project or workspace within ReportPortal where the user wants to show the Daksha test reports. 195 | 196 | * **REPORT_PORTAL_TOKEN** 197 | * This value should match the authentication token provided by the user-deployed ReportPortal.Please refer [Token to be used by Report Portal Client Tools](https://reportportal.io/docs/reportportal-configuration/HowToGetAnAccessTokenInReportPortal/#2-authorization-with-users-uuid-access-token-for-agents) 198 | 199 | ## Get in Touch 200 | 201 | * Open an issue at: https://github.com/mykaarma/daksha/issues 202 | * Email us at: opensource@mykaarma.com 203 | 204 | ## Contributions 205 | 206 | We welcome contributions to Daksha. Please see our [contribution guide](CONTRIBUTING.md) for more details. 207 | 208 | ## License 209 | Copyright 2021 myKaarma 210 | 211 | Licensed under the [GNU Affero General Public License v3](LICENSE) 212 | 213 | ## Motivation 214 | 215 | [Information Modal](https://github.com/mykaarma/information-modal) 216 | -------------------------------------------------------------------------------- /recorder/extensions/chrome/src/ContentScript.js: -------------------------------------------------------------------------------- 1 | 2 | /* 3 | Daksha 4 | Copyright (C) 2021 myKaarma. 5 | opensource@mykaarma.com 6 | This program is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Affero General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU Affero General Public License for more details. 14 | You should have received a copy of the GNU Affero General Public License 15 | along with this program. If not, see
65 |
119 |
120 | )
121 | }
122 |
123 | export default DakshaRecorderMainPage;
--------------------------------------------------------------------------------
/engine/executor.py:
--------------------------------------------------------------------------------
1 | """
2 | Daksha
3 | Copyright (C) 2021 myKaarma.
4 | opensource@mykaarma.com
5 | This program is free software: you can redistribute it and/or modify
6 | it under the terms of the GNU Affero General Public License as published by
7 | the Free Software Foundation, either version 3 of the License, or
8 | (at your option) any later version.
9 | This program is distributed in the hope that it will be useful,
10 | but WITHOUT ANY WARRANTY; without even the implied warranty of
11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 | GNU Affero General Public License for more details.
13 | You should have received a copy of the GNU Affero General Public License
14 | along with this program. If not, see
66 | Daksha Recorder
67 |
68 |
69 | 
{
71 | props.setState(dakshaRecorderEndPage);
72 | removeBadgeForRecording();
73 | chrome.tabs.query({ active: true, lastFocusedWindow: true }, tabs => {
74 | let obj = {
75 | "type": "stop"
76 | }
77 | chrome.tabs.sendMessage(tabs[0].id, obj, () => { return true; });
78 | })
79 | }} />
80 |
81 |
82 |
118 |
83 |
97 | {
84 | chrome.tabs.query({ active: true, lastFocusedWindow: true }, tabs => {
85 | let obj = {
86 | "type": "tenSecondsWait"
87 | }
88 | chrome.tabs.sendMessage(tabs[0].id, obj, () => { return true; });
89 | })
90 | }}>
91 | HARD WAIT (10 SEC)
92 |
93 | props.setState(dakshaRecorderCustomHardwaitPage)}>
94 | 
95 |
96 | {
98 | chrome.tabs.query({ active: true, lastFocusedWindow: true }, tabs => {
99 | let obj = {
100 | "type": "viewYaml"
101 | }
102 | chrome.tabs.sendMessage(tabs[0].id, obj, () => { return true; });
103 | })
104 | }}>
105 | VIEW YAML
106 |
107 | {
108 | chrome.tabs.query({ active: true, lastFocusedWindow: true }, tabs => {
109 | let obj = {
110 | "type": "undoLastStep"
111 | }
112 | chrome.tabs.sendMessage(tabs[0].id, obj, () => { return true; });
113 | })
114 | }}>
115 | UNDO LAST STEP
116 |
117 | For example: Sign in to any of your social media account and sign out or sign in then perform a task and then sign out.
The API request should comprise of the location of the yml file.To summarize in simple terms the working can be divided into two steps - 6 | * [Sending API Request](daksha_know-how/ApiRequest.md) 7 | * [Writing Test Case](daksha_know-how/CreateTest.md) 8 | 9 | You can also auto-generate test yamls through Daksha Recorder [chrome extension](recorder/extensions/chrome/ReadMe.md). 10 | 11 | ## Quickstart 12 | #### ⚠️ Warning (This is not compatible with ARM64 architecture.) 13 | 14 | To run your first test case with Daksha, follow the steps in [QuickStart](daksha_know-how/QuickStart.md). 15 | 16 | ## Building and Running 17 | 18 | ### Using docker 19 | 20 | - Setup a local or remote chromedriver for your tests 21 | - Take a look at [docker-compose.yml](docker-compose.yml) file and create all the necessary [environment variables](#environment-variables). 22 | - Run the command `docker-compose up -d` to initiate the build and deploy the project. 23 | 24 | - NOTE: If you're running the application through docker and intend to run scripts saved locally, make sure to mount the location of test yamls to the container so that test yamls could be accessed from inside of container. 25 | 26 | ### Local deployment (without docker) 27 | 28 | - Download [python 3.8+](https://www.python.org/downloads/) and setup a [virtual environment](https://docs.python.org/3/tutorial/venv.html) 29 | - Install all requirements using `pip install -r requirements.txt` 30 | - (Optional) Create any env variables needed. 31 | - Download Chromedriver (https://chromedriver.chromium.org/downloads) 32 | - Run `.\startup_command.bat` to start the project in case of Windows. 33 | - Run `sh startup_command.sh` to start the project in case of Linux. 34 | - Run `sh startup_command_mac.sh` to start the project in case of MacOS. 35 | 36 | ## Setting up webdriver 37 | We only support chromedriver at this point. 38 | 39 | ### Local Webdriver 40 | Download Chromedriver according to your chrome version from https://chromedriver.chromium.org/downloads. You can later refer this path from your test yml. 41 | 42 | ### Remote Webdriver 43 | Setup selenium grid using https://www.selenium.dev/downloads/. Or if you want to use the dockerized version you can download and run selenium grid images from dockerhub: https://hub.docker.com/u/selenium. 44 | 45 | ## Database 46 | - The user can opt for this functionality if he/she wants to save the test results in the database. 47 | - To enable this, please provide the following environment variables:- 48 | `TEST_RESULT_DB`, `PG_DB`, `PG_USER`, `PG_PASSWORD`, `PG_HOST`, `PG_PORT` 49 | 50 | - We only support Postgresql database at this point. To enable this one has to set the environment variable `TEST_RESULT_DB` to `postgres`. 51 | - This functionality is optional and Daksha workflow does not depend on it. 52 | 53 | ### Deploying Daksha with Database enabled by Docker 54 | - Run the command `docker-compose up -d` to initiate the build and deploy the project. 55 | 56 | ### Deploying Daksha with external Postgressql Database 57 | - This assumes that you have an external Postgresql database up and provide the correct environment variables :- 58 | `TEST_RESULT_DB`, `PG_DB`, `PG_USER`, `PG_PASSWORD`, `PG_HOST`, `PG_PORT` 59 | - Comment out the database service in [docker-compose file](./docker-compose.yml). 60 | - Run the command `docker-compose up -d` to initiate the build and deploy the project. 61 | 62 | ## Cron Jobs 63 | - The user can opt for this functionality if he/she wants to run tests at regulated intervals without hitting the api endpoints. 64 | - To enable this the user has to provide an environment variable `CRON_ENABLED` and set it to `true`. 65 | - If `CRON_ENABLED` is `true` then user has to provide additional environment variables `CRON_FILE_SOURCE` 66 | and `CRON_FILE_PATH`. 67 | - The user has to provide the description of Cron Jobs he/she wants to regulate in a YAML file. This yaml file can be loaded locally or from github. In both cases the necessary environment variables have to be set up accordingly. 68 | - Note that the YAML file containing cron jobs description and the YAML files containing the tests to be executed must not be present in same sub folders in the github branch. 69 | - The format of the yaml file containing the cron jobs description is provided in [CronJob Description](daksha_know-how/CronJobsDescription.md) 70 | 71 | - If the user is deploying the application locally, the CronJob functionality is only supported in Unix-like operating systems like Linux and macOS. 72 | - Windows users need to deploy the application using Docker to avail the CronJob functionality. 73 | 74 | ## Receiving Test Result Data 75 | - The user can recieve the test result data by providing TestUUID. 76 | - In order to utilize this functionality, the user must have chosen the database feature and configured the required environment variables. 77 | - To receive the test result data, the user has to hit a GET request at the endpoint:- 78 | - `http://127.0.0.1:8083/daksha/tests/{testuuid}` if the application is deployed through docker. 79 | - `http://127.0.0.1:8000/daksha/tests/{testuuid}` if the application is deployed locally. 80 | - The user has the option to retrieve test result data for all tests associated with a TestUUID or can specify the desired test name in the query parameters as :- 81 | - `http://127.0.0.1:8083/daksha/tests/{testuuid}?testName={testName}` if the application is deployed through docker. 82 | - `http://127.0.0.1:8000/daksha/tests/{testuuid}?testName={testName}` if the application is deployed locally. 83 | - Different possibles responses are:- 84 | - Status Code 405 : Method not allowed 85 | - Please recheck that the method of the request is GET. 86 | - Status Code 400 : Bad Request 87 | - Please recheck that the TestUUID is entered correctly. 88 | - Please recheck that the Test Names provided in the query parameters are given correctly. 89 | - Please recheck that the database functionality is opted for and all the necessary environment variables are set. 90 | - Status Code 404 : Page not found 91 | - Please recheck that the correct endpoint is being hit. 92 | 93 | ## Report Portal 94 | - Users can choose to integrate Daksha test reports with [Report Portal](https://github.com/reportportal). 95 | - To enable this integration, users need to provide specific environment variables: 96 | `REPORT_PORTAL_ENABLED`, `REPORT_PORTAL_PROJECT_NAME`, `REPORT_PORTAL_ENDPOINT`, `REPORT_PORTAL_TOKEN`. 97 | - To enable this functionality, set the value of `REPORT_PORTAL_ENABLED` to `True`. 98 | - User must have deployed Report Portal through building the [Report Portal Docker Compose file](https://github.com/reportportal/reportportal/blob/master/docker-compose.yml). 99 | - The user can also use the same Postgres server for Report Portal and Daksha.To enable this, Please edit the [Report Portal Docker Compose file](https://github.com/reportportal/reportportal/blob/master/docker-compose.yml) and expose the ports of the Postgres Database before initiating the build. 100 | - This can be done by uncommenting the ports section for postgres service defined in the yml file. 101 | - Users must ensure that the Report Portal service is deployed and that the environment variable values align with the deployed service. 102 | - Run the command `docker-compose up -d` to initiate the build and deploy the project. 103 | 104 | ## #Environment Variables 105 | You can configure the application in a lot of ways by setting the following environment variables: 106 | * **STORAGE_PATH** 107 | * This is the location of directory where reports generated by the application are stored. 108 | * Defaults to 'reports' in current directory. 109 | 110 | * **APACHE_URL** 111 | * If you're using a hosting service (like apache) to host your reports, put the base URL here. 112 | * Make sure that this base url is mapped to whatever location the reports are stored. (governed by **STORAGE_PATH** environment variable) 113 | 114 | * **LOG_FILE** 115 | * This is the location where reports generated by the application are stored. 116 | * Defaults to 'logs/uiengine.log' in current directory. 117 | 118 | * **POSTMARK_TOKEN** 119 | * This is the postmark token which will be used to send reports by email. 120 | * If not set, we'll skip sending the email. 121 | 122 | * **ALERT_URL** 123 | * This is the alert webhook url which will be used to send alerts in gchat/slack. 124 | * If not set, we'll skip sending the alert. 125 | 126 | * **EMAIL_HOST_USER** 127 | * This is the email ID from which reports should be sent. 128 | 129 | * **GIT_USER** 130 | * Github username for logging into github to fetch test yamls. 131 | * Don't set it/Leave it blank if the repo is public and no authentication is needed. 132 | 133 | * **GIT_PASS** 134 | * Github password for logging into github to fetch test yamls. 135 | * Don't set it/Leave it blank if the repo is public and no authentication is needed. 136 | 137 | * **REPO_USER** 138 | * Name of user who owns the github repository containing the test yamls. 139 | * Only one of the variables **REPO_USER** and **REPO_ORG** should be set at a time. 140 | 141 | * **REPO_ORG** 142 | * Name of organization which owns the github repository containing the test yamls. 143 | * Only one of the variables **REPO_USER** and **REPO_ORG** should be set at a time. 144 | 145 | * **REPO_NAME** 146 | * Name of the github repository containing the test yamls. 147 | 148 | * **BRANCH_NAME** 149 | * Name of the branch containing the test yamls in the github repository defined by **REPO_NAME**. 150 | 151 | * **DJANGO_SECRET_KEY** 152 | * Use this variable if you want to override the default value of SECRET_KEY for added security. 153 | 154 | * **ALLOWED_HOSTS** 155 | * Provide a comma separated list of hosts which you'd like to be added to ALLOWED_HOSTS. 156 | 157 | * **TEST_RESULT_DB** 158 | * If you want to use the Postgresql database to save your test reports, create this environment variable and set its value to `postgres`. 159 | * If you set this value as `postgres`, you need to provide additional environment variables. 160 | * If you don't want the database functionality, delete this environment variable or set it to disabled. 161 | 162 | * **PG_DB** 163 | * Name of the database. If this value is not provided, the default name of database will be `postgres`. 164 | 165 | * **PG_USER** 166 | * Name of the User. If this value is not provided, the default name of user will be `postgres`. 167 | 168 | * **PG_PASSWORD** 169 | * Password corresponding to the user. Default password for user postgres is `postgres`. 170 | 171 | * **PG_HOST** 172 | * The host of our database. If this value is not provided, the default host is `localhost`. 173 | 174 | * **PG_PORT** 175 | * Port provided to the database. If this value is not provided, the default port will be `5432`. 176 | 177 | * **CRON_ENABLED** 178 | * If you want to run tests at regulated intervals, set this variable to `true`. 179 | * If you don't want to run cron jobs, delete this environment variable or set it to `false`. 180 | 181 | * **CRON_FILE_SOURCE** 182 | * This value can either be `local` or `git`. It denotes the source of yaml file which contains Cron jobs description. 183 | 184 | * **CRON_FILE_PATH** 185 | * This value should be set to the path of the yaml file which contains cron job description. 186 | 187 | * **REPORT_PORTAL_ENABLED** 188 | * This value should be set to `True` if the user wants the Test reports to be displayed in Report Portal. 189 | 190 | * **REPORT_PORTAL_ENDPOINT** 191 | * This value should be set to the URL of the ReportPortal server where the client should connect to. 192 | 193 | * **REPORT_PORTAL_PROJECT_NAME** 194 | * This values should be set to the name of the specific project or workspace within ReportPortal where the user wants to show the Daksha test reports. 195 | 196 | * **REPORT_PORTAL_TOKEN** 197 | * This value should match the authentication token provided by the user-deployed ReportPortal.Please refer [Token to be used by Report Portal Client Tools](https://reportportal.io/docs/reportportal-configuration/HowToGetAnAccessTokenInReportPortal/#2-authorization-with-users-uuid-access-token-for-agents) 198 | 199 | ## Get in Touch 200 | 201 | * Open an issue at: https://github.com/mykaarma/daksha/issues 202 | * Email us at: opensource@mykaarma.com 203 | 204 | ## Contributions 205 | 206 | We welcome contributions to Daksha. Please see our [contribution guide](CONTRIBUTING.md) for more details. 207 | 208 | ## License 209 | Copyright 2021 myKaarma 210 | 211 | Licensed under the [GNU Affero General Public License v3](LICENSE) 212 | 213 | ## Motivation 214 | 215 | [Information Modal](https://github.com/mykaarma/information-modal) 216 | -------------------------------------------------------------------------------- /recorder/extensions/chrome/src/ContentScript.js: -------------------------------------------------------------------------------- 1 | 2 | /* 3 | Daksha 4 | Copyright (C) 2021 myKaarma. 5 | opensource@mykaarma.com 6 | This program is free software: you can redistribute it and/or modify 7 | it under the terms of the GNU Affero General Public License as published by 8 | the Free Software Foundation, either version 3 of the License, or 9 | (at your option) any later version. 10 | This program is distributed in the hope that it will be useful, 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | GNU Affero General Public License for more details. 14 | You should have received a copy of the GNU Affero General Public License 15 | along with this program. If not, see