Merge pull request #3 from antgonza/better-file-listing

minor improvements to the file listing

Author: charles-cowart

.github/workflows/qiita-plugin-ci.yml

@@ -62,8 +62,9 @@ jobs:
 
           # Setting up main qiita conda environment
           conda config --add channels conda-forge
-          conda create -q --yes -n qiita python=3.6 pip libgfortran numpy nginx cython redis
+          conda create -q --yes -n qiita python=3.6 pip==9.0.3 libgfortran numpy nginx cython redis
           conda activate qiita
+          pip install --upgrade pip
           pip install sphinx sphinx-bootstrap-theme nose-timer codecov Click
 
       - name: Qiita install
@@ -76,7 +77,7 @@ jobs:
       - name: Install Qiita plugins
         shell: bash -l {0}
         run: |
-          conda create -q --yes -n qtp-job-output-folder python=3.6
+          conda create -q --yes -n qtp-job-output-folder python=3.6 pip==9.0.3
           conda activate qtp-job-output-folder
 
           export QIITA_SERVER_CERT=`pwd`/qiita-dev/qiita_core/support_files/server.crt

qtp_job_output_folder/summary.py

@@ -6,7 +6,7 @@
 # The full license is in the file LICENSE, distributed with this software.
 # -----------------------------------------------------------------------------
 
-from os.path import exists, isdir, join
+from os.path import exists, isdir, join, dirname
 from glob import glob
 from json import dumps
 
@@ -26,11 +26,15 @@ def _generate_html_summary(jid, folder, out_dir):
     summary = f'<h3><b>{folder}</b> does not exist.</h3>'
 
     if exists(folder) and isdir(folder):
+        # calculating the "trimming" for the fullpaths, +1 is to remove /
+        tname = len(dirname(folder)) + 1
+        tlink = len(dirname(dirname(folder)))
         summary = '<br/>\n'.join([
-            f'<a href="{f}" type="{ft}" target="_blank">{f}</a>'
+            f'<a href=".{f[tlink:]}" type="{ft}" target="_blank">'
+            f'{f[tname:]}</a>'
             for ft, f in _folder_listing(folder)])
 
-    index_fp = join(out_dir, f"summary_{jid}.html")
+    index_fp = join(out_dir, "summary.html")
     with open(index_fp, 'w') as of:
         of.write(summary)
 

qtp_job_output_folder/tests/test_summary.py

@@ -63,32 +63,32 @@ def test_summary(self):
         # cleaning artifact files, to avoid errors
         [self._clean_up_files.extend(f) for f in res['files'].values()]
         html_fp = res['files']['html_summary'][0]
-        af = dirname(html_fp)
         self._clean_up_files.append(html_fp)
         with open(html_fp) as html_f:
             html = html_f.read()
 
-        self.assertEqual(html, EXP_HTML.format(af=af))
+        self.assertCountEqual(
+            html.split('\n'), EXP_HTML.format(aid=aid).split('\n'))
 
 
 EXP_HTML = (
-    '<a href="{af}/test_data/file_2" type="file" target="_blank">{af}/'
+    '<a href="./{aid}/test_data/folder_a" type="folder" target="_blank">'
+    'test_data/folder_a</a><br/>\n'
+    '<a href="./{aid}/test_data/folder_a/folder_b/folder_c" type="folder" '
+    'target="_blank">test_data/folder_a/folder_b/folder_c</a><br/>\n'
+    '<a href="./{aid}/test_data/file_2" type="file" target="_blank">'
     'test_data/file_2</a><br/>\n'
-    '<a href="{af}/test_data/test_data" type="folder" target="_blank">{af}/'
+    '<a href="./{aid}/test_data/file_1" type="file" target="_blank">'
+    'test_data/file_1</a><br/>\n'
+    '<a href="./{aid}/test_data/test_data" type="folder" target="_blank">'
     'test_data/test_data</a><br/>\n'
-    '<a href="{af}/test_data/test_data/folder_a/folder_b" type="folder" '
-    'target="_blank">{af}/test_data/test_data/folder_a/folder_b</a><br/>\n'
-    '<a href="{af}/test_data/test_data/folder_a/folder_b/folder_c/file_c" '
-    'type="file" target="_blank">{af}/test_data/test_data/folder_a/folder_b/'
+    '<a href="./{aid}/test_data/test_data/folder_a/folder_b" type="folder" '
+    'target="_blank">test_data/test_data/folder_a/folder_b</a><br/>\n'
+    '<a href="./{aid}/test_data/test_data/folder_a/folder_b/folder_c/file_c" '
+    'type="file" target="_blank">test_data/test_data/folder_a/folder_b/'
     'folder_c/file_c</a><br/>\n'
-    '<a href="{af}/test_data/test_data/folder_a/file_a" type="file" '
-    'target="_blank">{af}/test_data/test_data/folder_a/file_a</a><br/>\n'
-    '<a href="{af}/test_data/file_1" type="file" target="_blank">{af}/'
-    'test_data/file_1</a><br/>\n'
-    '<a href="{af}/test_data/folder_a" type="folder" target="_blank">{af}/'
-    'test_data/folder_a</a><br/>\n'
-    '<a href="{af}/test_data/folder_a/folder_b/folder_c" type="folder" '
-    'target="_blank">{af}/test_data/folder_a/folder_b/folder_c</a>')
+    '<a href="./{aid}/test_data/test_data/folder_a/file_a" type="file" '
+    'target="_blank">test_data/test_data/folder_a/file_a</a>')
 
 
 if __name__ == '__main__':

qtp_job_output_folder/tests/test_validate.py

@@ -60,7 +60,7 @@ def test_validate(self):
         self.assertTrue(obs_success)
         filepaths = [
             (f'{self.source_dir}', 'directory'),
-            (f'{out_dir}/summary_{job_id}.html', 'html_summary')]
+            (f'{out_dir}/summary.html', 'html_summary')]
         exp = [ArtifactInfo(None, 'job-output-folder', filepaths)]
         self.assertEqual(obs_ainfo, exp)
         self.assertEqual(obs_error, "")