zosmfrestapi 0.2.0__py3-none-any.whl

zosmfrestapi/testing/software.py

@@ -0,0 +1,392 @@
+from zosmfrestapi.models.software import (
+    CsiEntry,
+    Feature,
+    Fmid,
+    NonSmpeManagedDataset,
+    Product,
+    SmpeManagedDataset,
+    SmpeManagedDatasetZoneDddef,
+    SmpeManagedUnixDataset,
+    SoftwareInstance,
+    SoftwareInstanceWorkflow,
+    WorkflowLocation,
+)
+
+from .helpers import pdt
+
+
+def make_swi(
+    system="TSTA",
+    description="Product A",
+    uuid="c66bb092-cf92-4db9-96fd-2073e3b826ae",
+    products=[],
+    workflows=[],
+):
+    return SoftwareInstance(
+        name="HOOLIE",
+        system=system,
+        description=description,
+        globalzone="OSHOOLI.GLOBAL.CSI",
+        targetzones=["TGT"],
+        categories=["FOO"],
+        productinforetrieved=pdt("2026-10-22T16:13:00Z"),
+        lastmodified=pdt("2026-10-02T10:35:38Z"),
+        modifiedby="FOOBAR",
+        created=pdt("2026-10-02T10:35:38Z"),
+        createdby="FOOO",
+        locked=None,
+        lockedby=None,
+        uuid=uuid,
+        workflows=workflows,
+        products=products,
+    )
+
+
+def make_swi_with_product_and_workflow():
+    return make_swi(
+        products=[make_product()],
+        workflows=[
+            make_sw_workflow(),
+            make_sw_workflow(
+                name="Configuration",
+                description="Configure the software in your ServerPac order.",
+                location="OSHOOLI.WORKFLOW(HOOLSETU)",
+            ),
+            make_sw_workflow(
+                name="Verify_1",
+                description="Installation verification for your ServerPac order.",
+                location="OSHOOLI.WORKFLOW(HOOLIVP)",
+            ),
+        ],
+    )
+
+
+def make_new_swi(products=[], workflows=[]):
+    return SoftwareInstance(
+        name="HOOLIE2",
+        system="TSTA",
+        globalzone="OSHOOLI.GLOBAL.CSI",
+        targetzones=["TGT"],
+        products=products,
+        workflows=workflows,
+    )
+
+
+def make_new_swi_with_product():
+    return make_new_swi(products=[make_product()])
+
+
+def make_new_swi_with_workflow():
+    return make_new_swi(workflows=[make_sw_workflow()])
+
+
+def make_product():
+    return Product(
+        prodname="The Box III, Gavin Belson Signature Edition",
+        productid="1122-345",
+        release="01.03.00",
+        vendor="Hooli Software",
+        url="http://hooli.xyz",
+        features=[
+            Feature(
+                feature="The Box III, Middle Out Compression",
+                fmids=[
+                    Fmid(
+                        fmid="HOOMOC3",
+                        description="The Box III, Middle Out Compression",
+                        targetzones=[
+                            "TGT",
+                        ],
+                    ),
+                ],
+            ),
+        ],
+    )
+
+
+def make_sw_workflow(
+    name="About your order",
+    description="Information about your ServerPac order.",
+    location="OSHOOLI.WORKFLOW(HOOLWELC)",
+):
+    return SoftwareInstanceWorkflow(
+        name=name,
+        description=description,
+        location=WorkflowLocation(
+            smptype=None,
+            smpname=None,
+            dsname=location,
+            path=None,
+        ),
+        performonhostsystem=True,
+    )
+
+
+def make_swi_datasets():
+    return {
+        "smpemanageddatasets": [
+            SmpeManagedDataset(
+                dsname="OSHOOLI.AHOOLBIN",
+                volumes=["FOOVOL"],
+                dstype="PDS",
+                recfm="FB",
+                lrecl="80",
+                blksize="27920",
+                tracks="1",
+                used="100",
+                extents="1",
+                dscategory=["DLIB"],
+                zones=["DLIB"],
+                zonedddefs=[SmpeManagedDatasetZoneDddef(zone="DLIB", dddefs=["AHOOLBIN"])],
+                msgs=None,
+            ),
+            SmpeManagedDataset(
+                dsname="OSHOOLI.AHOOLMOD",
+                volumes=["FOOVOL"],
+                dstype="PDS",
+                recfm="U",
+                lrecl="0",
+                blksize="32760",
+                tracks="1",
+                used="100",
+                extents="1",
+                dscategory=["DLIB"],
+                zones=["DLIB"],
+                zonedddefs=[SmpeManagedDatasetZoneDddef(zone="DLIB", dddefs=["AHOOLMOD"])],
+                msgs=None,
+            ),
+            SmpeManagedDataset(
+                dsname="OSHOOLI.GLOBAL.CSI",
+                volumes=["FOOVOL"],
+                dstype="VSAM",
+                recfm=None,
+                lrecl=None,
+                blksize=None,
+                tracks="2",
+                used=None,
+                extents=None,
+                dscategory=["SMP/E", "DLIB", "TARGET", "GLOBAL"],
+                zones=["GLOBAL", "TGT", "DLIB"],
+                zonedddefs=None,
+                msgs=None,
+            ),
+            SmpeManagedDataset(
+                dsname="OSHOOLI.SHOOLMOD",
+                volumes=["FOOVOL"],
+                dstype="PDS",
+                recfm="U",
+                lrecl="0",
+                blksize="32760",
+                tracks="1",
+                used="100",
+                extents="1",
+                dscategory=["TARGET"],
+                zones=["TGT"],
+                zonedddefs=[SmpeManagedDatasetZoneDddef(zone="TGT", dddefs=["SHOOLMOD"])],
+                msgs=None,
+            ),
+            SmpeManagedDataset(
+                dsname="OSHOOLI.SMPLOG",
+                volumes=["FOOVOL"],
+                dstype="SEQ",
+                recfm="VB",
+                lrecl="512",
+                blksize="5120",
+                tracks="1",
+                used="100",
+                extents="1",
+                dscategory=["SMP/E", "DLIB", "TARGET", "GLOBAL"],
+                zones=["DLIB", "GLOBAL", "TGT"],
+                zonedddefs=[
+                    SmpeManagedDatasetZoneDddef(zone="DLIB", dddefs=["SMPLOG"]),
+                    SmpeManagedDatasetZoneDddef(zone="GLOBAL", dddefs=["SMPLOG"]),
+                    SmpeManagedDatasetZoneDddef(zone="TGT", dddefs=["SMPLOG"]),
+                ],
+                msgs=None,
+            ),
+            SmpeManagedDataset(
+                dsname="OSHOOLI.SMPPTS",
+                volumes=["FOOVOL"],
+                dstype="PDS",
+                recfm="FB",
+                lrecl="80",
+                blksize="27920",
+                tracks="1",
+                used="100",
+                extents="1",
+                dscategory=["SMP/E", "DLIB", "TARGET", "GLOBAL"],
+                zones=["DLIB", "GLOBAL", "TGT"],
+                zonedddefs=[
+                    SmpeManagedDatasetZoneDddef(zone="DLIB", dddefs=["SMPPTS"]),
+                    SmpeManagedDatasetZoneDddef(zone="GLOBAL", dddefs=["SMPPTS"]),
+                    SmpeManagedDatasetZoneDddef(zone="TGT", dddefs=["SMPPTS"]),
+                ],
+                msgs=None,
+            ),
+            SmpeManagedDataset(
+                dsname="OSHOOLI.SMPSCDS",
+                volumes=["FOOVOL"],
+                dstype="PDS",
+                recfm="FB",
+                lrecl="80",
+                blksize="27920",
+                tracks="1",
+                used="100",
+                extents="1",
+                dscategory=["SMP/E", "TARGET"],
+                zones=["TGT"],
+                zonedddefs=[SmpeManagedDatasetZoneDddef(zone="TGT", dddefs=["SMPSCDS"])],
+                msgs=None,
+            ),
+        ],
+        "smpemanagedunixdatasets": [
+            SmpeManagedUnixDataset(
+                dsname="OSHOOLI.ZFS",
+                unixdirs=["/u/FOO/hooli/usr/lpp/hooli/"],
+                volumes=["FOOVOL"],
+                dstype="ZFS",
+                recfm=None,
+                lrecl=None,
+                blksize=None,
+                tracks="15",
+                used=None,
+                extents=None,
+                dscategory=["TARGET"],
+                zones=["TGT"],
+                zonedddefs=[SmpeManagedDatasetZoneDddef(zone="TGT", dddefs=["SHOOLDIR"])],
+                msgs=None,
+            )
+        ],
+        "nonsmpemanageddatasets": [
+            NonSmpeManagedDataset(
+                dsname="OSHOOLI.WORKFLOW",
+                volumes=["FOOVOL"],
+                dstype="PDSE",
+                recfm="VB",
+                lrecl="256",
+                blksize="32760",
+                tracks="1",
+                used="100",
+                extents="1",
+                dscategory=["WORKFLOW"],
+                unixdirs=None,
+                msgs=None,
+            )
+        ],
+    }
+
+
+def make_csi_entry():
+    return CsiEntry(
+        entryname="HL00006",
+        entrytype="SYSMOD",
+        zonename="GLOBAL",
+        subentries=[
+            {
+                "BYPASS": [
+                    "NO",
+                ],
+                "VER": None,
+            },
+            {
+                "DELLMOD": [
+                    "NO",
+                ],
+                "VER": None,
+            },
+            {
+                "ELEMMOV": [
+                    "NO",
+                ],
+                "VER": None,
+            },
+            {
+                "ERROR": [
+                    "NO",
+                ],
+                "VER": None,
+            },
+            {
+                "FMID": [
+                    "HOOMOC3",
+                ],
+                "VER": "1",
+            },
+            {
+                "SREL": [
+                    "Z038",
+                ],
+                "VER": "1",
+            },
+            {
+                "SUPING": [
+                    "HL00001",
+                    "HL00002",
+                    "HL00003",
+                    "HL00004",
+                    "HL00005",
+                ],
+                "VER": "1",
+            },
+            {
+                "HFS": [
+                    "HOOLMOC",
+                ],
+                "VER": None,
+            },
+            {
+                "HOLDDATA": [
+                    "SYSTEM(INT),DOC,HL00006",
+                ],
+                "VER": None,
+            },
+            {
+                "JCLIN": [
+                    "NO",
+                ],
+                "VER": None,
+            },
+            {
+                "PROGRAM": [
+                    "HOOLMOC",
+                ],
+                "VER": None,
+            },
+            {
+                "RECDATE": [
+                    "20304",
+                ],
+                "VER": None,
+            },
+            {
+                "RECTIME": [
+                    "13:44:10",
+                ],
+                "VER": None,
+            },
+            {
+                "REGEN": [
+                    "NO",
+                ],
+                "VER": None,
+            },
+            {
+                "RENLMOD": [
+                    "NO",
+                ],
+                "VER": None,
+            },
+            {
+                "RESTORE": [
+                    "NO",
+                ],
+                "VER": None,
+            },
+            {
+                "SMODTYPE": [
+                    "PTF",
+                ],
+                "VER": None,
+            },
+        ],
+    )

