Index: README.md =================================================================== diff -u -r6114b6cad910ab91431069062054e4a549c56400 -r32e628abcbbd3fd70866505d9f2836a6f732ef06 --- README.md (.../README.md) (revision 6114b6cad910ab91431069062054e4a549c56400) +++ README.md (.../README.md) (revision 32e628abcbbd3fd70866505d9f2836a6f732ef06) @@ -1,45 +1,70 @@ + + ![Diality](images/logo.jpg) -# Dial-In +# Dialin -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. +This repository contains the source code for the Dialin API. +The Dialin 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. +To use this API, it is recommended to install the API directly from this locally hosted git repository. +It is also possible to install it from a pre-packaged .whl file. Once installed to your local +virtual python environment with pip, you can import modules as needed to develop your tests. +All released versions of this API will be officially versioned so backwards compatibility is maintained and API updates can continue without affecting +day-to-day testing. -Please note that the structure of this repository is still under review and the architecture is likely to change as improvements are made. +Please understand that the structure of this repository is still under review and the architecture is likely to change as improvements are made. +This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## Using the API ### Install directly from this repository -- Your ssh key has already been setup with our internal BitBucket servers -- Your computer must be in the office or you must be on VPN +- Assumes your ssh key has already been setup with our internal BitBucket servers +- Assumes your computer is in the office or that you are using LogMeIn. The VPN has a DNS issue which may break +the installation. -How to install from the master branch (Not yet available) -- Will be possible as soon as the dialin_refactoring_3 branch has been merged with the master branch +All release versions will eventually be placed on their own separate branch to facilitate +backwards compatibility and a fully accessible and testable API version history. + +How to install from the master branch + ``` #!/bin/bash virtualenv --python=python3 venv source venv/bin/activate pip3 install git+ssh://git@dvm-linux02:7999/vv/dialin.git ``` -How to install from the dialin_refactoring_3 branch (Available) +How to install a build from a specific branch. To change the branch, replace staging with the desired branch + ``` #!/bin/bash virtualenv --python=python3 venv source venv/bin/activate -branch="dialin_refactoring_3" +branch="staging" pip3 install git+ssh://git@dvm-linux02:7999/vv/dialin.git@$branch ``` @@ -50,9 +75,15 @@ virtualenv --python=python3 venv source venv/bin/activate -pip3 install dialin-0.0.1-py3-none-any.whl +pip3 install dialin--py3-none-any.whl ``` + +### Modules + +- Consult the Dialin API documentation which can be generated using the `tools/document.sh` script. +- See the tests directory for example usages of the API. + ## Dialin API Internal Development Environment ### Linux @@ -67,37 +98,28 @@ ### 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. +Due to a limitation in the underlying python-can library, Dialin does not currently support Windows. -For a brand new setup, after cloning this repository: -``` -> setup_environment_windows.bat +## Unit Testing -``` +All unit tests of the Dialin API can be found in tests/unit_tests. To run them: -If the windows environment has been previously set up: - ``` -> activate_environment_windows.bat +$ cd tools +$ ./run_unit_tests.sh 127 ↵ ``` +If there is a failure, the script will indicate what failed. No output means all tests have passed. -## Unit Testing +## Building the Dialin package -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 +$ ./build.sh ``` +[Changelog](CHANGELOG.md) -## Building the Dial-In package +[LICENSE](./LICENSE) -``` -$ ./build.sh -``` +