1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981
|
From: "Michael R. Crusoe" <crusoe@debian.org>
Date: Thu, 20 Dec 2018 05:19:19 -0800
Subject: Disable --provance until python3-prov issue is resolved
Forwarded: not-needed
---
cwltool/argparser.py | 58 +--
setup.py | 2 +-
tests/test_main_parsed_args.py | 19 -
tests/test_provenance.py | 845 -----------------------------------------
4 files changed, 2 insertions(+), 922 deletions(-)
diff --git a/cwltool/argparser.py b/cwltool/argparser.py
index 3f07cea..38a22f8 100644
--- a/cwltool/argparser.py
+++ b/cwltool/argparser.py
@@ -145,63 +145,7 @@ def arg_parser() -> argparse.ArgumentParser:
default=60,
)
- provgroup = parser.add_argument_group("Recording provenance information of the execution")
- provgroup.add_argument(
- "--provenance",
- help="Save provenance to specified folder as a "
- "Research Object that captures and aggregates "
- "workflow execution and data products.",
- type=str,
- )
-
- provgroup.add_argument(
- "--enable-user-provenance",
- default=False,
- action="store_true",
- help="Record user account info as part of provenance.",
- dest="user_provenance",
- )
- provgroup.add_argument(
- "--disable-user-provenance",
- default=False,
- action="store_false",
- help="Do not record user account info in provenance.",
- dest="user_provenance",
- )
- provgroup.add_argument(
- "--enable-host-provenance",
- default=False,
- action="store_true",
- help="Record host info as part of provenance.",
- dest="host_provenance",
- )
- provgroup.add_argument(
- "--disable-host-provenance",
- default=False,
- action="store_false",
- help="Do not record host info in provenance.",
- dest="host_provenance",
- )
- provgroup.add_argument(
- "--orcid",
- help="Record user ORCID identifier as part of "
- "provenance, e.g. https://orcid.org/0000-0002-1825-0097 "
- "or 0000-0002-1825-0097. Alternatively the environment variable "
- "ORCID may be set.",
- dest="orcid",
- default=os.environ.get("ORCID", ""),
- type=str,
- )
- provgroup.add_argument(
- "--full-name",
- help="Record full name of user as part of provenance, "
- "e.g. Josiah Carberry. You may need to use shell quotes to preserve "
- "spaces. Alternatively the environment variable CWL_FULL_NAME may "
- "be set.",
- dest="cwl_full_name",
- default=os.environ.get("CWL_FULL_NAME", ""),
- type=str,
- )
+ parser.add_argument("--provenance", help=argparse.SUPPRESS)
non_exec_group = parser.add_argument_group(title="Non-execution options")
printgroup = non_exec_group.add_mutually_exclusive_group()
diff --git a/setup.py b/setup.py
index a6817bc..d202b87 100644
--- a/setup.py
+++ b/setup.py
@@ -152,7 +152,7 @@ setup(
"ruamel.yaml >= 0.16, < 0.19",
"rdflib >= 4.2.2, < 7.3.0",
"schema-salad >= 8.9, < 9",
- "prov == 1.5.1",
+ "prov >= 1.5.1",
"mypy-extensions",
"psutil >= 5.6.6",
"coloredlogs",
diff --git a/tests/test_main_parsed_args.py b/tests/test_main_parsed_args.py
index 7a94d92..278d864 100644
--- a/tests/test_main_parsed_args.py
+++ b/tests/test_main_parsed_args.py
@@ -19,22 +19,3 @@ def test_main_parsed_args(tmp_path: Path) -> None:
assert main(args=parsed_args, stdout=stdout, stderr=stderr) == 0
except SystemExit as err:
assert err.code == 0
-
-
-def test_main_parsed_args_provenance(tmp_path: Path) -> None:
- """Affirm that main can be called with parsed args only, requesting provenance."""
- stdout = io.StringIO()
- stderr = io.StringIO()
-
- prov_folder = tmp_path / "provenance" # will be created if necessary
-
- unparsed_args = ["--provenance", str(prov_folder), get_data("tests/echo.cwl"), "--inp", "Hello"]
- parsed_args = arg_parser().parse_args(unparsed_args)
-
- try:
- assert main(args=parsed_args, stdout=stdout, stderr=stderr) == 0
- except SystemExit as err:
- assert err.code == 0
-
- manifest_file = prov_folder / "metadata" / "manifest.json"
- assert manifest_file.is_file(), f"Can't find RO-Crate manifest {manifest_file}"
diff --git a/tests/test_provenance.py b/tests/test_provenance.py
index d7a2a69..d11c261 100644
--- a/tests/test_provenance.py
+++ b/tests/test_provenance.py
@@ -8,7 +8,6 @@ from pathlib import Path
from typing import IO, Any, cast
import arcp
-import bagit
import pytest
from rdflib import Graph, Namespace, URIRef
from rdflib.namespace import DC, DCTERMS, RDF
@@ -36,847 +35,3 @@ FOAF = Namespace("http://xmlns.com/foaf/0.1/")
TEST_ORCID = "https://orcid.org/0000-0003-4862-3349"
-
-
-def cwltool(tmp_path: Path, *args: Any, with_orcid: bool = False) -> Path:
- prov_folder = tmp_path / "provenance"
- prov_folder.mkdir()
- new_args = [
- "--enable-user-provenance",
- "--enable-host-provenance",
- "--provenance",
- str(prov_folder),
- ]
- if with_orcid:
- new_args.extend(["--orcid", TEST_ORCID])
- new_args.extend(args)
- # Run within a temporary directory to not pollute git checkout
- tmp_dir = tmp_path / "cwltool-run"
- tmp_dir.mkdir()
- with working_directory(tmp_dir):
- status = main(new_args)
- assert status == 0, f"Failed: cwltool.main({args})"
- return prov_folder
-
-
-@needs_docker
-@pytest.mark.parametrize("with_orcid", [True, False])
-def test_hello_workflow(tmp_path: Path, with_orcid: bool) -> None:
- check_provenance(
- cwltool(
- tmp_path,
- get_data("tests/wf/hello-workflow.cwl"),
- "--usermessage",
- "Hello workflow",
- with_orcid=with_orcid,
- ),
- with_orcid=with_orcid,
- )
-
-
-@needs_docker
-@pytest.mark.parametrize("with_orcid", [True, False])
-def test_hello_single_tool(tmp_path: Path, with_orcid: bool) -> None:
- check_provenance(
- cwltool(
- tmp_path,
- get_data("tests/wf/hello_single_tool.cwl"),
- "--message",
- "Hello tool",
- with_orcid=with_orcid,
- ),
- single_tool=True,
- with_orcid=with_orcid,
- )
-
-
-@needs_docker
-@pytest.mark.parametrize("with_orcid", [True, False])
-def test_revsort_workflow(tmp_path: Path, with_orcid: bool) -> None:
- folder = cwltool(
- tmp_path,
- get_data("tests/wf/revsort.cwl"),
- get_data("tests/wf/revsort-job.json"),
- with_orcid=with_orcid,
- )
- check_output_object(folder)
- check_provenance(folder, with_orcid=with_orcid)
-
-
-@needs_docker
-@pytest.mark.parametrize("with_orcid", [True, False])
-def test_revsort_workflow_shortcut(tmp_path: Path, with_orcid: bool) -> None:
- """Confirm that using 'cwl:tool' shortcut still snapshots the CWL files."""
- folder = cwltool(
- tmp_path,
- get_data("tests/wf/revsort-job-shortcut.json"),
- with_orcid=with_orcid,
- )
- check_output_object(folder)
- check_provenance(folder, with_orcid=with_orcid)
- assert not (folder / "snapshot" / "revsort-job-shortcut.json").exists()
- assert len(list((folder / "snapshot").iterdir())) == 4
-
-
-@needs_docker
-@pytest.mark.parametrize("with_orcid", [True, False])
-def test_nested_workflow(tmp_path: Path, with_orcid: bool) -> None:
- check_provenance(
- cwltool(
- tmp_path,
- get_data("tests/wf/nested.cwl"),
- with_orcid=with_orcid,
- ),
- nested=True,
- with_orcid=with_orcid,
- )
-
-
-@needs_docker
-@pytest.mark.parametrize("with_orcid", [True, False])
-def test_secondary_files_implicit(tmp_path: Path, with_orcid: bool) -> None:
- file1 = tmp_path / "foo1.txt"
- file1idx = tmp_path / "foo1.txt.idx"
-
- with open(str(file1), "w", encoding="ascii") as f:
- f.write("foo")
- with open(str(file1idx), "w", encoding="ascii") as f:
- f.write("bar")
-
- # secondary will be picked up by .idx
- folder = cwltool(
- tmp_path,
- get_data("tests/wf/sec-wf.cwl"),
- "--file1",
- str(file1),
- with_orcid=with_orcid,
- )
- check_provenance(folder, secondary_files=True, with_orcid=with_orcid)
- check_secondary_files(folder)
-
-
-@needs_docker
-@pytest.mark.parametrize("with_orcid", [True, False])
-def test_secondary_files_explicit(tmp_path: Path, with_orcid: bool) -> None:
- # Deliberately do NOT have common basename or extension
- file1dir = tmp_path / "foo"
- file1dir.mkdir()
- file1 = file1dir / "foo"
- file1idxdir = tmp_path / "bar"
- file1idxdir.mkdir()
- file1idx = file1idxdir / "bar"
-
- with open(file1, "w", encoding="ascii") as f:
- f.write("foo")
- with open(file1idx, "w", encoding="ascii") as f:
- f.write("bar")
-
- # explicit secondaryFiles
- job = {
- "file1": {
- "class": "File",
- "path": str(file1),
- "basename": "foo1.txt",
- "secondaryFiles": [
- {
- "class": "File",
- "path": str(file1idx),
- "basename": "foo1.txt.idx",
- }
- ],
- }
- }
-
- jobJson = tmp_path / "job.json"
- with open(jobJson, "wb") as fp:
- j = json.dumps(job, ensure_ascii=True)
- fp.write(j.encode("ascii"))
-
- folder = cwltool(
- tmp_path,
- get_data("tests/wf/sec-wf.cwl"),
- str(jobJson),
- with_orcid=with_orcid,
- )
- check_provenance(folder, secondary_files=True, with_orcid=with_orcid)
- check_secondary_files(folder)
-
-
-@needs_docker
-@pytest.mark.parametrize("with_orcid", [True, False])
-def test_secondary_files_output(tmp_path: Path, with_orcid: bool) -> None:
- # secondary will be picked up by .idx
- folder = cwltool(
- tmp_path,
- get_data("tests/wf/sec-wf-out.cwl"),
- with_orcid=with_orcid,
- )
- check_provenance(folder, secondary_files=True, with_orcid=with_orcid)
- # Skipped, not the same secondary files as above
- # self.check_secondary_files()
-
-
-@needs_docker
-@pytest.mark.parametrize("with_orcid", [True, False])
-def test_directory_workflow(tmp_path: Path, with_orcid: bool) -> None:
- dir2 = tmp_path / "dir2"
- dir2.mkdir()
- sha1 = {
- # Expected hashes of ASCII letters (no linefeed)
- # as returned from:
- # for x in a b c ; do echo -n $x | sha1sum ; done
- "a": "86f7e437faa5a7fce15d1ddcb9eaeaea377667b8",
- "b": "e9d71f5ee7c92d6dc9e92ffdad17b8bd49418f98",
- "c": "84a516841ba77a5b4648de2cd0dfcb30ea46dbb4",
- }
- for x in "abc":
- # Make test files with predictable hashes
- with open(dir2 / x, "w", encoding="ascii") as f:
- f.write(x)
-
- folder = cwltool(
- tmp_path,
- get_data("tests/wf/directory.cwl"),
- "--dir",
- str(dir2),
- with_orcid=with_orcid,
- )
- check_provenance(folder, directory=True, with_orcid=with_orcid)
-
- # Output should include ls stdout of filenames a b c on each line
- file_list = (
- folder
- / "data"
- / "3c"
- / "3ca69e8d6c234a469d16ac28a4a658c92267c423"
- # checksum as returned from:
- # echo -e "a\nb\nc" | sha1sum
- # 3ca69e8d6c234a469d16ac28a4a658c92267c423 -
- )
- assert file_list.is_file()
-
- # Input files should be captured by hash value,
- # even if they were inside a class: Directory
- for letter, l_hash in sha1.items():
- prefix = l_hash[:2] # first 2 letters
- p = folder / "data" / prefix / l_hash
- assert p.is_file(), f"Could not find {letter} as {p}"
-
-
-@needs_docker
-@pytest.mark.parametrize("with_orcid", [True, False])
-def test_no_data_files(tmp_path: Path, with_orcid: bool) -> None:
- folder = cwltool(
- tmp_path,
- get_data("tests/wf/conditional_step_no_inputs.cwl"),
- with_orcid=with_orcid,
- )
- check_bagit(folder)
-
-
-def check_output_object(base_path: Path) -> None:
- output_obj = base_path / "workflow" / "primary-output.json"
- compare_checksum = "sha1$b9214658cc453331b62c2282b772a5c063dbd284"
- compare_location = "../data/b9/b9214658cc453331b62c2282b772a5c063dbd284"
- with open(output_obj) as fp:
- out_json = json.load(fp)
- f1 = out_json["sorted_output"]
- assert f1["checksum"] == compare_checksum
- assert f1["location"] == compare_location
-
-
-def check_secondary_files(base_path: Path) -> None:
- foo_data = (
- base_path
- / "data"
- / "0b"
- / "0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33"
- # checksum as returned from:
- # $ echo -n foo | sha1sum
- # 0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33 -
- )
- bar_data = base_path / "data" / "62" / "62cdb7020ff920e5aa642c3d4066950dd1f01f4d"
- assert foo_data.is_file(), "Did not capture file.txt 'foo'"
- assert bar_data.is_file(), "Did not capture secondary file.txt.idx 'bar"
-
- primary_job = base_path / "workflow" / "primary-job.json"
- with open(primary_job) as fp:
- job_json = json.load(fp)
- # TODO: Verify secondaryFile in primary-job.json
- f1 = job_json["file1"]
- assert f1["location"] == "../data/0b/0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33"
- assert f1["basename"] == "foo1.txt"
-
- secondaries = f1["secondaryFiles"]
- assert secondaries
- f1idx = secondaries[0]
- assert f1idx["location"] == "../data/62/62cdb7020ff920e5aa642c3d4066950dd1f01f4d"
- assert f1idx["basename"], "foo1.txt.idx"
-
-
-def check_provenance(
- base_path: Path,
- nested: bool = False,
- single_tool: bool = False,
- directory: bool = False,
- secondary_files: bool = False,
- with_orcid: bool = False,
-) -> None:
- check_folders(base_path)
- check_bagit(base_path)
- check_ro(base_path, nested=nested)
- check_prov(
- base_path,
- nested=nested,
- single_tool=single_tool,
- directory=directory,
- secondary_files=secondary_files,
- with_orcid=with_orcid,
- )
-
-
-def check_folders(base_path: Path) -> None:
- required_folders = [
- "data",
- "snapshot",
- "workflow",
- "metadata",
- os.path.join("metadata", "provenance"),
- ]
-
- for folder in required_folders:
- assert (base_path / folder).is_dir()
-
-
-def check_bagit(base_path: Path) -> None:
- # check bagit structure
- required_files = [
- "bagit.txt",
- "bag-info.txt",
- "manifest-sha1.txt",
- "tagmanifest-sha1.txt",
- "tagmanifest-sha256.txt",
- ]
-
- for basename in required_files:
- assert (base_path / basename).is_file()
-
- bag = bagit.Bag(str(base_path))
- assert bag.has_oxum()
- (only_manifest, only_fs) = bag.compare_manifests_with_fs()
- assert not list(only_manifest), "Some files only in manifest"
- assert not list(only_fs), "Some files only on file system"
- missing_tagfiles = bag.missing_optional_tagfiles()
- assert not list(missing_tagfiles), "Some files only in tagmanifest"
- bag.validate()
- # TODO: Check other bag-info attributes
- assert arcp.is_arcp_uri(cast(str, bag.info.get("External-Identifier")))
-
-
-def find_arcp(base_path: Path) -> str:
- # First try to find External-Identifier
- bag = bagit.Bag(str(base_path))
- ext_id = cast(str, bag.info.get("External-Identifier"))
- if arcp.is_arcp_uri(ext_id):
- return ext_id
- raise Exception("Can't find External-Identifier")
-
-
-def _arcp2file(base_path: Path, uri: str) -> Path:
- parsed = arcp.parse_arcp(uri)
- # arcp URIs, ensure they are local to our RO
- assert (
- parsed.uuid == arcp.parse_arcp(find_arcp(base_path)).uuid
- ), "arcp URI must be local to the research object"
-
- path = parsed.path[1:] # Strip first /
- return base_path / Path(path)
-
-
-def check_ro(base_path: Path, nested: bool = False) -> None:
- manifest_file = base_path / "metadata" / "manifest.json"
- assert manifest_file.is_file(), f"Can't find {manifest_file}"
- arcp_root = find_arcp(base_path)
- base = urllib.parse.urljoin(arcp_root, "metadata/manifest.json")
- g = Graph()
-
- # Avoid resolving JSON-LD context https://w3id.org/bundle/context
- # so this test works offline
- context = Path(get_data("tests/bundle-context.jsonld")).as_uri()
- with open(manifest_file, encoding="UTF-8") as fh:
- jsonld = fh.read()
- # replace with file:/// URI
- jsonld = jsonld.replace("https://w3id.org/bundle/context", context)
- g.parse(data=jsonld, format="json-ld", publicID=base)
- if os.environ.get("DEBUG"):
- print("Parsed manifest:\n\n")
- g.serialize(cast(IO[bytes], sys.stdout), format="ttl")
- _ro = None
-
- for _ro in g.subjects(ORE.isDescribedBy, URIRef(base)):
- break
- assert _ro is not None, "Can't find RO with ore:isDescribedBy"
-
- profile = None
- for dc in g.objects(_ro, DCTERMS.conformsTo):
- profile = dc
- break
- assert profile is not None, "Can't find profile with dct:conformsTo"
- assert profile == URIRef(
- provenance_constants.CWLPROV_VERSION
- ), f"Unexpected cwlprov version {profile}"
-
- paths = []
- externals = []
- for aggregate in g.objects(_ro, ORE.aggregates):
- if not arcp.is_arcp_uri(cast(str, aggregate)):
- externals.append(aggregate)
- # Won't check external URIs existence here
- # TODO: Check they are not relative!
- continue
- lfile = _arcp2file(base_path, cast(str, aggregate))
- paths.append(os.path.relpath(lfile, base_path))
- assert os.path.isfile(lfile), f"Can't find aggregated {lfile}"
-
- assert paths, "Didn't find any arcp aggregates"
- assert externals, "Didn't find any data URIs"
-
- for ext in ["provn", "xml", "json", "jsonld", "nt", "ttl"]:
- f = "metadata/provenance/primary.cwlprov.%s" % ext
- assert f in paths, "provenance file missing " + f
-
- for f in [
- "workflow/primary-job.json",
- "workflow/packed.cwl",
- "workflow/primary-output.json",
- ]:
- assert f in paths, "workflow file missing " + f
- # Can't test snapshot/ files directly as their name varies
-
- # TODO: check urn:hash::sha1 thingies
- # TODO: Check OA annotations
-
- packed = urllib.parse.urljoin(arcp_root, "/workflow/packed.cwl")
- primary_job = urllib.parse.urljoin(arcp_root, "/workflow/primary-job.json")
- primary_prov_nt = urllib.parse.urljoin(arcp_root, "/metadata/provenance/primary.cwlprov.nt")
- uuid = arcp.parse_arcp(arcp_root).uuid
-
- highlights = set(g.subjects(OA.motivatedBy, OA.highlighting))
- assert highlights, "Didn't find highlights"
- for h in highlights:
- assert (h, OA.hasTarget, URIRef(packed)) in g
-
- describes = set(g.subjects(OA.motivatedBy, OA.describing))
- for d in describes:
- assert (d, OA.hasBody, URIRef(arcp_root)) in g
- assert (d, OA.hasTarget, URIRef(uuid.urn)) in g
-
- linked = set(g.subjects(OA.motivatedBy, OA.linking))
- for link in linked:
- assert (link, OA.hasBody, URIRef(packed)) in g
- assert (link, OA.hasBody, URIRef(primary_job)) in g
- assert (link, OA.hasTarget, URIRef(uuid.urn)) in g
-
- has_provenance = set(g.subjects(OA.hasBody, URIRef(primary_prov_nt)))
- for p in has_provenance:
- assert (p, OA.hasTarget, URIRef(uuid.urn)) in g
- assert (p, OA.motivatedBy, PROV.has_provenance) in g
- # Check all prov elements are listed
- formats = set()
- for prov in g.objects(p, OA.hasBody):
- assert (
- prov,
- DCTERMS.conformsTo,
- URIRef(provenance_constants.CWLPROV_VERSION),
- ) in g
- # NOTE: DC.format is a Namespace method and does not resolve like other terms
- formats.update(set(g.objects(prov, DC["format"])))
- assert formats, "Could not find media types"
- expected = {
- Literal(f)
- for f in (
- "application/json",
- "application/ld+json",
- "application/n-triples",
- 'text/provenance-notation; charset="UTF-8"',
- 'text/turtle; charset="UTF-8"',
- "application/xml",
- )
- }
- assert formats == expected, "Did not match expected PROV media types"
-
- if nested:
- # Check for additional PROVs
- # Let's try to find the other wf run ID
- otherRuns = set()
- for p in g.subjects(OA.motivatedBy, PROV.has_provenance):
- if (p, OA.hasTarget, URIRef(uuid.urn)) in g:
- continue
- otherRuns.update(set(g.objects(p, OA.hasTarget)))
- assert otherRuns, "Could not find nested workflow run prov annotations"
-
-
-def check_prov(
- base_path: Path,
- nested: bool = False,
- single_tool: bool = False,
- directory: bool = False,
- secondary_files: bool = False,
- with_orcid: bool = False,
-) -> None:
- prov_file = base_path / "metadata" / "provenance" / "primary.cwlprov.nt"
- assert prov_file.is_file(), f"Can't find {prov_file}"
- arcp_root = find_arcp(base_path)
- # Note: We don't need to include metadata/provnance in base URI
- # as .nt always use absolute URIs
- g = Graph()
- with open(prov_file, "rb") as f:
- g.parse(file=f, format="nt", publicID=arcp_root)
- if os.environ.get("DEBUG"):
- print("Parsed %s:\n\n" % prov_file)
- g.serialize(cast(IO[bytes], sys.stdout), format="ttl")
- runs = set(g.subjects(RDF.type, WFPROV.WorkflowRun))
-
- # main workflow run URI (as urn:uuid:) should correspond to arcp uuid part
- uuid = arcp.parse_arcp(arcp_root).uuid
- main_run = URIRef(uuid.urn)
- assert main_run in runs, f"Can't find run {main_run} in {runs}"
- # TODO: we should not need to parse arcp, but follow
- # the has_provenance annotations in manifest.json instead
-
- # run should have been started by a wf engine
- engines = set(g.subjects(RDF.type, WFPROV.WorkflowEngine))
- assert engines, "Could not find WorkflowEngine"
- assert len(engines) == 1, "Found too many WorkflowEngines: %s" % engines
- engine = engines.pop()
-
- assert (
- main_run,
- PROV.wasAssociatedWith,
- engine,
- ) in g, "Wf run not associated with wf engine"
- assert (
- engine,
- RDF.type,
- PROV.SoftwareAgent,
- ) in g, "Engine not declared as SoftwareAgent"
-
- # run should be associated to the user
- accounts = set(g.subjects(RDF.type, FOAF.OnlineAccount))
- assert len(accounts) == 1
- account = accounts.pop()
- people = set(g.subjects(RDF.type, SCHEMA.Person))
- assert len(people) == 1, "Can't find associated person in workflow run"
- person = people.pop()
- if with_orcid:
- assert person == URIRef(TEST_ORCID)
- else:
- account_names = set(g.objects(account, FOAF.accountName))
- assert len(account_names) == 1
- account_name = cast(Literal, account_names.pop())
- machine_user = provenance._whoami()[0]
- assert account_name.value == machine_user
-
- # find the random UUID assigned to cwltool
- tool_agents = set(g.subjects(RDF.type, PROV.SoftwareAgent))
- n_all_agents = 2 + len(tool_agents)
- agents = set(g.subjects(RDF.type, PROV.Agent))
- assert (
- len(agents) == n_all_agents
- ), "There should be 1 agent per tool (engine), 1 user agent, and 1 cwltool agent"
- agents.remove(person)
- agents.remove(engine) # the main tool
- remain_agents = agents - tool_agents
- assert len(remain_agents) == 1
- assert (
- account,
- PROV.actedOnBehalfOf,
- person,
- ) in g, "Association of cwltool agent acting for user is missing"
-
- if single_tool:
- activities = set(g.subjects(RDF.type, PROV.Activity))
- assert len(activities) == 1, "Too many activities: %s" % activities
- # single tool exec, there should be no other activities
- # than the tool run
- # (NOTE: the WorkflowEngine is also activity, but not declared explicitly)
- else:
- # Check all process runs were started by the main worklow
- stepActivities = set(g.subjects(RDF.type, WFPROV.ProcessRun))
- # Although semantically a WorkflowEngine is also a ProcessRun,
- # we don't declare that,
- # thus only the step activities should be in this set.
- assert main_run not in stepActivities
- assert stepActivities, "No steps executed in workflow"
- for step in stepActivities:
- # Let's check it was started by the main_run. Unfortunately, unlike PROV-N
- # in PROV-O RDF we have to check through the n-ary qualifiedStart relation
- starts = set(g.objects(step, PROV.qualifiedStart))
- assert starts, "Could not find qualifiedStart of step %s" % step
- assert len(starts) == 1, "Too many qualifiedStart for step %s" % step
- start = starts.pop()
- assert (
- start,
- PROV.hadActivity,
- main_run,
- ) in g, "Step activity not started by main activity"
- # Tip: Any nested workflow step executions should not be in this prov file,
- # but in separate file
- if nested:
- # Find some cwlprov.nt the nested workflow is described in
- prov_ids = set(g.objects(predicate=PROV.has_provenance))
- # FIXME: The above is a bit naive and does not check the subject is
- # one of the steps -- OK for now as this is the only case of prov:has_provenance
- assert prov_ids, "Could not find prov:has_provenance from nested workflow"
-
- nt_uris = [uri for uri in prov_ids if uri.endswith("cwlprov.nt")]
- # TODO: Look up manifest conformsTo and content-type rather than assuming magic filename
- assert nt_uris, "Could not find *.cwlprov.nt"
- # Load into new graph
- g2 = Graph()
- nt_uri = nt_uris.pop()
- with open(_arcp2file(base_path, nt_uri), "rb") as f:
- g2.parse(file=f, format="nt", publicID=nt_uri)
- # TODO: Check g2 statements that it's the same UUID activity inside
- # as in the outer step
- if directory:
- directories = set(g.subjects(RDF.type, RO.Folder))
- assert directories
-
- for d in directories:
- assert (d, RDF.type, PROV.Dictionary) in g
- assert (d, RDF.type, PROV.Collection) in g
- assert (d, RDF.type, PROV.Entity) in g
- assert len(list(g.objects(d, CWLPROV.basename))) == 1
-
- files = set()
- for entry in g.objects(d, PROV.hadDictionaryMember):
- assert (entry, RDF.type, PROV.KeyEntityPair) in g
- # We don't check what that filename is here
- assert set(g.objects(entry, PROV.pairKey))
-
- # RO:Folder aspect
- assert set(g.objects(entry, RO.entryName))
- assert (d, ORE.aggregates, entry) in g
- assert (entry, RDF.type, RO.FolderEntry) in g
- assert (entry, RDF.type, ORE.Proxy) in g
- assert (entry, ORE.proxyIn, d) in g
- assert (entry, ORE.proxyIn, d) in g
-
- # Which file?
- entities = set(g.objects(entry, PROV.pairEntity))
- assert entities
- ef = entities.pop()
- files.add(ef)
- assert (entry, ORE.proxyFor, ef) in g
- assert (ef, RDF.type, PROV.Entity) in g
-
- if not files:
- assert (d, RDF.type, PROV.EmptyCollection) in g
- assert (d, RDF.type, PROV.EmptyDictionary) in g
- if secondary_files:
- derivations = set(g.subjects(RDF.type, CWLPROV.SecondaryFile))
- assert derivations
- for der in derivations:
- sec = set(g.subjects(PROV.qualifiedDerivation, der)).pop()
- prim = set(g.objects(der, PROV.entity)).pop()
-
- # UUID specializes a hash checksum
- assert set(g.objects(sec, PROV.specializationOf))
- # extensions etc.
- sec_basename = set(g.objects(sec, CWLPROV.basename)).pop()
- sec_nameroot = set(g.objects(sec, CWLPROV.nameroot)).pop()
- sec_nameext = set(g.objects(sec, CWLPROV.nameext)).pop()
- assert str(sec_basename) == f"{sec_nameroot}{sec_nameext}"
- # TODO: Check hash data file exist in RO
-
- # The primary entity should have the same, but different values
- assert set(g.objects(prim, PROV.specializationOf))
- prim_basename = set(g.objects(prim, CWLPROV.basename)).pop()
- prim_nameroot = set(g.objects(prim, CWLPROV.nameroot)).pop()
- prim_nameext = set(g.objects(prim, CWLPROV.nameext)).pop()
- assert str(prim_basename) == f"{prim_nameroot}{prim_nameext}"
-
-
-@pytest.fixture
-def research_object(tmp_path: Path) -> Generator[ResearchObject, None, None]:
- re_ob = ResearchObject(StdFsAccess(str(tmp_path / "ro")), temp_prefix_ro=str(tmp_path / "tmp"))
- yield re_ob
- close_ro(re_ob)
-
-
-def test_absolute_path_fails(research_object: ResearchObject) -> None:
- with pytest.raises(ValueError):
- write_bag_file(research_object, "/absolute/path/fails")
-
-
-def test_climboutfails(research_object: ResearchObject) -> None:
- with pytest.raises(ValueError):
- write_bag_file(research_object, "../../outside-ro")
-
-
-def test_writable_string(research_object: ResearchObject) -> None:
- with write_bag_file(research_object, "file.txt") as fh:
- assert fh.writable()
- fh.write("Hello\n")
-
- sha1 = os.path.join(research_object.folder, "tagmanifest-sha1.txt")
- assert os.path.isfile(sha1)
-
- with open(sha1, encoding="UTF-8") as sha_file:
- stripped_sha = sha_file.readline().strip()
- assert stripped_sha.endswith("file.txt")
- # stain@biggie:~/src/cwltool$ echo Hello | sha1sum
- # 1d229271928d3f9e2bb0375bd6ce5db6c6d348d9 -
- assert stripped_sha.startswith("1d229271928d3f9e2bb0375bd6ce5db6c6d348d9")
-
- sha256 = os.path.join(research_object.folder, "tagmanifest-sha256.txt")
- assert os.path.isfile(sha256)
-
- with open(sha256, encoding="UTF-8") as sha_file:
- stripped_sha = sha_file.readline().strip()
-
- assert stripped_sha.endswith("file.txt")
- # stain@biggie:~/src/cwltool$ echo Hello | sha256sum
- # 66a045b452102c59d840ec097d59d9467e13a3f34f6494e539ffd32c1bb35f18 -
- assert stripped_sha.startswith(
- "66a045b452102c59d840ec097d59d9467e13a3f34f6494e539ffd32c1bb35f18"
- )
-
- sha512 = os.path.join(research_object.folder, "tagmanifest-sha512.txt")
- assert os.path.isfile(sha512)
-
-
-def test_writable_unicode_string(research_object: ResearchObject) -> None:
- with write_bag_file(research_object, "file.txt") as fh:
- assert fh.writable()
- fh.write("Here is a snowman: \u2603 \n")
-
-
-def test_writable_bytes(research_object: ResearchObject) -> None:
- string = "Here is a snowman: \u2603 \n".encode()
- with write_bag_file(research_object, "file.txt", encoding=None) as fh:
- fh.write(string) # type: ignore
-
-
-def test_data(research_object: ResearchObject) -> None:
- with write_bag_file(research_object, "data/file.txt") as fh:
- assert fh.writable()
- fh.write("Hello\n")
-
- # Because this is under data/ it should add to manifest
- # rather than tagmanifest
- sha1 = os.path.join(research_object.folder, "manifest-sha1.txt")
- assert os.path.isfile(sha1)
- with open(sha1, encoding="UTF-8") as fh2:
- stripped_sha = fh2.readline().strip()
- assert stripped_sha.endswith("data/file.txt")
-
-
-def test_not_seekable(research_object: ResearchObject) -> None:
- with write_bag_file(research_object, "file.txt") as fh:
- assert not fh.seekable()
- with pytest.raises(OSError):
- fh.seek(0)
-
-
-def test_not_readable(research_object: ResearchObject) -> None:
- with write_bag_file(research_object, "file.txt") as fh:
- assert not fh.readable()
- with pytest.raises(OSError):
- fh.read()
-
-
-def test_truncate_fails(research_object: ResearchObject) -> None:
- with write_bag_file(research_object, "file.txt") as fh:
- fh.write("Hello there")
- fh.truncate() # OK as we're always at end
- # Will fail because the checksum can't rewind
- with pytest.raises(OSError):
- fh.truncate(0)
-
-
-mod_validness = [
- # Taken from "Some sample ORCID iDs" on
- # https://support.orcid.org/knowledgebase/articles/116780-structure-of-the-orcid-identifier
- ("0000-0002-1825-0097", True),
- ("0000-0001-5109-3700", True),
- ("0000-0002-1694-233X", True),
- # dashes optional
- ("0000000218250097", True),
- ("0000000151093700", True),
- ("000000021694233X", True),
- # do not fail on missing digits
- ("0002-1694-233X", True),
- # Swap check-digits around to force error
- ("0000-0002-1825-009X", False),
- ("0000-0001-5109-3707", False),
- ("0000-0002-1694-2330", False),
-]
-
-
-@pytest.mark.parametrize("mod11,valid", mod_validness)
-def test_check_mod_11_2(mod11: str, valid: bool) -> None:
- assert provenance._check_mod_11_2(mod11) == valid
-
-
-orcid_uris = [
- # https://orcid.org/ (Expected form)
- ("https://orcid.org/0000-0002-1694-233X", "https://orcid.org/0000-0002-1694-233X"),
- # orcid.org
- ("http://orcid.org/0000-0002-1694-233X", "https://orcid.org/0000-0002-1694-233X"),
- # just the number
- ("0000-0002-1825-0097", "https://orcid.org/0000-0002-1825-0097"),
- # lower-case X is OK (and fixed)
- ("https://orcid.org/0000-0002-1694-233x", "https://orcid.org/0000-0002-1694-233X"),
- # upper-case ORCID.ORG is OK.. (and fixed)
- ("https://ORCID.ORG/0000-0002-1694-233X", "https://orcid.org/0000-0002-1694-233X"),
-]
-
-
-@pytest.mark.parametrize("orcid,expected", orcid_uris)
-def test_valid_orcid(orcid: str, expected: str) -> None:
- assert provenance._valid_orcid(orcid) == expected
-
-
-invalid_orcids = [
- # missing digit fails (even if checksum is correct)
- "0002-1694-2332",
- # Wrong checkdigit fails
- "https://orcid.org/0000-0002-1694-2332",
- "0000-0002-1694-2332",
- # Missing dashes fails (although that's OK for checksum)
- "https://orcid.org/000000021694233X",
- "000000021694233X",
- # Wrong hostname fails
- "https://example.org/0000-0002-1694-233X",
- # Wrong protocol fails
- "ftp://orcid.org/0000-0002-1694-233X",
- # Trying to be clever fails (no URL parsing!)
- "https://orcid.org:443/0000-0002-1694-233X",
- "http://orcid.org:80/0000-0002-1694-233X",
- # Empty string is not really valid
- "",
-]
-
-
-@pytest.mark.parametrize("orcid", invalid_orcids)
-def test_invalid_orcid(orcid: str) -> None:
- with pytest.raises(ValueError):
- provenance._valid_orcid(orcid)
-
-
-def test_whoami() -> None:
- username, fullname = provenance._whoami()
- assert username and isinstance(username, str)
- assert fullname and isinstance(fullname, str)
-
-
-def test_research_object() -> None:
- # TODO: Test ResearchObject methods
- pass
-
-
-def test_research_object_picklability(research_object: ResearchObject) -> None:
- """Research object may need to be pickled (for Toil)."""
- assert pickle.dumps(research_object) is not None
|