Skip to content

Home

Jump to bottom
hriddhighosh4 edited this page Oct 21, 2024 · 28 revisions

Hello World!

Daksha is a django framework based dynamic test case execution API.You can write any variation of UI-based test cases in a yml file and execute them right away with this new tool in town.
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 -

Quickstart

  • Clone this repo into your local machine.
  • Open terminal and go to the daksha directory
  • Run the following commands to set up a virtual environment on mac/linux
pip3 install virtualenv
virtualenv daksha
source daksha/bin/activate

For windows you can follow the instructions here

  • Install the requirements.txt and run daksha.Run the following commands
 pip3 install -r requirements.txt
 python3 manage.py runserver

config:
  env: local
  browser: chrome
  driverAddress: Enter here
name: OpenGoogle
task:
  - launch_browser
  - open_url:
      url: https://www.google.com
  - quit_browser
  • Copy the below curl request and edit email and file fields.Enter your own email adress and the location of the yaml file created in the above step, then run the curl request.
    curl --location --request POST 'http://127.0.0.1:8000/daksha/runner' \
    --header 'Content-Type: text/plain' \
    --data-raw '{
       "email": "[email protected]",
       "test": {
        "source": "local",
        "type": "folder",
        "path": "/Users/Documents/daksha/examples",
        "variables" : {
           "username" : "ab@mykaarma",
           "password" : "@NoSoupForYou"
        }
      }
   }
                '

Building and Running

Using docker

  • Take a look at docker-compose.yml file and create all the necessary environment variables.

  • Run the command docker-compose up -d to initiate the build and deploy the project.

  • 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.

Local deployment (without docker)

  • Create a virtual environment using python 3.9
  • Install all requirements using pip install -r requirements.txt
  • Create any env variables needed
  • Run python manage.py runserver to start the project

Webdriver

Local WebDriver

  • Download the latest version of chromedriver from here and unzip it.
  • Use the location of installation in driverAddress in your test yaml

Remote WebDriver

  • Use selenium hub and selenium chromedriver in docker container
  • Use the url of the hub in the driverAddress in your test yaml

Environment Variables

You can configure the application in a lot of ways by setting the following environment variables:

  • STORAGE_PATH

    • This is the location of directory where reports generated by the application are stored.
    • Defaults to 'reports' in current directory.

  • APACHE_URL

    • If you're using a hosting service (like apache) to host your reports, put the base URL here.
    • Make sure that this base url is mapped to whatever location the reports are stored. (governed by STORAGE_PATH environment variable)

  • LOG_FILE

    • This is the location where reports generated by the application are stored.
    • Defaults to 'logs/uiengine.log' in current directory.

  • POSTMARK_TOKEN

    • This is the postmark token which will be used to send reports by email.
    • If not set, we'll skip sending the email.

  • EMAIL_HOST_USER

    • This is the email ID from which reports should be sent.

  • GIT_USER

    • Github username for logging into github to fetch test yamls.
    • Don't set it/Leave it blank if the repo is public and no authentication is needed.

  • GIT_PASS

    • Github password for logging into github to fetch test yamls.
    • Don't set it/Leave it blank if the repo is public and no authentication is needed.

  • REPO_USER

    • Name of user who owns the github repository containing the test yamls.
    • Only one of the variables REPO_USER and REPO_ORG should be set at a time.

  • REPO_ORG

    • Name of organization which owns the github repository containing the test yamls.
    • Only one of the variables REPO_USER and REPO_ORG should be set at a time.

  • REPO_NAME

    • Name of the github repository containing the test yamls.

  • BRANCH_NAME

    • Name of the branch containing the test yamls in the github repository defined by REPO_NAME.

  • DJANGO_SECRET_KEY

    • Use this variable if you want to override the default value of SECRET_KEY for added security.

  • ALLOWED_HOSTS

    • Provide a comma separated list of hosts which you'd like to be added to ALLOWED_HOSTS.

  • ALERT_URL

    • This is the alert webhook url which will be used to send alerts in gchat/slack.
    • If not set, we'll skip sending the alert.

Get in Touch

Contributions

We welcome contributions to Daksha. Please see our contribution guide for more details.

License

Copyright 2021 myKaarma

Licensed under the GNU Affero General Public License v3

Motivation

Information Modal

Clone this wiki locally