Create a MANIFEST.txt file, listing all the files in the folder.

[sjanssen2]

I might miss something here, but to me the expected output looks wrong. According to

qtp-job-output-folder/qtp_job_output_folder/tests/test_summary.py

Lines 76 to 92 in 13713f8

	'<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="./{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="./{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="./{aid}/test_data/test_data/folder_a/file_a" type="file" '
	'target="_blank">test_data/test_data/folder_a/file_a</a>')

we expect the following structure:

• test_data/file_1
• test_data/file_2
• test_data/folder_a
• test_data/folder_a/folder_b/folder_c
• test_data/test_data
• test_data/test_data/folder_a/folder_b
• test_data/test_data/folder_a/folder_b/folder_c/file_c
• test_data/test_data/folder_a/file_a

However, the source tests/test_data directory is structured like:

• test_data/file_1
• test_data/file_2
• test_data/folder_a
• test_data/folder_a/folder_b/folder_c/file_c
• test_data/folder_a/folder_b
• test_data/folder_a/folder_b/folder_c
• test_data/folder_a/file_a

i.e. only the first three elements match, but for some reason an additional sub-directory test_data is added to the expectancy.

My best guess is, that the additional * in

qtp-job-output-folder/qtp_job_output_folder/summary.py

Line 19 in 13713f8

results.extend(_folder_listing(f'{f}/*'))

is the culprit, which leads to an incomplete listing of sub-directories.

[antgonza]

Ha! This is the oposite of #6, which basically is to not show any subdirectory in the summary. Any suggestions on how to reconcile both?

[sjanssen2]

Hm, I have not yet seen an actual use-case of this plugin. I also lack the information, how the file listing actually connects through qiita centrals BASE_DATA_DIR.
But I feel this issue is more a design decision than a technical problem. If you limit to top level folder:

• a plugin and thus user thereof cannot arbitrarily download files - maybe access limited files as well
• using third level tools like multiQC might require multiple levels and it will incur much effort to change this for the plugin
• to me, the above test seems to NOT reflect the behaviour you intend this plugin to have

Would it make sense to make the plugin generate a manifest (which could allow for sub levels) of files that can be retrieved? Prior to file delivery, qiita central could check if the requested file is in this manifest?

[antgonza]

I like the idea of the manifest - basically listing all the files in the folder - which is different to the index.html that gives access to the things that are clickable/downloadable. FWIW, general information of a run (basically multiQC results) is the main usage of this artifact, because normally the user just wants to view the results online and not download them. This configuration with nginx, allows us to visualize the results directly in the browser.

[antgonza]

What do you think? #8