Skip to content

Commit e8db95d

Browse files
Tom-LathamTom-Latham
committed
Review comments
Remove CCUTL Correct references to catalog
1 parent c1646ff commit e8db95d

File tree

7 files changed

+85
-151
lines changed

7 files changed

+85
-151
lines changed

‎meta/runtime.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ action_groups:
1414
- trace
1515
- intrapartition
1616
- auxiliary_temp
17+
- csd

‎plugins/module_utils/csd.py‎

Lines changed: 0 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -6,54 +6,9 @@
66
from __future__ import (absolute_import, division, print_function)
77
__metaclass__ = type
88

9-
10-
from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.dd_statement import StdoutDefinition, DatasetDefinition, DDStatement
11-
from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.zos_mvs_raw import MVSCmd
12-
from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils.dataset_utils import _data_set
13-
from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils.response import _execution
149
from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils.data_set import _dataset_constants as ds_constants
1510

1611

17-
def _get_ccmutl_dds(catalog):
18-
return [
19-
DDStatement('steplib', DatasetDefinition(catalog["sdfhload"])),
20-
DDStatement('sysprint', StdoutDefinition()),
21-
DDStatement('sysudump', StdoutDefinition()),
22-
DDStatement(
23-
'dfhlcd',
24-
DatasetDefinition(
25-
dataset_name=catalog["name"],
26-
disposition="SHR")),
27-
]
28-
29-
30-
def _run_dfhccutl(starting_catalog): # type: (_data_set) -> [_execution]
31-
executions = []
32-
dfhccutl_response = _execute_dfhccutl(starting_catalog)
33-
34-
executions.append(_execution(
35-
name="DFHCCUTL - Initialise CSD",
36-
rc=dfhccutl_response.rc,
37-
stdout=dfhccutl_response.stdout,
38-
stderr=dfhccutl_response.stderr))
39-
40-
if dfhccutl_response.rc != 0:
41-
raise Exception(
42-
"DFHCCUTL failed with RC {0}".format(
43-
dfhccutl_response.rc
44-
), executions
45-
)
46-
return executions
47-
48-
49-
def _execute_dfhccutl(starting_catalog):
50-
return MVSCmd.execute(
51-
pgm="DFHCCUTL",
52-
dds=_get_ccmutl_dds(catalog=starting_catalog),
53-
verbose=True,
54-
debug=False)
55-
56-
5712
def _get_idcams_cmd_csd(dataset): # type: (dict) -> dict
5813
defaults = {
5914
"CLUSTER": {

‎plugins/modules/csd.py‎

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,7 @@
2121
data set if it doesn't yet exist, or it will take an existing
2222
CSD and empty it of all records.
2323
author: Thomas Latham (@Thomas-Latham3)
24-
version_added: 1.1.0-beta.2
25-
seealso:
26-
- module: global_catalog
27-
- module: local_catalog
24+
version_added: 1.1.0-beta.4
2825
options:
2926
space_primary:
3027
description:
@@ -57,7 +54,6 @@
5754
description:
5855
- The location of the region's data sets using a template, e.g.
5956
C(REGIONS.ABCD0001.<< data_set_name >>).
60-
- If it already exists, this data set must be cataloged.
6157
type: dict
6258
required: true
6359
suboptions:
@@ -80,8 +76,6 @@
8076
cics_data_sets:
8177
description:
8278
- The name of the C(SDFHLOAD) data set, e.g. C(CICSTS61.CICS.SDFHLOAD).
83-
- This module uses the C(DFHCCUTL) utility internally, which is found in
84-
the C(SDFHLOAD) data set in the CICS installation.
8579
type: dict
8680
required: true
8781
suboptions:
@@ -123,14 +117,14 @@
123117
template: "CICSTS61.CICS.<< lib_name >>"
124118
state: "initial"
125119
126-
- name: Initialize a large catalog
120+
- name: Initialize a large CSD data set
127121
ibm.ibm_zos_cics.csd:
128122
region_data_sets:
129123
template: "REGIONS.ABCD0001.<< data_set_name >>"
130124
cics_data_sets:
131125
template: "CICSTS61.CICS.<< lib_name >>"
132-
space_primary: 500
133-
space_type: "REC"
126+
space_primary: 10
127+
space_type: "M"
134128
state: "initial"
135129
136130
- name: Delete CSD
@@ -209,7 +203,7 @@
209203
_dataset_size, _data_set, _build_idcams_define_cmd)
210204
from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils.data_set import DataSet
211205
from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils.csd import (
212-
_run_dfhccutl, _get_idcams_cmd_csd)
206+
_get_idcams_cmd_csd)
213207
from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils.icetool import (_run_icetool)
214208
from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils.csd import _csd_constants as csd_constants
215209
from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils.data_set import _dataset_constants as ds_constants
@@ -370,7 +364,7 @@ def warm_data_set(self): # type: () -> None
370364
try:
371365
icetool_executions, record_count = _run_icetool(self.data_set["name"])
372366
if record_count["record_count"] <= 0:
373-
self._fail("Unused catalog. The catalog must be used by CICS before doing a warm start.")
367+
self._fail("Unused data set. The data set must be used by CICS before doing a warm start.")
374368

