Skip to content

Commit 7d5f71e

Browse files
ddimatosblakeinateasifmahmudAsif Mahmudandy-maier
authored
Release v1.3.0 (#273)
* Bugfix/4407/job utility fails on special chars (#208) * update job utility to avoid direct JSON parsing * fix job status updates * update line length for linter * Update test cases (#207) Co-authored-by: Asif Mahmud <[email protected]> * add dependency finder (#210) * add dependency finder * update ignore files * add specific pylint error number * switch from test ID to ansible-given name * Enhancement/4365/role doc support (#209) * Edits to makefile to support doc gen for roles * Sample role to test doc gen * Roles RST tie into index.rst * Role sample and make file updates * Documentation for makefile target role-doc added * Updated role doc sample with build sample script and corrected make file * Added package level checks and script description * Added logic to check for roles entry in the index.rst * Removed roles reference from sample in index.rst * Added newlines to files * Delete copy of script * Update example playbook for the sample role * Lint issue, empty lines was 2 * Added extra messages for better instruction. * add origin/ to branch name (#212) * fix newline print if nothing found (#215) * Bugfix/4660/copy program objects (#213) * Use -X flag to copy program objects * Fix typo Co-authored-by: Asif Mahmud <[email protected]> Co-authored-by: ddimatos <[email protected]> * Update template to support complex list with elements (#214) Signed-off-by: ddimatos <[email protected]> * Support for choosing parm odering in module template (#220) Details: * This change allows selecting whether the input parameter of modules are sorted by name or remain ordered as in the source, by modifying a boolean variable 'sorted' in the module.rst.j2 file. Signed-off-by: Andreas Maier <[email protected]> * Fixed return value formatting issues in module template (#223) Details: * If the description was a list with multiple items, only the first item was shown and the others were just dropped. This was fixed by showing all items of the list. * The description was not rst_ify'ed, causing formatting strings such as 'C(xxx)' to appear verbatim. This was fixed by using the rst_ify filter, consistent with how it was already done for the description of input parameters. * Nested properties were not always indented correctly (i.e. the desired 2 blanks per level). Fixed that. * The 'type:' item was indented some blanks more than the other attributes of a property. Fixed that by indenting it with the same number of blanks as the other attributes. * For samples that are not str or int, the code_block statement and the following sample data item are not indented variably by level, but by a fixed number of blanks in the generated rst. This causes them to be rendered inconsistent as soon as the nesting level of the properties is more than 4 or so. Fixed that by indenting them by level. * The top level of return properties was already indented one level. This is not a real problem, but inconsistent with how it is done for input parameters, and when looking at the generated rst file with a browser, grey vertical bars are shown due to that. Fixed that by changing the initial level from 1 to 0, consistent with input parms. * There were many trailing blanks. Not a real problem, but somehow inconvenient in git with editors that strip them. Fixed that by letting all control constructs begin at the begin of the line instead of indenting them according to their control nesting level. The control nesting level is still maintained but within the curly braces of the control construct. Signed-off-by: Andreas Maier <[email protected]> * Fixes #224: Support for multiple samples in module return properties (#225) * Fixed return value formatting issues in module template Details: * If the description was a list with multiple items, only the first item was shown and the others were just dropped. This was fixed by showing all items of the list. * The description was not rst_ify'ed, causing formatting strings such as 'C(xxx)' to appear verbatim. This was fixed by using the rst_ify filter, consistent with how it was already done for the description of input parameters. * Nested properties were not always indented correctly (i.e. the desired 2 blanks per level). Fixed that. * The 'type:' item was indented some blanks more than the other attributes of a property. Fixed that by indenting it with the same number of blanks as the other attributes. * For samples that are not str or int, the code_block statement and the following sample data item are not indented variably by level, but by a fixed number of blanks in the generated rst. This causes them to be rendered inconsistent as soon as the nesting level of the properties is more than 4 or so. Fixed that by indenting them by level. * The top level of return properties was already indented one level. This is not a real problem, but inconsistent with how it is done for input parameters, and when looking at the generated rst file with a browser, grey vertical bars are shown due to that. Fixed that by changing the initial level from 1 to 0, consistent with input parms. * There were many trailing blanks. Not a real problem, but somehow inconvenient in git with editors that strip them. Fixed that by letting all control constructs begin at the begin of the line instead of indenting them according to their control nesting level. The control nesting level is still maintained but within the curly braces of the control construct. Signed-off-by: Andreas Maier <[email protected]> * Support for multiple samples in module return properties Details: * The module.rst.j2 template supported only a single sample in the 'sample' attribute of a return property. This change adds support for multiple samples by specifying child attributes 'sample1', 'sample2', etc under the 'sample' attribute. This is consistent with how the ibm_zosmf collection supports it, but the solution in addition takes care to distinguish str/int types and complex types consistent with how it is done for single samples. Signed-off-by: Andreas Maier <[email protected]> Co-authored-by: ddimatos <[email protected]> * Fixes #226: Support for showing list elements in module return values (#227) * Fixed return value formatting issues in module template Details: * If the description was a list with multiple items, only the first item was shown and the others were just dropped. This was fixed by showing all items of the list. * The description was not rst_ify'ed, causing formatting strings such as 'C(xxx)' to appear verbatim. This was fixed by using the rst_ify filter, consistent with how it was already done for the description of input parameters. * Nested properties were not always indented correctly (i.e. the desired 2 blanks per level). Fixed that. * The 'type:' item was indented some blanks more than the other attributes of a property. Fixed that by indenting it with the same number of blanks as the other attributes. * For samples that are not str or int, the code_block statement and the following sample data item are not indented variably by level, but by a fixed number of blanks in the generated rst. This causes them to be rendered inconsistent as soon as the nesting level of the properties is more than 4 or so. Fixed that by indenting them by level. * The top level of return properties was already indented one level. This is not a real problem, but inconsistent with how it is done for input parameters, and when looking at the generated rst file with a browser, grey vertical bars are shown due to that. Fixed that by changing the initial level from 1 to 0, consistent with input parms. * There were many trailing blanks. Not a real problem, but somehow inconvenient in git with editors that strip them. Fixed that by letting all control constructs begin at the begin of the line instead of indenting them according to their control nesting level. The control nesting level is still maintained but within the curly braces of the control construct. Signed-off-by: Andreas Maier <[email protected]> * Support for showing list elements in module return values Details: * Currently, the module.rst.j2 template does not show the 'elements' attribute for return value properties. It does show it for input parameters. This change adds support for showing the 'elements' attribute for return value properties, if specified. Signed-off-by: Andreas Maier <[email protected]> Co-authored-by: ddimatos <[email protected]> * Fixes #228: Support for multi-line JSON samples in module template (#229) * Fixed return value formatting issues in module template Details: * If the description was a list with multiple items, only the first item was shown and the others were just dropped. This was fixed by showing all items of the list. * The description was not rst_ify'ed, causing formatting strings such as 'C(xxx)' to appear verbatim. This was fixed by using the rst_ify filter, consistent with how it was already done for the description of input parameters. * Nested properties were not always indented correctly (i.e. the desired 2 blanks per level). Fixed that. * The 'type:' item was indented some blanks more than the other attributes of a property. Fixed that by indenting it with the same number of blanks as the other attributes. * For samples that are not str or int, the code_block statement and the following sample data item are not indented variably by level, but by a fixed number of blanks in the generated rst. This causes them to be rendered inconsistent as soon as the nesting level of the properties is more than 4 or so. Fixed that by indenting them by level. * The top level of return properties was already indented one level. This is not a real problem, but inconsistent with how it is done for input parameters, and when looking at the generated rst file with a browser, grey vertical bars are shown due to that. Fixed that by changing the initial level from 1 to 0, consistent with input parms. * There were many trailing blanks. Not a real problem, but somehow inconvenient in git with editors that strip them. Fixed that by letting all control constructs begin at the begin of the line instead of indenting them according to their control nesting level. The control nesting level is still maintained but within the curly braces of the control construct. Signed-off-by: Andreas Maier <[email protected]> * Support for multiple samples in module return properties Details: * The module.rst.j2 template supported only a single sample in the 'sample' attribute of a return property. This change adds support for multiple samples by specifying child attributes 'sample1', 'sample2', etc under the 'sample' attribute. This is consistent with how the ibm_zosmf collection supports it, but the solution in addition takes care to distinguish str/int types and complex types consistent with how it is done for single samples. Signed-off-by: Andreas Maier <[email protected]> * Support for multi-line JSON samples in module template Details: * The current module template generates long single-line JSON representations of sample values of return value properties. This change formats them as multi-line JSOn with an indentation of 4. * The code-block used for these JSOn samples is marked up to have json content, producing a nicer coloring of the samples. Signed-off-by: Andreas Maier <[email protected]> Co-authored-by: ddimatos <[email protected]> * Add support to template to skip options that begin with an underscore Signed-off-by: ddimatos <[email protected]> * Remove depreated ansible_metadata blocks from all modules per Ansibles new requirements (#235) Signed-off-by: ddimatos <[email protected]> * Update/create new issue templates (#236) * Update/create new issue templates Adding three new templates: - Bug report - Feature request - Documentation report * Update template with shoter headings Update with shorter headings and uppercase * Updated issue topics and made them uppercase * Renamed Documentation URL to just URL * Uppercase Screenshots * Template updates Signed-off-by: ddimatos <[email protected]> * Renamed documentation-report.md to documentation_report.md Signed-off-by: ddimatos <[email protected]> * Improve template comments. Signed-off-by: ddimatos <[email protected]> * Updated build_ignore for Ansible 2.10 readiness and additional updates (#237) Signed-off-by: ddimatos <[email protected]> * Update README to standardize across collections (#238) * Update README to standardize across collections Signed-off-by: ddimatos <[email protected]> * Update year on copyright Signed-off-by: ddimatos <[email protected]> * Updated all licenses to use verbose declaration of apache v2 lic (#239) Signed-off-by: ddimatos <[email protected]> * add jenkinsfile (#240) * Update module documentation to provide a better flow to the user (#243) Signed-off-by: ddimatos <[email protected]> * update ping module with empty options as newest ansible-doc-extrator requires it (#242) Signed-off-by: ddimatos <[email protected]> * Added Jenkinsfile to the ignore to exclude from collection builds (#241) Signed-off-by: ddimatos <[email protected]> * adding Blake's test change, and Rich's script change to a clean dev pull (#244) * Enhancement/3729 (#247) * initial pre-testing commit. Interface changes and basic rexx script are there. * got basic playbooks working. Changed command to 1-line. Added surrounding quotes for neatness * corrected bad assumption about sdsf isexec operators. switched to checking first word of command. it now appears to pass existing pytests. * Corrected reported PEP8 errors * responses to review commends on 12/7-12/8 corrected documentation typo added a little extra info on verbose, security fields changes to rexx script: - removed usage calls. Added usage info as comment to the python - added (WAIT) or (VERBOSE WAIT) to fully implement the delay feature - switched to user arg for the fixed position parameters - renamed 'dumpit' to 'showoutput' (sorry) * removed reset option, based on discussion with onno also added more output detail based on verbose and security options * removed comment with too many leading octothorps * responses to review: + consolidates -v and -s options + eliminated -d option + added 'rapid' req=false def=true to use delay as timeout + if 'rapid'=false, delay is "wait" for full time + delay=0 will now ignore delay + function tests updated to try 5 rapid and 7 non-rapid + documentation updated * Changes based on review: + changed time variables to wait_time_s and wait + added actual time evaluation to the test cases * Fixed bad indent on 'wait' documentation * fixed doc line referring to 0 * Correct long lines in doc Signed-off-by: ddimatos <[email protected]> * removed debug entries from data in unit tests added missing dependancy check file * changed test 5 to not be a duplicate of test 3...mistake from removing 'debug' * corrected bug in rexx script used for opercmd changed args from 'arg' to positions, to reconcile command issues * updated operator to allow for error returns leaving changed as false .. previously it was always setting the return the changed=true * added shebang to a docs file * added new error condition to handle command errors it turns out running a rexx script returns 0 if the rexx succeeds so I'm checking that at least 3 lines came back also checking that the third line doesn't have invalid or error * typo fix: missed a parenthesis. * typo fix (note in) * continuing the typo patrol * changed scan for 'invalid' to account for 'running' line of output (scan was off by 1 line) * added error conditions as json fails for invalid/error notes * added explicit exception text for test purposes (mfj doesn't do this?!) * Moved 'running' line to end and called 'ran', to see if it fixes the jobId issue * change to better_arg_parser to handle more complex encoding arguments, specifically for ANSI_X3.4-1968 * Revert "added explicit exception text for test purposes (mfj doesn't do this?!)" This reverts commit 7ff0955. alse removed change to [email protected]'t fix issue * Added condition for when action call includes a starting slash * added time to test_zos_operator_positive_verbose_with_quick_delay it was failing on too small of a time difference * still messing with the time-based test. * changed error testing loop to handle possible null/none cases changed error checking to iterate the first 5 lines of each output type, so we're not dependant on a fixed response position. * corrected operator-command-error, where composite message was still needed * Added comments to describe the new error detection logic Added explanations of the 5, 2 and internal variables * corrected the documentation so it doesn't say "JCL" added 'unidentifiable' as an additional error status return Co-authored-by: ddimatos <[email protected]> * Update bug template with version request Added requests for version and additional detail. * Update requirements_managed.rst (#248) * Update requirements_managed.rst Reorganized content for core managed requirments * Update requirements_managed.rst Moved the links about playbook configuration to reorganize content * Update playbooks.rst moved links about playbook basics to this topic from the requirements topic * Update requirements_managed.rst removed playbook links * return stderr if not empty (#249) * Enhancement/3688b (#246) * added pre-filter to job_submit to eliminate carriage returns before converting to EBCDIC * added changes for BetterArgParser & NAZARE-4835: + Added recognition of '.' and '..'. + Centralized pathing for 2 functions. + Changed choice processor to handle case-mismatches. * rebuilt 3688 pulling from dev instead of master for root + change to zos_job_submit to pre-filter \r from incoming text files + 4835 change to better_arg_parser to process '.' and '..' + 4835 change to better_arg_parser to allow case-correction on choice arg types * Correction after saving change to wrong local branch + zos_job_submit should now have the correct changes + it appears better_arg_parser was saved correctly * updated a test module that was misbehaving. * discovered test_zos_copy.py was legacy...re-committing with correction * commented out first data case on test_argument_parsing_unix_failure_path This is because new local_path resolves "../u..." correctly, so won't throw expected ValueError * Removed case-unsensitive 'casefold' from better arg parser This is because multiple other module tests are dependant on case-sensitive arg rejection * change to test of better arg parser to not look at .. value, since that now works * change to use -c option on iconv call, to see if that resolves cr issue * added test for extra \r to the pytest system * added match/no match info into job.py * changed regex to accomodate potential leading spaces, which duplicated the issue removed tracing print statements * added error handler/raise to _parse_jobs, enhanced completion_messages search string * changed job parse_job to is not none ... this make move to a runtime error altered zos_job_submit to verify I'm seeing the correct string trigger * cleaned error message in job.py removed previous filter code from zos_job_submit unless the error starts triggering again, this is a final build * added readable vs unreadable to job task * added nonetypoe prodection to _parse_dds in job.py (second nonetype crash) * removed quotes in the doc for 'block' (#250) * Updated requirements for managed node doc Signed-off-by: ddimatos <[email protected]> * Updated managed nod doc with target keyword Signed-off-by: ddimatos <[email protected]> * Update requirements single doc with streamlined doc to better map to other updated docs Signed-off-by: ddimatos <[email protected]> * Clean up playbooks doc bullets that had extra spaces Signed-off-by: ddimatos <[email protected]> * Update release notes for v1.3.0-beta.2 Signed-off-by: ddimatos <[email protected]> * Update modules doc to reduce unnecessary ansible-doc reference Signed-off-by: ddimatos <[email protected]> * Update doc gen conf to remove the prev and next buttons Signed-off-by: ddimatos <[email protected]> * Generate all module docs with the updated module.rst.j2 template Signed-off-by: ddimatos <[email protected]> * Update release_notes.rst Minor doc fixes * Unfied doc consistency change for Ansible core content. (#253) * Update ansible content page with trademarks and scope Signed-off-by: ddimatos <[email protected]> * Update with links and zoau reference Signed-off-by: ddimatos <[email protected]> * Updated release notes with clearer job utility description and a playbook bug Signed-off-by: ddimatos <[email protected]> * Fix pep8 missing indentation or outdented Signed-off-by: ddimatos <[email protected]> * Fix pep8 missing indentation or outdented v2 Signed-off-by: ddimatos <[email protected]> * Correct MD style link found in RST style Signed-off-by: ddimatos <[email protected]> * Update readme to remove the playbooks reference as material included with a collection (#257) Signed-off-by: ddimatos <[email protected]> * Updates to copy module to better explain behavior under particular conditions (#267) Signed-off-by: ddimatos <[email protected]> * Adding support for Ansible Execution Environments (#268) * Adding support for Ansible Execution Environments Signed-off-by: ddimatos <[email protected]> * Add sanity ignore file in preparation for Ansible 2.11 Signed-off-by: ddimatos <[email protected]> * Adding ignore-2.12.txt (#271) Signed-off-by: ddimatos <[email protected]> * Content/6153/doc to describe module behavior (#270) * Update documentation for zos_mvs_raw module to better describe the modules behavior Signed-off-by: ddimatos <[email protected]> * Revert part of the updated doc for option dd_data_set in module zos_mvs_raw Signed-off-by: ddimatos <[email protected]> * Content/getting v.1.3.0 ready (#272) * Initial release of product meta data for future use Signed-off-by: ddimatos <[email protected]> * Update release notes for v1.3.0 Signed-off-by: ddimatos <[email protected]> * Module docs updated for release v1.3.0 Signed-off-by: ddimatos <[email protected]> * Update incrrect indentation Signed-off-by: ddimatos <[email protected]> * Correct SMPE playbook link Signed-off-by: ddimatos <[email protected]> * Update the galaxy meta version number Signed-off-by: ddimatos <[email protected]> Co-authored-by: Blake Becker <[email protected]> Co-authored-by: Asif Mahmud <[email protected]> Co-authored-by: Asif Mahmud <[email protected]> Co-authored-by: Andreas Maier <[email protected]> Co-authored-by: Rich Parker <[email protected]> Co-authored-by: RadhaV2020 <[email protected]> Co-authored-by: balkajbaf <[email protected]>
1 parent afd55cf commit 7d5f71e

File tree

13 files changed

+317
-543
lines changed

13 files changed

+317
-543
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
IBM z/OS core collection
22
========================
33

4-
The **IBM z/OS core collection**, also represented as
4+
The **IBM® z/OS® core collection**, also represented as
55
**ibm_zos_core** in this document, is part of the broader
66
initiative to bring Ansible Automation to IBM Z® through the offering
77
**Red Hat® Ansible Certified Content for IBM Z®**. The
88
**IBM z/OS core collection** supports automation tasks such as
9-
creating data sets, submitting jobs, querying jobs,
10-
retrieving job output, encoding data sets, fetching data sets, copying data
11-
sets, executing operator commands, executing TSO commands, ping,
9+
creating data sets, submitting jobs, querying jobs, retrieving job output,
10+
encoding data, fetching data sets, copying data sets,
11+
executing operator commands, executing TSO commands, ping,
1212
querying operator actions, APF authorizing libraries,
1313
editing textual data in data sets or Unix System Services files,
1414
finding data sets, backing up and restoring data sets and
@@ -36,7 +36,6 @@ released to [Ansible Automation Hub](https://www.ansible.com/products/automation
3636
as **certified** and **IBM supported** for
3737
**Red Hat® Ansible Automation Platform subscribers**.
3838

39-
4039
For guides and reference, please review the [documentation](https://ibm.github.io/z_ansible_collections_doc/index.html).
4140

4241
Features
@@ -46,7 +45,6 @@ The **IBM z/OS core collection**, includes
4645
[action plugins](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/plugins.html#action),
4746
[modules](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/modules.html),
4847
[filters](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/filters.html),
49-
[sample playbooks](https://ibm.github.io/z_ansible_collections_doc/playbooks/playbooks.html)
5048
and ansible-doc to automate tasks on z/OS.
5149

5250
Copyright

bindep.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
################################################################################
2+
# © Copyright IBM Corporation 2021
3+
################################################################################
4+
# This file maintains a list of any binary dependencies needed by this
5+
# Collection. At this time there are no binary dependencies.
6+
# For more information on Bindep,
7+
# see https://docs.opendev.org/opendev/bindep/latest/readme.html
8+
################################################################################

docs/source/modules/zos_copy.rst

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,15 +75,17 @@ dest
7575

7676
If ``dest`` is a nonexistent USS file, it will be created.
7777

78-
If ``dest`` is a nonexistent data set, it will be allocated.
78+
If ``dest`` is a nonexistent data set, storage management rules will be used to determine the volume where ``dest`` will be allocated.
7979

8080
If ``src`` and ``dest`` are files and if the parent directory of ``dest`` does not exist, then the task will fail.
8181

82-
When the ``dest`` is an existing VSA:ref:`KSDS <KSDS_module>` or VSA:ref:`ESDS <ESDS_module>`, then source can be ESDS, KSDS or RRDS.
82+
When the ``dest`` is an existing VSA:ref:`KSDS <KSDS_module>` or VSA:ref:`ESDS <ESDS_module>`, then source can be ESDS, KSDS or RRDS. The ``dest`` will be deleted and storage management rules will be used to determine the volume where ``dest`` will be allocated.
8383

84-
When the ``dest`` is an existing VSA:ref:`RRDS <RRDS_module>`, then the source must be RRDS.
84+
When the ``dest`` is an existing VSA:ref:`RRDS <RRDS_module>`, then the source must be RRDS. The ``dest`` will be deleted and storage management rules will be used to determine the volume where ``dest`` will be allocated.
8585

86-
When ``dest`` is and existing VSA:ref:`LDS <LDS_module>`, then source must be LDS.
86+
When ``dest`` is and existing VSA:ref:`LDS <LDS_module>`, then source must be LDS. The ``dest`` will be deleted and storage management rules will be used to determine the volume where ``dest`` will be allocated.
87+
88+
When ``dest`` is a data set, you can override storage management rules by specifying both ``volume`` and ``model_ds``.
8789

8890
| **required**: True
8991
| **type**: str
@@ -229,11 +231,15 @@ validate
229231
volume
230232
If ``dest`` does not exist, specify which volume ``dest`` should be allocated to.
231233

234+
``volume`` must be used with ``model_ds``, otherwise the ``volume`` value is ignored.
235+
232236
Only valid when the destination is an MVS data set.
233237

234238
The volume must already be present on the device.
235239

236-
If no volume is specified, an appropriate volume will be chosen to allocate ``dest``.
240+
If no volume is specified, storage management rules will be used to determine the volume where ``dest`` will be allocated.
241+
242+
If the storage administrator has specified a system default unit name and you do not set a ``volume`` name for non-system-managed data sets, then the system uses the volumes associated with the default unit name. Check with your storage administrator to determine whether a default unit name has been specified.
237243

238244
| **required**: False
239245
| **type**: str
@@ -410,6 +416,8 @@ Notes
410416

411417
For supported character sets used to encode data, refer to https://ansible-collections.github.io/ibm_zos_core/supplementary.html#encode
412418

419+
:ref:`zos_copy <zos_copy_module>` uses SFTP (Secure File Transfer Protocol) for the underlying transfer protocol; Co:Z SFTP is not supported. In the case of Co:z SFTP, you can exempt the Ansible userid on ZOS from using Co:Z thus falling back to using standard SFTP.
420+
413421

414422

415423
See Also

0 commit comments

Comments
 (0)