Dev (#23)

undefined

.github/workflows/run_test.yml

@@ -11,9 +11,17 @@ on:
       - 'main'
       - 'dev'
 
-jobs:
-  build:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+'
+
+env:
+  REGISTRY_USER: c3genomics+github_pusher
+  IMAGE_REGISTRY: quay.io
+  REGISTRY_PASSWORD: ${{ secrets.QUAY_ROBOT_TOKEN }}
+  IMAGE: c3genomics/project_tracking
 
+jobs:
+  test:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
@@ -41,3 +49,29 @@ jobs:
       - name: Test with pytest
         run: |
           pytest -v
+  build:
+    needs: test
+    if: startsWith(github.ref, 'refs/tags')
+    name: Build image
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: set tag
+      run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+    - name: Buildah Action
+      uses: redhat-actions/buildah-build@v2
+      with:
+        image: ${{ env.IMAGE_REGISTRY }}/${{ env.IMAGE }}
+        tags: ${{ env.RELEASE_VERSION }} latest_release
+        containerfiles: ./Containerfile
+    - name: Push to repo
+      uses: redhat-actions/push-to-registry@v2
+      with:
+          username: ${{ env.REGISTRY_USER }}
+          password: ${{ env.REGISTRY_PASSWORD }}
+          registry: ${{ env.IMAGE_REGISTRY }}
+          image: ${{ env.IMAGE }}
+          tags: ${{ env.RELEASE_VERSION }} latest_release
+    - name: Print image url
+      run: echo "Image pushed to ${{ steps.push-to-repo.outputs.registry-paths }}"
+

Dockerfile → Containerfile

@@ -1,4 +1,5 @@
-FROM fedora:36
+FROM fedora:39
+MAINTAINER P-O Quirion po.quirion@mcgill.ca 
 ENV APP=project_tracking
 
 RUN mkdir /app /sqlite

project_tracking/api/project.py

@@ -64,7 +64,8 @@ def sanity_check(item, action_output):
 @convcheck_project
 def projects(project_id: str = None):
     """
-    project: uses the form "/project/1" for project ID and "/project/name" for project name
+    GET:
+        project: uses the form "/project/1" for project ID and "/project/name" for project name
     return: list of all the details of the poject with name "project_name" or ID "project_id"
     """
 
@@ -81,8 +82,9 @@ def projects(project_id: str = None):
 @convcheck_project
 def patients(project_id: str, patient_id: str = None):
     """
-    patient_id: uses the form "1,3-8,9"
-    return: list all patient or selected patient that are also par of <project>
+    GET:
+        patient_id: uses the form "1,3-8,9", if not provided all patients are returned
+    return: list all patients or selected patients, belonging to <project>
 
     Query:
     (pair, tumor):  Default (None, true)
@@ -93,7 +95,7 @@ def patients(project_id: str, patient_id: str = None):
             Return: a subset of patient who have Tumor=False & Tumor=True samples
         (false, true):
             return: a subset of patient who only have Tumor=True samples
-        (false, true):
+        (false, false):
             return: a subset of patient who only have Tumor=false samples
     """
 
@@ -144,8 +146,9 @@ def patients(project_id: str, patient_id: str = None):
 @convcheck_project
 def samples(project_id: str, sample_id: str = None):
     """
-    sample_id: uses the form "1,3-8,9", if not provides, all sample are returned
-    return: all or selected sample that are in sample_id and part of project
+    GET:
+        sample_id: uses the form "1,3-8,9", if not provided all samples are returned
+    return: list all patients or selected samples, belonging to <project>
     """
 
     query = request.args
@@ -174,8 +177,9 @@ def samples(project_id: str, sample_id: str = None):
 @convcheck_project
 def readsets(project_id: str, readset_id: str=None):
     """
-    readset_id: uses the form "1,3-8,9", if not provided, all readsets are returned
-    return: selected readsets that are in sample_id and part of project
+    GET:
+        readset_id: uses the form "1,3-8,9", if not provided all readsets are returned
+    return: list all patients or selected readsets, belonging to <project>
     """
 
     query = request.args
@@ -207,12 +211,12 @@ def readsets(project_id: str, readset_id: str=None):
 @convcheck_project
 def files(project_id: str, patient_id: str=None, sample_id: str=None, readset_id: str=None, file_id: str=None):
     """
-    file_id: uses the form "1,3-8,9". Select file by ids
-    patient_id: uses the form "1,3-8,9". Select file by patient ids
-    sample_id: uses the form "1,3-8,9". Select file by sample ids
-    redeaset_id: uses the form "1,3-8,9". Select file by readset ids
-
-    return: selected files
+    GET:
+        file_id: uses the form "1,3-8,9". Select file by ids
+        patient_id: uses the form "1,3-8,9". Select file by patient ids
+        sample_id: uses the form "1,3-8,9". Select file by sample ids
+        redeaset_id: uses the form "1,3-8,9". Select file by readset ids
+    return: selected files, belonging to <project>
 
     Query:
     (deliverable):  Default (None)
@@ -276,19 +280,19 @@ def files(project_id: str, patient_id: str=None, sample_id: str=None, readset_id
 @convcheck_project
 def metrics(project_id: str, patient_id: str=None, sample_id: str=None, readset_id: str=None, metric_id: str=None):
     """
-    metric_id: uses the form "1,3-8,9". Select metric by ids
-    patient_id: uses the form "1,3-8,9". Select metric by patient ids
-    sample_id: uses the form "1,3-8,9". Select metric by sample ids
-    redeaset_id: uses the form "1,3-8,9". Select metric by readset ids
-
-    We also accespt POST data with comma separeted list
+    GET:
+        metric_id: uses the form "1,3-8,9". Select metric by ids
+        patient_id: uses the form "1,3-8,9". Select metric by patient ids
+        sample_id: uses the form "1,3-8,9". Select metric by sample ids
+        redeaset_id: uses the form "1,3-8,9". Select metric by readset ids
+    return: selected metrics, belonging to <project>
+
+    We also accept POST data with comma separeted list
     metric_name = <NAME> [,NAME] [...]
     readset_name = <NAME> [,NAME] [...]
     sample_name = <NAME> [,NAME] [...]
     patient_name = <NAME> [,NAME] [...]
 
-    return: selected metrics
-
     Query:
     (deliverable):  Default (None)
     The deliverable query allows to get all metrics labelled as deliverable
@@ -360,8 +364,9 @@ def metrics(project_id: str, patient_id: str=None, sample_id: str=None, readset_
 @convcheck_project
 def readsets_from_samples(project_id: str, sample_id: str):
     """
-    sample_id: uses the form "1,3-8,9"
-    return: readsets for selected sample_id
+    GET:
+        sample_id: uses the form "1,3-8,9"
+    return: selected readsets belonging to <sample_id>
     """
 
     query = request.args
@@ -382,14 +387,14 @@ def readsets_from_samples(project_id: str, sample_id: str):
 
     action_output = db_action.readsets(project_id, sample_id)
 
-    return sanity_check("Metric", action_output)
+    return sanity_check("Readset", action_output)
 
 
 @bp.route('/<string:project>/digest_readset_file', methods=['POST'])
 @convcheck_project
 def digest_readset_file(project_id: str):
     """
-    POST: list of Readset/Sample Name or id
+    POST: json holding the list of Patient/Sample/Readset Name or id AND location endpoint + experiment nucleic_acid_type
     return: all information to create a "Genpipes readset file"
     """
 
@@ -410,7 +415,7 @@ def digest_readset_file(project_id: str):
 @convcheck_project
 def digest_pair_file(project_id: str):
     """
-    POST: list of Readset/Sample Name or id
+    POST: json holding the list of Patient/Sample/Readset Name or id AND location endpoint + experiment nucleic_acid_type
     return: all information to create a "Genpipes pair file"
     """
 
@@ -427,21 +432,14 @@ def digest_pair_file(project_id: str):
         return db_action.digest_pair_file(project_id=project_id, digest_data=ingest_data)
 
 
-@bp.route('/<string:project>/ingest_run_processing', methods=['GET', 'POST'])
+@bp.route('/<string:project>/ingest_run_processing', methods=['POST'])
 @convcheck_project
 def ingest_run_processing(project_id: str):
     """
     POST: json describing run processing
     return: The Operation object
     """
 
-    # Is this if required?
-    if request.method == 'GET':
-        return abort(
-            405,
-            "Use post method to ingest runs"
-            )
-
     if request.method == 'POST':
         try:
             ingest_data = request.get_json(force=True)
@@ -480,21 +478,14 @@ def ingest_transfer(project_id: str):
 
         return [i.flat_dict for i in db_action.ingest_transfer(project_id=project_id, ingest_data=ingest_data)]
 
-@bp.route('/<string:project>/ingest_genpipes', methods=['GET', 'POST'])
+@bp.route('/<string:project>/ingest_genpipes', methods=['POST'])
 @convcheck_project
 def ingest_genpipes(project_id: str):
     """
-    POST: json describing genpipes
+    POST: json describing genpipes analysis
     return: The Operation object and Jobs associated
     """
 
-    # Is this if required?
-    if request.method == 'GET':
-        return abort(
-            405,
-            "Use post method to ingest genpipes analysis"
-            )
-
     if request.method == 'POST':
         try:
             ingest_data = request.get_json(force=True)
@@ -520,8 +511,8 @@ def ingest_genpipes(project_id: str):
 @convcheck_project
 def digest_unanalyzed(project_id: str):
     """
-    POST: list of Readset/Sample Name or id
-    return: Readsets or Samples unanalyzed
+    POST: json holding the list of Sample/Readset Name or id AND location endpoint + experiment nucleic_acid_type
+    return: Samples/Readsets unanalyzed with location endpoint + experiment nucleic_acid_type
     """
     if request.method == 'POST':
         try: