![Diality](images/logo.jpg)
# Dial-In

This repository contains the source code for the Dial-In API.
The Dial-In API supports cross-functional testing of the Denali system.
It supports the Systems level testing, Software Verification & Validation, and pre-release SW and FW developmental testing by exposing and simulating interaction with
 the UI, HD, and DG sub-components.

Cross functional team members may install this API from pre-packaged binary files that are hosted locally on Diality servers. Once installed to their local 
development environment with pip, they have access to a wide array of testing capabilities. 
All distribution packages are to be versioned so backwards compatibility is maintained and API updates can continue without affecting 
the users. After installation, users may import modules from the API as needed and run their automation tests. 


Please note that the structure of this repository is still under review and the architecture is likely to change as improvements are made.

## Environment Setup

### Linux

After cloning this repository, inside the repository root directory: 


```
$ cd tools 
$ ./setup_environment.sh
```

### Windows

Note that windows support for the python-can library has not been validated. 
As a result, this API is not functional on windows and windows support may have to be removed 
in the future.

For a brand new setup, after cloning this repository:

```
> setup_environment_windows.bat

```

If the windows environment has been previously set up:

```
> activate_environment_windows.bat
```


## Unit Testing

All internal tests of the dial-in API can be found in the tests directory at the root of
this git repository:

```
(venv) $ cd tests
(venv) $ python3 dialin_unit_test_example.py
```


## Building the Dial-In package

```
$ ./build.sh
```