Implementation of new "like" parameter for data set creation

[katelynienaber]

Solves linked issue: #754

The changes in this PR will allow calling of zowe.Create.dataSet with the new "like" REST parameter implemented in zOSMF v2.4.

I am not absolutely certain this doesn't belong in Imperative. Please let me know if it should be moved.

[zFernand0]

Left a few comments.
Also, please don't source test files:
******/zosfile/download/a1595240/a775092.txt

[katelynienaber]

Left a few comments.
Also, please don't source test files:
******/zosfile/download/a1595240/a775092.txt

Fixed! Also changed ID. Will check to see if I left it anywhere...

[codecov]

Codecov Report

Merging #766 into master will increase coverage by 0.02%.
The diff coverage is 87.09%.

@@            Coverage Diff             @@
##           master     #766      +/-   ##
==========================================
+ Coverage   91.75%   91.78%   +0.02%     
==========================================
  Files         344      344              
  Lines        5035     4818     -217     
  Branches      747      638     -109     
==========================================
- Hits         4620     4422     -198     
+ Misses        413      394      -19     
  Partials        2        2              

Impacted Files	Coverage Δ
...es/zosfiles/src/api/constants/ZosFiles.messages.ts	100.00% <ø> (ø)
packages/zosfiles/src/api/methods/create/Create.ts	91.60% <87.09%> (-1.70%)	⬇️
...owDefinition/RetrieveWorkflowDefinition.handler.ts	68.42% <0.00%> (-0.33%)	⬇️
packages/zosfiles/src/api/utils/ZosFilesUtils.ts	97.84% <0.00%> (+0.97%)	⬆️
...li/list/activeWorkflows/ActiveWorkflows.handler.ts	84.21% <0.00%> (+3.44%)	⬆️
packages/workflows/src/api/ListWorkflows.ts	100.00% <0.00%> (+11.66%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2a8805c...c4fa836. Read the comment docs.

[ghost]

Thanks for adding this parameter! Left a few comments related to tests.

Also I'm having a problem when calling the create dataset API like this:
await Create.dataSet(session, CreateDataSetTypeEnum.DATA_SET_LIKE, "DSNAME.NEW", { like: "DSNAME.OLD" });

An error 500 is returned:

RestClientError: z/OSMF REST API Error:
Rest API failure with HTTP(S) status 500
category: 1
rc:       4
reason:   13
message:  primary

I think the problem may be with the payload being sent:

Resource:  /zosmf/restfiles/ds/DSNAME.NEW
Request:   POST
Headers:   [{"X-CSRF-ZOSMF-HEADER":true}]
Payload:   '{"like":"DSNAME.OLD","secondary":1}'

Seems like the secondary property is getting set in the payload but shouldn't be. Since secondary is set, z/OSMF expects that primary should also be set.

[katelynienaber]

Thanks for adding this parameter! Left a few comments related to tests.

Also I'm having a problem when calling the create dataset API like this:
await Create.dataSet(session, CreateDataSetTypeEnum.DATA_SET_LIKE, "DSNAME.NEW", { like: "DSNAME.OLD" });

An error 500 is returned:

RestClientError: z/OSMF REST API Error:
Rest API failure with HTTP(S) status 500
category: 1
rc:       4
reason:   13
message:  primary

I think the problem may be with the payload being sent:

Resource:  /zosmf/restfiles/ds/DSNAME.NEW
Request:   POST
Headers:   [{"X-CSRF-ZOSMF-HEADER":true}]
Payload:   '{"like":"DSNAME.OLD","secondary":1}'

Seems like the secondary property is getting set in the payload but shouldn't be. Since secondary is set, z/OSMF expects that primary should also be set.

I have gotten to the easier comments, now I will take a look at this one...

[katelynienaber]

Okay I think I have also gotten to the accidental setting of the secondary parameter...

[ghost]

Thanks for addressing earlier comments 👍 Pushed a commit to wrap the system test in a TestEnvironment.

The API is working for me now. I was still getting error 500 after you removed the "secondary" property, then realized I was testing on a system that doesn't have the "allocate like" APAR installed. 😢

Will approve once the question about required values on ICreateDataSetOptions is addressed 🙂

[ghost]

Thanks for adding the ICreateDataSetLikeOptions interface and Create.dataSetLike method, they look good 🙂 Left a few comments.

[zFernand0]

LGTM

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities (and 0 Security Hotspots to review)
2 Code Smells

85.7% Coverage
0.0% Duplication

The version of Java (1.8.0_212) you have used to run this analysis is deprecated and we will stop accepting it from October 2020. Please update to at least Java 11.
Read more here

done

[katelynienaber]

woohoo!