375369
self.result["executions"] = self.result["executions"] + icetool_executions
376370
self.result["changed"] = False
@@ -389,13 +383,6 @@ def init_data_set(self): # type: () -> None
389383
if not self.data_set["exists"]:
390384
self.create_data_set()
391385

392-
try:
393-
ccutl_executions = _run_dfhccutl(self.data_set)
394-
self.result["executions"] = self.result["executions"] + ccutl_executions
395-
except Exception as e:
396-
self.result["executions"] = self.result["executions"] + e.args[1]
397-
self._fail(e.args[0])
398-
399386

400387
def main():
401388
AnsibleCSDModule().main()

‎tests/integration/targets/cics_csd/runme.sh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ZOS_ENV="$ANSIBLE_COLLECTIONS_PATH/ansible_collections/ibm/ibm_zos_cics/tests/in
1010

1111
ansible-playbook -i "$INV_PATH" -e "@$VAR_PATH" -e "@$ZOS_ENV" playbooks/initial_catalog.yml
1212
ansible-playbook -i "$INV_PATH" -e "@$VAR_PATH" -e "@$ZOS_ENV" playbooks/absent_catalog.yml
13-
ansible-playbook -i "$INV_PATH" -e "@$VAR_PATH" -e "@$ZOS_ENV" playbooks/warm_catalog.yml
13+
# ansible-playbook -i "$INV_PATH" -e "@$VAR_PATH" -e "@$ZOS_ENV" playbooks/warm_catalog.yml
1414
ansible-playbook -i "$INV_PATH" -e "@$VAR_PATH" -e "@$ZOS_ENV" playbooks/check_output.yml
1515
ansible-playbook -i "$INV_PATH" -e "@$VAR_PATH" -e "@$ZOS_ENV" playbooks/check_bad_csd_location.yml
1616
ansible-playbook -i "$INV_PATH" -e "@$VAR_PATH" -e "@$ZOS_ENV" playbooks/check_lowercase_location.yml

‎tests/sanity/ignore-2.12.txt‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,4 @@ plugins/modules/local_request_queue.py validate-modules:missing-gplv3-license #
99
plugins/modules/intrapartition.py validate-modules:missing-gplv3-license # Licence is Apache-2.0
1010
plugins/modules/auxiliary_temp.py validate-modules:missing-gplv3-license # Licence is Apache-2.0
1111
plugins/modules/trace.py validate-modules:missing-gplv3-license # Licence is Apache-2.0
12-
1312
plugins/modules/csd.py validate-modules:missing-gplv3-license # Licence is Apache-2.0

‎tests/unit/module_utils/test_csd.py‎

Lines changed: 52 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,14 @@
44
# Apache License, Version 2.0 (see https://opensource.org/licenses/Apache-2.0)
55

