Giter Site home page Giter Site logo

icgc-argo / song-qc-module Goto Github PK

View Code? Open in Web Editor NEW
0.0 5.0 0.0 39 KB

A QC module for Song that performs icgc-argo specific validations of song submissions

License: GNU Affero General Public License v3.0

Dockerfile 17.52% Python 82.48%
hactoberfest song overture

song-qc-module's Issues

Implement handler and wrapper

https://wiki.oicr.on.ca/display/icgcargotech/ARGO+QC+Module+for+Song

  • The wrapper should take the incoming request, extract http method, headers and body, and just pass the body to the verification function.

  • the verification function takes the body, does whatever validation, and returns a list of strings. Each string describes one issue that was found during validation. If no issues were found, the function returns the empty list.

  • If the verification function doesn't follow its contract (eg. it returns a non-list, or a non-string in the list, or throws an exception, the wrapper should return an error describing the problem.

The verification function should be the only function in the file. When bioinfo updates the QC validation, they should only really be touching 1 file and not concern them self with the house keeping.

Create simple test infrastructure

The goal is to create an easy way for the qc module to be tested with minimal coding.

One way to do this, is create 2 directories:

  • passing
  • failing

the passing directory should contain passing payloads. When these payloads are run against the handler, assert there are no errors

the failing directory should contain payloads that are invalidated by the qc module. When these payloads are run against the handler, assert errors of the expected type are thrown.

tests should be written using pytest

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.