NCATS-Tangerine/beacon-validator

Name: beacon-validator

Owner: NCATS Data Translator Project - Tangerine Team

Description: Simple application for testing validity of Knowledge Beacons

Created: 2017-06-26 17:49:03.0

Updated: 2017-08-17 18:36:22.0

Pushed: 2017-10-08 05:05:33.0

Homepage: null

Size: 1673

Language: Java

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

beacon-validator

Simple application for testing validity of Knowledge Beacons

Build

This project may be built with Gradle by the following

gradle clean build

This creates an executable Java JAR file under the validator/build/libs subfolder of the project.

Usage:

java -jar validator.jar beacon-url [keyword...]

By default the keyword is “e” (since it is the most common character in the English language). You can change this by setting the keyword parameter. For example:

java -jar validatorjar https://biolink-kb.ncats.io diabetes

Issues

This application tests the syntax of respones, pagination, and semantic filtering for a knowledge beacon. Improper syntax will result in the swagger generated client code not able to parse the response, and an exception will be thrown. Testing pagination and semantic filtering is more failable. What happens is:

Setting up the tests

Assumptions need to be made about the sort of data in the database. Since 'e' is the most common character in the English language, this single character will be used as a keyword in most of the queries. If this is innapropriate for your beacon for whatever reason, you can change the keyword(s) with the applications parameter.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.