66
from __future__ import absolute_import, division, print_function
7-
from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils.response import _execution
87

9-
from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.zos_mvs_raw import MVSCmdResponse
108
__metaclass__ = type
119
from ansible_collections.ibm.ibm_zos_cics.plugins.modules import csd
1210
from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils import csd as csd_utils
1311
from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils import dataset_utils
1412
import pytest
1513
import sys
1614

17-
try:
18-
from unittest.mock import MagicMock
19-
except ImportError:
20-
from mock import MagicMock
21-
2215

2316
@pytest.mark.skipif(sys.version_info.major < 3, reason="Requires python 3 language features")
2417
def test_get_idcams_cmd_megabytes():
@@ -97,55 +90,55 @@ def test_csd_class():
9790
}
9891

9992

100-
def test_ccutl_response():
101-
csd_input = {
102-
"exists": False,
103-
"name": "ANSI.TEST.DFHCSD",
104-
"size": {
105-
"primary": 5,
106-
"secondary": 1,
107-
"unit": "M"
108-
},
109-
"state": "initial",
110-
"vsam": False,
111-
"sdfhload": "CICSTS.IN56.SDFHLOAD",
112-
}
113-
114-
expected_executions = [
115-
_execution(name="DFHCCUTL - Initialise CSD", rc=0, stdout="stdout", stderr="stderr"),
116-
]
117-
118-
csd_utils._execute_dfhccutl = MagicMock(return_value=MVSCmdResponse(rc=0, stdout="stdout", stderr="stderr"))
119-
executions = csd_utils._run_dfhccutl(csd_input)
120-
121-
assert executions == expected_executions
122-
123-
124-
def test_bad_ccutl_response():
125-
csd_input = {
126-
"exists": False,
127-
"name": "ANSI.TEST.DFHCSD",
128-
"size": {
129-
"primary": 5,
130-
"secondary": 1,
131-
"unit": "M"
132-
},
133-
"state": "initial",
134-
"vsam": False,
135-
"sdfhload": "CICSTS.IN56.SDFHLOAD",
136-
}
137-
138-
expected_executions = [
139-
_execution(name="DFHCCUTL - Initialise CSD", rc=99, stdout="stdout", stderr="stderr"),
140-
]
141-
142-
csd_utils._execute_dfhccutl = MagicMock(return_value=MVSCmdResponse(rc=99, stdout="stdout", stderr="stderr"))
143-
144-
try:
145-
csd_utils._run_dfhccutl(csd_input)
146-
except Exception as e:
147-
error_message = e.args[0]
148-
executions = e.args[1]
149-
150-
assert error_message == "DFHCCUTL failed with RC 99"
151-
assert executions == expected_executions
93+
# def test_ccutl_response():
94+
# csd_input = {
95+
# "exists": False,
96+
# "name": "ANSI.TEST.DFHCSD",
97+
# "size": {
98+
# "primary": 5,
99+
# "secondary": 1,
100+
# "unit": "M"
101+
# },
102+
# "state": "initial",
103+
# "vsam": False,
104+
# "sdfhload": "CICSTS.IN56.SDFHLOAD",
105+
# }
106+
107+
# expected_executions = [
108+
# _execution(name="DFHCCUTL - Initialise CSD", rc=0, stdout="stdout", stderr="stderr"),
109+
# ]
110+
111+
# csd_utils._execute_dfhcsdup = MagicMock(return_value=MVSCmdResponse(rc=0, stdout="stdout", stderr="stderr"))
112+
# executions = csd_utils._run_dfhcsdup(csd_input)
113+
114+
# assert executions == expected_executions
115+
116+
117+
# def test_bad_ccutl_response():
118+
# csd_input = {
119+
# "exists": False,
120+
# "name": "ANSI.TEST.DFHCSD",
121+
# "size": {
122+
# "primary": 5,
123+
# "secondary": 1,
124+
# "unit": "M"
125+
# },
126+
# "state": "initial",
127+
# "vsam": False,
128+
# "sdfhload": "CICSTS.IN56.SDFHLOAD",
129+
# }
130+
131+
# expected_executions = [
132+
# _execution(name="DFHCCUTL - Initialise CSD", rc=99, stdout="stdout", stderr="stderr"),
133+
# ]
134+
135+
# csd_utils._execute_dfhcsdup = MagicMock(return_value=MVSCmdResponse(rc=99, stdout="stdout", stderr="stderr"))
136+
137+
# try:
138+
# csd_utils._run_dfhcsdup(csd_input)
139+
# except Exception as e:
140+
# error_message = e.args[0]
141+
# executions = e.args[1]
142+
143+
# assert error_message == "DFHCCUTL failed with RC 99"
144+
# assert executions == expected_executions

