Add verifyCertificates option and 'Run zwe init certificates' button to Certificate Stage #79

timgerstel · 2023-10-28T08:31:07Z

Proposed changes

This pull request implements the following changes:

Enhance Certificate stage of Zen
Add UI elements to set zowe.verifyCertificates
Add UI button to run 'zwe init certificates'

This PR depends upon the following PRs:

Type of change

Please delete options that are not relevant.

New feature (non-breaking change which adds functionality)

PR Checklist

Please delete options that are not relevant.

If the changes in this PR are meant for the next release / mainline, this PR targets a "staging" branch.
My code follows the style guidelines of this project (see: Contributing guideline)
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
New and existing unit tests pass locally with my changes
video or image is included if visual changes are made

My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works, or describe a test method below

Testing

Further comments

Signed-off-by: Timothy Gerstel <[email protected]>

…efactor and implement form change handler Signed-off-by: Timothy Gerstel <[email protected]>

Signed-off-by: Timothy Gerstel <[email protected]>

…unning zwe init certificates Signed-off-by: Timothy Gerstel <[email protected]>

…ly and remove console logs Signed-off-by: Timothy Gerstel <[email protected]>

Signed-off-by: Timothy Gerstel <[email protected]>

…recate ConfigurationStore somehow Signed-off-by: Timothy Gerstel <[email protected]>

Signed-off-by: Timothy Gerstel <[email protected]>

…ertificateStage Signed-off-by: Timothy Gerstel <[email protected]>

Signed-off-by: Timothy Gerstel <[email protected]>

src/actions/InstallationHandler.ts

1000TurquoisePogs · 2023-10-30T10:30:51Z

src/actions/InstallationHandler.ts

+      return ProgressStore.set('certificate.uploadYaml', false);;
+    }
+    ProgressStore.set('certificate.uploadYaml', uploadYaml.status);
+    const script = `cd ${installDir}/runtime/bin;\n./zwe init certificate -c ${installDir}/zowe.yaml`;


zwe init has many optional arguments. how can we let the user choose?

https://docs.zowe.org/stable/appendix/zwe_server_command_reference/zwe/init/zwe-init-certificate

--update-config is a good arg (probably we should default to it!) but it requires us to pull back the yaml when done, and consume it to get the changes.

--allow-overwrite also seems like a good arg, because without it you could just fail if the operation were done twice for 2 different installs.

--security-dry-run and similar dry-run stuff will be needed in a future ticket, so that we can show a preview before we do a thing.

Agree but I think this is out of scope for the ticket

i'm sure you

want --update-config and --allow-overwrite as a default, unless you like failures and manual labor (bugs me that these arent defaults in zwe itself)

want to make a function that takes these as arguments so that in another ticket, you can make a UI that varies the arguments.

1000TurquoisePogs · 2023-10-30T10:31:25Z

src/renderer/components/stages/Certificates.tsx

  const setupSchema = schema ? schema.properties.zowe.properties.setup.properties.certificate : "";
+  const verifyCertsSchema = schema ? {"type": "object", "properties": {"verifyCertificates": schema.properties.zowe.properties.verifyCertificates}} : "";


what does this mean? why would our schema be empty?

I did this because this is how @sakshibobade21 implemented it after implementing JsonForms:

https://github.com/zowe/zen/blob/v2.x/staging/src/renderer/components/stages/Security.tsx#L26
https://github.com/zowe/zen/blob/v2.x/staging/src/renderer/components/stages/installation/Installation.tsx#L33

Figured maybe she knew something we didn't

src/renderer/components/stages/Planning.tsx

Signed-off-by: Timothy Gerstel <[email protected]>

DivergentEuropeans · 2023-11-01T16:14:45Z

src/actions/InstallationHandler.ts