zosmfrestapi/testing/software_updates.py

@@ -0,0 +1,281 @@
+from zosmfrestapi.models.software_updates import (
+    MissingFixcat,
+    MissingUpdate,
+    MissingUpdateResolver,
+    SoftwareUpdate,
+    SoftwareUpdateZone,
+    UpdateErrorResults,
+    UpdateProcess,
+    UpdateResult,
+    UpdateSelection,
+)
+
+from .helpers import pdt
+
+
+def make_completed_sw_update_proc():
+    return UpdateProcess(
+        targetzone="TGT",
+        selection=UpdateSelection(updates=["UO07777", "UO08888"]),
+        notes="",
+        processid=58,
+        started=pdt("2026-10-28T13:12:56Z"),
+        status="COMPLETED",
+        step="COMPLETE",
+        lastmodified=None,
+        completed=pdt("2026-10-28T13:13:47Z"),
+        error_results=None,
+        updates=[
+            UpdateResult(
+                fmid="HOOMOC3",
+                selectStatus="APPLIED",
+                name="UO07777",
+            ),
+            UpdateResult(
+                fmid="HOOMOC3",
+                selectStatus="APPLIED",
+                name="UO08888",
+            ),
+            UpdateResult(
+                fmid="HOOMOC3",
+                selectStatus="APPLIED",
+                name="UO09999",
+            ),
+        ],
+        holds=[],
+    )
+
+
+def make_running_sw_update_proc():
+    return UpdateProcess(
+        targetzone="TGT",
+        selection=UpdateSelection(
+            updates=[
+                "HL00002",
+            ],
+        ),
+        notes="",
+        processid=58,
+        started=pdt("2026-10-29T13:45:49Z"),
+        status="RUNNING",
+        step="VERIFYING_UPDATES",
+        lastmodified=pdt("2026-10-29T13:46:04Z"),
+        completed=None,
+        error_results=None,
+        updates=[],
+        holds=[],
+    )
+
+
+def make_suspended_sw_update_proc():
+    return UpdateProcess(
+        targetzone="TGT",
+        selection=UpdateSelection(updates=["HL00002"]),
+        notes="",
+        processid=58,
+        started=pdt("2026-10-29T13:45:49Z"),
+        status="SUSPENDED",
+        step="PRE_INSTALLATION_SUMMARY",
+        lastmodified=pdt("2026-10-29T13:46:24Z"),
+        completed=None,
+        error_results=None,
+        updates=[UpdateResult(fmid="", selectStatus="SELECTED", name="HL00002")],
+        holds=[],
+    )
+
+
+def make_canceled_sw_update_proc():
+    return UpdateProcess(
+        targetzone="TGT",
+        selection=UpdateSelection(
+            updates=[
+                "UO07777",
+                "UO08888",
+            ],
+        ),
+        notes="",
+        processid=58,
+        started=pdt("2026-09-25T15:44:39Z"),
+        completed=pdt("2026-09-25T15:44:49Z"),
+        status="CANCELED",
+        step="PREPARING_UPDATES",
+        lastmodified=None,
+        holds=[],
+        updates=[],
+        error_results=UpdateErrorResults(
+            smpe_rc=12,
+            message="SMP/E detected missing required SYSMODs. "
+            "Check the Error report for the list of "
+            "missing SYSMODs.<br><br>RECEIVE the missing "
+            "SYSMODs into the global zone and retry the "
+            "step.",
+            detailedMessage="Missing SYSMODs: \n\n",
+        ),
+    )
+
+
+def make_error_sw_update_proc():
+    return UpdateProcess(
+        targetzone="TGT",
+        selection=UpdateSelection(updates=["UO07777", "UO08888"]),
+        notes="",
+        processid=58,
+        started=pdt("2026-10-28T10:08:57Z"),
+        status="ERROR",
+        step="PREPARING_UPDATES",
+        lastmodified=pdt("2026-10-28T10:08:57Z"),
+        completed=None,
+        error_results=UpdateErrorResults(
+            smpe_rc=12,
+            message="No updates to install.",
+            detailedMessage="\n"
+            "PAGE 0001  - NOW SET TO TARGET ZONE "
+            "IPI25T   DATE 10/28/26  TIME "
+            "11:08:58  SMP/E 37.41   SMPOUT   "
+            "OUTPUT\n"
+            "\n"
+            " GIM42401I    THE FOLLOWING "
+            "PARAMETERS WERE SPECIFIED ON THE "
+            "EXEC STATEMENT FOR GIMSMP: "
+            "'PROCESS=END'.",
+        ),
+        updates=[],
+        holds=[],
+    )
+
+
+def make_missing_fixcats_list():
+    return [
+        MissingFixcat(
+            name="DH55555",
+            fixcats=["Hooli.TheBox.New.Parts"],
+            fmid="HOOMOC3",
+            fmiddesc="The Box III, Middle Out Compression",
+            resolvers=[
+                MissingUpdateResolver(
+                    name="UO01111",
+                    received=True,
+                )
+            ],
+            tgtzones=["TGT"],
+        ),
+        MissingFixcat(
+            name="DH66666",
+            fixcats=["Hooli.Thebox.Exploitation"],
+            fmid="HOOMOC3",
+            fmiddesc="The Box III, Middle Out Compression",
+            resolvers=[
+                MissingUpdateResolver(
+                    name="UO02222",
+                    received=True,
+                )
+            ],
+            tgtzones=["TGT"],
+        ),
+    ]
+
+
+def make_missing_updates_list():
+    return [
+        MissingUpdate(
+            name="DH55555",
+            holdclass="HIPER",
+            holdsymptom="IPL",
+            heldsysmod="HOOMOC3",
+            fmid="HOOMOC3",
+            fmiddesc="The Box III, Middle Out Compression",
+            resolvers=None,
+            tgtzones=[
+                "TGT",
+            ],
+        ),
+        MissingUpdate(
+            name="DH66666",
+            holdclass="PE",
+            holdsymptom="",
+            heldsysmod="UO07777",
+            fmid="HOOMOC3",
+            fmiddesc="The Box III, Middle Out Compression",
+            resolvers=[
+                MissingUpdateResolver(
+                    name="UO08888",
+                    received=True,
+                ),
+            ],
+            tgtzones=[
+                "TGT",
+            ],
+        ),
+    ]
+
+
+def make_sw_update():
+    return SoftwareUpdate(
+        name="HL00002",
+        type="PTF",
+        fmid="HOOMOC3",
+        zones=[
+            SoftwareUpdateZone(
+                zone="DLIB",
+                status="Not Found",
+                installed=None,
+            ),
+            SoftwareUpdateZone(
+                zone="GLOBAL",
+                status="Received",
+                installed=pdt("2026-10-29T14:39:18Z"),
+            ),
+            SoftwareUpdateZone(
+                zone="TGT",
+                status="Not Found",
+                installed=None,
+            ),
+        ],
+    )
+
+
+def make_copy_output():
+    return [
+        {"name": "/TSTA/FOOBAR/ALL_HOLDS.txt"},
+        {"name": "/TSTA/FOOBAR/POST_INSTALL_HOLDS.txt"},
+        {
+            "name": "/TSTA/FOOBAR/smpe-output/001_PREPARING_UPDATES/"
+            "2026-10-28T13-12-59.618718068-SMPRPT.txt"
+        },
+        {
+            "name": "/TSTA/FOOBAR/smpe-output/001_PREPARING_UPDATES/"
+            "2026-10-28T13-12-59.618718068-SMPHRPT.txt"
+        },
+        {
+            "name": "/TSTA/FOOBAR/smpe-output/001_PREPARING_UPDATES/"
+            "2026-10-28T13-12-59.618718068-SMPOUT.txt"
+        },
+        {
+            "name": "/TSTA/FOOBAR/smpe-output/003_VERIFYING_UPDATES/"
+            "2026-10-28T13-13-12.693149151-SMPRPT.txt"
+        },
+        {
+            "name": "/TSTA/FOOBAR/smpe-output/003_VERIFYING_UPDATES/"
+            "2026-10-28T13-13-12.693149151-SMPHRPT.txt"
+        },
+        {
+            "name": "/TSTA/FOOBAR/smpe-output/003_VERIFYING_UPDATES/"
+            "2026-10-28T13-13-12.693149151-SMPOUT.txt"
+        },
+        {
+            "name": "/TSTA/FOOBAR/smpe-output/005_INSTALLATION/"
+            "2026-10-28T13-13-46.199025023-SMPRPT.txt"
+        },
+        {
+            "name": "/TSTA/FOOBAR/smpe-output/005_INSTALLATION/"
+            "2026-10-28T13-13-46.199025023-SMPHRPT.txt"
+        },
+        {
+            "name": "/TSTA/FOOBAR/smpe-output/005_INSTALLATION/"
+            "2026-10-28T13-13-46.199025023-SMPOUT.txt"
+        },
+        {
+            "name": "/TSTA/FOOBAR/smpe-output/005_INSTALLATION/"
+            "2026-10-28T13-13-46.199025023-SYSPRINT.txt"
+        },
+    ]

zosmfrestapi/testing/topology.py

@@ -0,0 +1,19 @@
+from zosmfrestapi.models.topology import Group, System
+
+
+def make_group(name, systems=[]):
+    return Group(
+        name=name, description=f"A simple group called {name}", systems=",".join(systems)
+    )
+
+
+def make_system(name="", groups=[]):
+    return System(
+        name=f"TST{name}",
+        nickName=f"TEST{name}",
+        sysplex="TST01",
+        groups=",".join(groups),
+        jesType="JES2",
+        jesMemberName=f"TST{name}",
+        url="https://zosmf.example/zosmf/",
+    )