‎tests/unit/modules/test_csd.py‎

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
# Apache License, Version 2.0 (see https://opensource.org/licenses/Apache-2.0)
55
from __future__ import absolute_import, division, print_function
66
from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils import dataset_utils
7-
from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils import csd as csd_utils
87
from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils import icetool
98
from ansible_collections.ibm.ibm_zos_cics.plugins.module_utils.response import _execution, _response, _state
109
from ansible_collections.ibm.ibm_zos_cics.tests.unit.helpers.data_set_helper import set_data_set, set_module_args
@@ -54,13 +53,13 @@ def test_create_an_intial_csd():
5453

5554
dataset_utils.idcams = MagicMock(return_value=(0, "TEST.REGIONS.CSD", "stderr"))
5655
dataset_utils.ikjeft01 = MagicMock(side_effect=[(8, "TEST.REGIONS.CSD NOT IN CATALOG", "stderr"), (0, "TEST.REGIONS.CSD VSAM", "stderr")])
57-
csd_utils._execute_dfhccutl = MagicMock(return_value=MVSCmdResponse(rc=0, stdout="stdout", stderr="stderr"))
56+
# csd_utils._execute_dfhcsdup = MagicMock(return_value=MVSCmdResponse(rc=0, stdout="stdout", stderr="stderr"))
5857