+    console.log("uploading yaml...");
+    const uploadYaml = await this.uploadYaml(connectionArgs, installDir);
+    if(!uploadYaml.status){
+      return ProgressStore.set('certificate.uploadYaml', false);;


double semi-colon

DivergentEuropeans · 2023-11-02T11:57:15Z

src/renderer/components/stages/Certificates.tsx

  const [isFormValid, setIsFormValid] = useState(false);
  const [formError, setFormError] = useState('');

  const section = 'certificate';
  const initConfig: any = getConfiguration(section);

+  const verifyCertsConfig: any = (getZoweConfig() as any).zowe.verifyCertificates;


This gives me a run-time error at certificates step

[14660:1102/075437.976:INFO:CONSOLE(46)] "Uncaught TypeError: Cannot read properties of undefined (reading 'zowe')", source: webpack-internal:///./src/renderer/components/stages/Certificates.tsx (46)
[14660:1102/075437.987:INFO:CONSOLE(46)] "Uncaught TypeError: Cannot read properties of undefined (reading 'zowe')", source: webpack-internal:///./src/renderer/components/stages/Certificates.tsx (46)
[14660:1102/075437.993:INFO:CONSOLE(18687)] "The above error occurred in the component:

at Certificates (webpack-internal:///./src/renderer/components/stages/Certificates.tsx:30:49) at div at div at eval (webpack-internal:///./node_modules/@emotion/react/dist/emotion-element-6a883da9.browser.esm.js:57:66) at Box (webpack-internal:///./node_modules/@mui/system/esm/createBox.js:34:72) at HorizontalLinearStepper (webpack-internal:///./src/renderer/components/common/Stepper.tsx:49:13) at div at Wizard (webpack-internal:///./src/renderer/components/configuration-wizard/Wizard.tsx:37:133) at RenderedRoute (webpack-internal:///./node_modules/react-router/dist/index.js:715:5) at Outlet (webpack-internal:///./node_modules/react-router/dist/index.js:1118:26) at Header (webpack-internal:///./src/renderer/components/Header.tsx:47:60) at RenderedRoute (webpack-internal:///./node_modules/react-router/dist/index.js:715:5) at Routes (webpack-internal:///./node_modules/react-router/dist/index.js:1209:5) at Router (webpack-internal:///./node_modules/react-router/dist/index.js:1141:15) at HashRouter (webpack-internal:///./node_modules/react-router-dom/dist/index.js:372:5) at InnerThemeProvider (webpack-internal:///./node_modules/@mui/system/esm/ThemeProvider/ThemeProvider.js:23:70) at ThemeProvider (webpack-internal:///./node_modules/@mui/private-theming/ThemeProvider/ThemeProvider.js:45:5) at ThemeProvider (webpack-internal:///./node_modules/@mui/system/esm/ThemeProvider/ThemeProvider.js:42:5) at Provider (webpack-internal:///./node_modules/react-redux/es/components/Provider.js:16:3) at App

Consider adding an error boundary to your tree to customize error handling behavior.
Visit https://reactjs.org/link/error-boundaries to learn more about error boundaries.", source: webpack-internal:///./node_modules/react-dom/cjs/react-dom.development.js (18687)
[14660:1102/075437.994:INFO:CONSOLE(12056)] "Uncaught TypeError: Cannot read properties of undefined (reading 'zowe')", source: webpack-internal:///./node_modules/react-dom/cjs/react-dom.development.js (12056)
`

This is achieved by running through the steps naturally,
and at Step 6 it's run-time TS error. Whatever the cause of the error, it's safer to do something like:

const verifyCertsConfig: any = (getZoweConfig()?.zowe)?.verifyCertificates;

Lmk if you need help replicating the run-time error!

Signed-off-by: Timothy Gerstel <[email protected]>

…ertificateStage Signed-off-by: Timothy Gerstel <[email protected]>

…to enhancement/certificateStage Signed-off-by: Timothy Gerstel <[email protected]>

…ertificateStage Signed-off-by: Timothy Gerstel <[email protected]>

Signed-off-by: Timothy Gerstel <[email protected]>

…te stage Signed-off-by: Timothy Gerstel <[email protected]>

Signed-off-by: Timothy Gerstel <[email protected]>

DivergentEuropeans · 2024-01-22T13:44:38Z

src/services/ConfigService.ts

@@ -37,6 +37,28 @@ export const setConfiguration = (section: string, data: any, setZconfig?: boolea
  }
 }

+export const setTopLevelZConfig = (section: string, data: any) => {


Doesn't this now code duplicate with ?
setConfiguration = (section: string, data: any, setZconfig?: TRUE) => {

This actually already exists on staging so that needs to be removed from this PR anyway:
https://github.com/zowe/zen/blob/v2.x/staging/src/services/ConfigService.ts#L64

You are correct that there was 100% a better way to implement the needed functionality from the original function, but this one updates any level of the yaml instead of just zowe.setup. I should have just made the original update any section of the yaml, then updated the existing references I suppose. This must have been a bad time saving hack i though was appropriate at the time. Should be refactored.

timgerstel added 20 commits October 26, 2023 11:58

Script to submit zwe init certificates

08b8894

Signed-off-by: Timothy Gerstel <[email protected]>

IPC handler to initiate zwe init certificates

a9c5090

Signed-off-by: Timothy Gerstel <[email protected]>

InstallAction to run zwe init certificates

b033050

Signed-off-by: Timothy Gerstel <[email protected]>

Enhance certificates page to include zowe.verifyCertificates. TODO: r…

b19d6a5

…efactor and implement form change handler Signed-off-by: Timothy Gerstel <[email protected]>

ipc handler for zwe init certificaets button

e4b5cd0

Signed-off-by: Timothy Gerstel <[email protected]>

zowe.verifyCertificates now updates properly in YAML and on UI

e875bcf

Signed-off-by: Timothy Gerstel <[email protected]>

Add function to set top level config items

54d1296

Signed-off-by: Timothy Gerstel <[email protected]>

Upload yaml after generation

2a76e94

Signed-off-by: Timothy Gerstel <[email protected]>

Use new configService to acquire latest yaml data from forms before r…

450cd0a

…unning zwe init certificates Signed-off-by: Timothy Gerstel <[email protected]>

Refactor handleVerifyCertsChange to set form state, log errors proper…

65b378b

…ly and remove console logs Signed-off-by: Timothy Gerstel <[email protected]>

Re-add button to run 'zwe init certificates'

488c558

Signed-off-by: Timothy Gerstel <[email protected]>

VSCode autofilled the wrong import path, sensational

6850b58

Signed-off-by: Timothy Gerstel <[email protected]>

Fix import path (thank you vs code)

9999bb9

Signed-off-by: Timothy Gerstel <[email protected]>

Add preventDefault to button click

04b82b2

Signed-off-by: Timothy Gerstel <[email protected]>

Add zoweConfig parameter to pass latest config to IPC handler

d063637

Signed-off-by: Timothy Gerstel <[email protected]>

Upload latest zowe config for command submission. Should probably dep…

34acc5e

…recate ConfigurationStore somehow Signed-off-by: Timothy Gerstel <[email protected]>

Pass zowe config to ipc hook

b706947

Signed-off-by: Timothy Gerstel <[email protected]>

Revise console warning

1ca75d9

Signed-off-by: Timothy Gerstel <[email protected]>

Merge remote-tracking branch 'origin/v2.x/staging' into enhancement/c…

a0c8d4d

…ertificateStage Signed-off-by: Timothy Gerstel <[email protected]>

Fix typo in zwe command

80be2c9

Signed-off-by: Timothy Gerstel <[email protected]>

timgerstel changed the title ~~[WIP] DO NOT MERGE - Enhancement/certificate stage~~ Add verifyCertificates option and 'Run zwe init certificates' button to Certificate Stage Oct 29, 2023

timgerstel requested review from sakshibobade21, DivergentEuropeans and 1000TurquoisePogs October 29, 2023 21:50

timgerstel added 6 commits October 29, 2023 18:06

Add certificate progress

10e659b

Signed-off-by: Timothy Gerstel <[email protected]>

Add UI for certificate init pgoress

abbc824

Signed-off-by: Timothy Gerstel <[email protected]>

Update scroll into view call

fee5b05

Signed-off-by: Timothy Gerstel <[email protected]>

Fix typo in getCertificateProgress

ec51bcb

Signed-off-by: Timothy Gerstel <[email protected]>

Rename function

c8afa2d

Signed-off-by: Timothy Gerstel <[email protected]>

Update progress store at each stage

99c0cdc

Signed-off-by: Timothy Gerstel <[email protected]>

1000TurquoisePogs requested changes Oct 30, 2023

View reviewed changes

timgerstel and others added 3 commits October 30, 2023 09:11

Revert planning.tsx

0c4181d

Signed-off-by: Timothy Gerstel <[email protected]>

Remove redundant import

4f4c318

Signed-off-by: Timothy Gerstel <[email protected]>

Merge branch 'v2.x/staging' into enhancement/certificateStage

45cc2af

DivergentEuropeans requested changes Nov 2, 2023

View reviewed changes

timgerstel added 12 commits November 6, 2023 09:16

Renamed ipc main function

d23e6d6

Signed-off-by: Timothy Gerstel <[email protected]>

Merge remote-tracking branch 'origin/v2.x/staging' into enhancement/c…

9d6733b

…ertificateStage Signed-off-by: Timothy Gerstel <[email protected]>

Merge branch 'enhancement/certificateStage' of github.com:zowe/zen in…

29f065d

…to enhancement/certificateStage Signed-off-by: Timothy Gerstel <[email protected]>

Merge remote-tracking branch 'origin/v2.x/staging' into enhancement/c…

3820511

…ertificateStage Signed-off-by: Timothy Gerstel <[email protected]>

Merge branch 'v2.x/staging' into enhancement/certificateStage

c64d460

Signed-off-by: Timothy Gerstel <[email protected]>

Merge branch 'v2.x/staging' into enhancement/certificateStage

78a4ab7

Signed-off-by: Timothy Gerstel <[email protected]>

Fix button styling on init apf auth stage. Fix YAML sync in certifica…

aab7a88

…te stage Signed-off-by: Timothy Gerstel <[email protected]>

Add --update-config flag to init certficate

b752cfd

Signed-off-by: Timothy Gerstel <[email protected]>

Merge branch 'v2.x/staging' into enhancement/certificateStage

2372a99

Make wording consistent between buttons which perform zwe init actions

bcc75f8

Signed-off-by: Timothy Gerstel <[email protected]>

Merge branch 'v2.x/staging' into enhancement/certificateStage

5a22bd0

Merge branch 'v2.x/staging' into enhancement/certificateStage

c2a122c

DivergentEuropeans reviewed Jan 22, 2024

View reviewed changes

timgerstel mentioned this pull request Jan 30, 2024

Remove ConfigService.ts, Enahance Certifcate Stage #114

Merged

14 tasks

DivergentEuropeans merged commit 59ec2a9 into v2.x/staging Mar 8, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add verifyCertificates option and 'Run zwe init certificates' button to Certificate Stage #79

Add verifyCertificates option and 'Run zwe init certificates' button to Certificate Stage #79

timgerstel commented Oct 28, 2023 •

edited

Loading

1000TurquoisePogs Oct 30, 2023

timgerstel Oct 30, 2023

1000TurquoisePogs Nov 13, 2023 •

edited

Loading

1000TurquoisePogs Oct 30, 2023

timgerstel Oct 30, 2023

DivergentEuropeans Nov 1, 2023

DivergentEuropeans Nov 2, 2023

DivergentEuropeans Nov 2, 2023

DivergentEuropeans Jan 22, 2024

timgerstel Jan 23, 2024

		const setupSchema = schema ? schema.properties.zowe.properties.setup.properties.certificate : "";
		const verifyCertsSchema = schema ? {"type": "object", "properties": {"verifyCertificates": schema.properties.zowe.properties.verifyCertificates}} : "";

Add verifyCertificates option and 'Run zwe init certificates' button to Certificate Stage #79

Add verifyCertificates option and 'Run zwe init certificates' button to Certificate Stage #79

Conversation

timgerstel commented Oct 28, 2023 • edited Loading

Proposed changes

Type of change

PR Checklist

Testing

Further comments

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1000TurquoisePogs Nov 13, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timgerstel commented Oct 28, 2023 •

edited

Loading

1000TurquoisePogs Nov 13, 2023 •

edited

Loading