Skip to content
CCExtractor's Sample & CI platform. Developed during GSoC 2016
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
cert
install
logs
migrations
mod_auth
mod_ci
mod_customized
mod_deploy
mod_home
mod_regression
mod_sample
mod_test
mod_upload
static
templates
tests
.coveragerc
.gitattributes
.gitignore
.pep8speaks.yml
.pycodestylerc
.pydocstylerc
.travis.yml
LICENSE
Pipfile
Pipfile.lock
README.md
bootstrap_gunicorn.py
config_parser.py
config_sample.py
database.py
decorators.py
log_configuration.py
mailer.py
mypy.ini
requirements.txt
run.py
test-requirements.txt
utility.py

README.md

CCExtractor Sample Platform

Build Status codecov

This repository contains the code for a platform that manages a test suite bot, sample upload and more. This platform allows for a unified place to report errors, submit samples, view existing samples and more. It was originally developed during GSoC 2015 and rewritten during GSoC 2016. It was further improved and worked upon during GSoC 2017 and GSoC 2018.

To see the live version of the platform, simply go to CCExtractor Submission Platform.

Concept

While CCExtractor is an awesome tool and it works flawlessly most of the time, bugs occur occasionally (as with all existing software). These are usually reported through a variety of channels (private email, mailing list, GitHub, and so on...).

The aim of this project is to build a platform, which is accessible to everyone (after signing up), that provides a single place to upload, view samples and associated test results.

Installation

An installation guideline can be found here: installation guide.

Database Migrations

Sample-Platform uses flask-migrate to handle database migrations.

If you want to perform more complex actions than the ones mentioned below, please have a look at the flask-migrate command reference.

NOTE: For the below commands to function properly, FLASK_APP=/path/to/run.py should be set in the environment variables.

First Time With Flask-Migrate

If this is the first time that flask-migrate is being installed or run alongside existing database, use the following command to create a head stamp in your database:

flask db stamp head

Applying Schema Update On Existing Database

It is recommeneded to perform Database upgrades, whenever database schema is updated, using the below commands:

flask db upgrade

Removing Last Schema Update On Existing Database

Remove the last database update using the below commands:

flask db downgrade

Updating Schema

Whenever a database model's schema is update, run the following command to generate migrations for it.

flask db migrate

Contributing

All information with regards to contributing can be found here: contributors guide.

Testing

Sample-platform is regularly tested via Travis CI.

We use nosetests to manage testing and it can be run locally as follows:

pipenv shell --three        # make virtual environment
pipenv install --dev        # install development dependencies
TESTING=True pipenv run nosetests --with-cov --cov-config .coveragerc

Etiquettes

We follow certain etiquettes which include docstrings, annotation, import sorting etc.

Setup

The operations listed below are only for developers. The tools used below can be installed at once as,

pipenv shell --three    # if not inside pipenv shell already
pipenv install --dev    # if first time running dev-dependencies

If you are adding a new module which will be required just by developers, use below commands.

pipenv install --dev [MODULE_NAME]

DocStrings Testing

Sample-platform uses docstrings heavily to document modules and methods.

We use pydocstyle to oversee the docstring format and etiquettes. Please run the following to check if you've followed the style before sending a PR.

pydocstyle ./           # check all .py files with pydocstyle

Imports

We use isort to introduce a style on how imports should be made.

Please check your imports before making a commit using the following commands.

isort --rc --diff .     # see proposed changes without applying them
isort -rc --atomic .    # apply changes to import order without breaking syntax

Generate Typing And Annotations

We use MonkeyType or PyType to generate typing for our code. It is a simple tool that [semi] automates the process of generating annotations using runtime trace.

To generate typing for your code, follow the below procedure.

Using MonkeyType

This method uses runtime trace information to generate typing and is highly recommended over using PyType.

NOTE: You must have written unit-tests for the new code in order to add annotations using MonkeyType.

monkeytype run `TESTING=True nosetests path/to/new.py/file:ClassName`     # classname where new tests added
monkeytype apply module.name                                               # apply the suggested changes

Using PyType

This method uses the knowledge of how the code is used to figure out the types.

NOTE: Only use this method only if MonkeyType method fails for the file.

pytype path/to/.py/file                    # path to the new code's file
merge-pyi -i path/to/.py/file .pytype/pyi/path/to/.pyi/file     # apply the suggested changes

Once you've generated the annotations using the above tools, follow the below procedure.

isort -rc --atmoic /path/to/new.py/file                                    # sort the imports
mypy /path/to/new.py/file                                                  # fix the errors reported by mypy
git diff /path/to/new.py/file                                              # manually check the file for missing typings
pycodestyle ./ --config=./.pycodestylerc                                   # to check for PEP8 violations

NOTE: Manual inspection is very important.

Only once the above procedure is finished for all new files, one should commit the changes.

References to know more:

Static Typing Test

We use mypy to introduce a static typing.

Please check your code for static typing violations using the following commands.

mypy mod_*

Security

Even though many precautions have been taken to ensure that this software is stable and secure, bugs can occur. In case there is a security related issue, please send an email to ccextractor@canihavesome.coffee (GPG key 0xF8643F5B, fingerprint 53FF DE55 6DFC 27C3 C688 1A49 3AFD C9BF F864 3F5B) instead of using the issue tracker. This will help to prevent abuse while the issue is being resolved.

You can’t perform that action at this time.