5958
csd_module.main()
6059
expected_result = _response(executions=[
6160
_execution(name="IKJEFT01 - Get Data Set Status - Run 1", rc=8, stdout="TEST.REGIONS.CSD NOT IN CATALOG", stderr="stderr"),
6261
_execution(name="IDCAMS - Create CSD data set - Run 1", rc=0, stdout="TEST.REGIONS.CSD", stderr="stderr"),
63-
_execution(name="DFHCCUTL - Initialise CSD", rc=0, stdout="stdout", stderr="stderr"),
62+
# _execution(name="DFHCCUTL - Initialise CSD", rc=0, stdout="stdout", stderr="stderr"),
6463
_execution(name="IKJEFT01 - Get Data Set Status - Run 1", rc=0, stdout="TEST.REGIONS.CSD VSAM", stderr="stderr")
6564
],
6665
start_state=_state(exists=False, vsam=False),
@@ -97,12 +96,12 @@ def test_do_nothing_to_an_existing_csd():
9796
csd_module.data_set = data_set
9897

9998
dataset_utils.ikjeft01 = MagicMock(side_effect=[(0, "TEST.REGIONS.CSD VSAM", "stderr"), (0, "TEST.REGIONS.CSD VSAM", "stderr")])
100-
csd_utils._execute_dfhccutl = MagicMock(return_value=MVSCmdResponse(rc=0, stdout="stdout", stderr="stderr"))
99+
# csd_utils._execute_dfhcsdup = MagicMock(return_value=MVSCmdResponse(rc=0, stdout="stdout", stderr="stderr"))
101100

102101
csd_module.main()
103102
expected_result = _response(executions=[
104103
_execution(name="IKJEFT01 - Get Data Set Status - Run 1", rc=0, stdout="TEST.REGIONS.CSD VSAM", stderr="stderr"),
105-
_execution(name="DFHCCUTL - Initialise CSD", rc=0, stdout="stdout", stderr="stderr"),
104+
# _execution(name="DFHCCUTL - Initialise CSD", rc=0, stdout="stdout", stderr="stderr"),
106105
_execution(name="IKJEFT01 - Get Data Set Status - Run 1", rc=0, stdout="TEST.REGIONS.CSD VSAM", stderr="stderr")
107106
],
108107
start_state=_state(exists=True, vsam=True),
@@ -191,24 +190,24 @@ def test_error_warm_start_a_non_existent_csd():
191190
assert csd_module.result == expected_result
192191

193192

194-
@pytest.mark.skipif(sys.version_info.major < 3, reason="Requires python 3 language features")
195-
def test_bad_response_from_ccutl():
196-
csd_module = initialise_module()
197-
198-
dataset_utils.idcams = MagicMock(return_value=(0, "TEST.REGIONS.CSD", "stderr"))
199-
dataset_utils.ikjeft01 = MagicMock(side_effect=[(8, "TEST.REGIONS.CSD NOT IN CATALOG", "stderr"), (0, "TEST.REGIONS.CSD VSAM", "stderr")])
200-
csd_utils._execute_dfhccutl = MagicMock(return_value=MVSCmdResponse(rc=99, stdout="stdout", stderr="stderr"))
201-
202-
csd_module.main()
203-
expected_result = _response(executions=[
204-
_execution(name="IKJEFT01 - Get Data Set Status - Run 1", rc=8, stdout="TEST.REGIONS.CSD NOT IN CATALOG", stderr="stderr"),
205-
_execution(name="IDCAMS - Create CSD data set - Run 1", rc=0, stdout="TEST.REGIONS.CSD", stderr="stderr"),
206-
_execution(name="DFHCCUTL - Initialise CSD", rc=99, stdout="stdout", stderr="stderr"),
207-
_execution(name="IKJEFT01 - Get Data Set Status - Run 1", rc=0, stdout="TEST.REGIONS.CSD VSAM", stderr="stderr")
208-
],
209-
start_state=_state(exists=False, vsam=False),
210-
end_state=_state(exists=True, vsam=True)
211-
)
212-
expected_result.update({"changed": True})
213-
expected_result.update({"failed": True})
214-
assert csd_module.result == expected_result
193+
# @pytest.mark.skipif(sys.version_info.major < 3, reason="Requires python 3 language features")
194+
# def test_bad_response_from_ccutl():
195+
# csd_module = initialise_module()
196+
197+
# dataset_utils.idcams = MagicMock(return_value=(0, "TEST.REGIONS.CSD", "stderr"))
198+
# dataset_utils.ikjeft01 = MagicMock(side_effect=[(8, "TEST.REGIONS.CSD NOT IN CATALOG", "stderr"), (0, "TEST.REGIONS.CSD VSAM", "stderr")])
199+
# csd_utils._execute_dfhcsdup = MagicMock(return_value=MVSCmdResponse(rc=99, stdout="stdout", stderr="stderr"))
200+
201+
# csd_module.main()
202+
# expected_result = _response(executions=[
203+
# _execution(name="IKJEFT01 - Get Data Set Status - Run 1", rc=8, stdout="TEST.REGIONS.CSD NOT IN CATALOG", stderr="stderr"),
204+
# _execution(name="IDCAMS - Create CSD data set - Run 1", rc=0, stdout="TEST.REGIONS.CSD", stderr="stderr"),
205+
# _execution(name="DFHCCUTL - Initialise CSD", rc=99, stdout="stdout", stderr="stderr"),
206+
# _execution(name="IKJEFT01 - Get Data Set Status - Run 1", rc=0, stdout="TEST.REGIONS.CSD VSAM", stderr="stderr")
207+
# ],
208+
# start_state=_state(exists=False, vsam=False),
209+
# end_state=_state(exists=True, vsam=True)
210+
# )
211+
# expected_result.update({"changed": True})
212+
# expected_result.update({"failed": True})
213+
# assert csd_module.result == expected_result

0 commit comments

Comments
 (0)