kholisabdullah / Device-Verification-Subsystem

SPDX-License-Identifier: BSD-4-Clause-Clear

Copyright (c) 2018-2019 Qualcomm Technologies, Inc.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• All advertising materials mentioning features or use of this software, or any deployment of this software, or documentation accompanying any distribution of this software, must display the trademark/logo as per the details provided here: https://www.qualcomm.com/documents/dirbs-logo-and-brand-guidelines
• Neither the name of Qualcomm Technologies, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

SPDX-License-Identifier: ZLIB-ACKNOWLEDGEMENT

Copyright (c) 2018-2019 Qualcomm Technologies, Inc.

This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:

• The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment is required by displaying the trademark/logo as per the details provided here: https://www.qualcomm.com/documents/dirbs-logo-and-brand-guidelines
• Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
• This notice may not be removed or altered from any source distribution.

NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Device Verification System (DVS)

Device Verification System (DVS) that is part of the Device Identification, Registration and Blocking (DIRBS) system.

Directory structure

This repository contains code for DVS part of the DIRBS. It contains

• app/ -- The DVS core server app, to be used as DVS Web Server including apis and resources
• etc/ -- Config files etc to be reside here
• mock/ -- Sample data files etc which are used in app to be reside here
• tests/ -- Unit test scripts and Data

Prerequisites

In order to run a development environment, Python 3.0+ and Postgresql10 we assume that these are installed.

We also assume that this repo is cloned from Github onto the local computer, it is assumed that all commands mentioned in this guide are run from root directory of the project and inside virtual environment

On Windows, we assume that a Bash like shell is available (i.e Bash under Cygwin), with GNU make installed.

Starting a dev environment

The easiest and quickest way to get started is to use local-only environment (i.e everything runs locally). To setup the local environment, follow the section below:

Setting up local dev environment

For setting up a local dev environment we assume that the prerequisites are met already. To setup a local environment:

• Create database using Postgresql (Name and credentials should be same as in config)
• Create virtual environment using virtualenv and activate it:

pip3 install virtualenv 
virtualenv venv
source venv/bin/activate

Make sure the virtual environment is made using python3

• Replace sample configuration in config.ini to similar configuration in tests/unittest_data/config.ini

• Replace sample conditions in etc/conditions.yml to classification conditions configured in DIRBS core system

• Create /reports folder in root directory

• Run Database migrations using:

make install-db

This will automatically create and migrate database schemas and requirements.

• Compile multi language encoded files

pybabel compile -d app/translations

• Start DVS development server using:

make start-dev

• Start celery worker

make start-celery

• To run unit tests, run

$ make test

• To lint the code using pylint, simply run:

make lint

###Other useful commands

• To install a fresh database:

make install-db

• To Upgrade already installed database:

make upgrade-db