Manage custom C4iDebugService.env file to store Debug Service configuration

[sebjulliand]

Changes

Resolves #2416

Applying Debug Service's PTF resets the /QIBM/ProdData/IBMiDebugService folder, including the DebugService.env holding Code for IBM i debug service config changes.

Since Debug Service 2.0.1, it is possible to use a custom .env file the start script will load when starting the debug service.
To take advantage of this, Code for IBM i will create a copy of the /QIBM/ProdData/IBMiDebugService/bin/DebugService.env into /QIBM/UserData/IBMiDebugService/C4iDebugService.env when connecting to a system, if C4iDebugService.env doesn't exist.
/QIBM/ProdData/IBMiDebugService/bin/DebugService.env won't me changed anymore and only C4iDebugService.env will be updated and used by Code for IBM i.

Starting the Debug Service >= 2.0.1 will set the DEBUG_SERVICE_EXTERNAL_CONFIG_FILE env variable before running the start script.
When starting the Debug Service < 2.0.1, /QIBM/UserData/IBMiDebugService/C4iDebugService.env is copied and overwrites /QIBM/ProdData/IBMiDebugService/bin/DebugService.env (to mimic v 2.0.1 behavior).

How to test this PR

1. Connect
2. Check file /QIBM/UserData/IBMiDebugService/C4iDebugService.env has been created and is a copy of /QIBM/ProdData/IBMiDebugService/bin/DebugService.env
3. Start the Debug Service

Checklist

• have tested my change

[github-actions]

👋 A new build is available for this PR based on 54c159d.

• Download here.
• Read more about how to test

[chrjorgensen]

@sebjulliand The code changes worked on my systems running IBM i 7.5 and 7.3 with Debug Service 2.0.1 installed.

When I tested on my IBM i 7.4 system, I got the dreaded "self-signed certificate" error - and am currently struggling to fix this...

Looked good until this happened, though - but would like to have others (@worksofliam ? @Wright4i ?) test as well...

[chrjorgensen]

@sebjulliand

Bad news - although my testing on IBM i 7.5 yesterday was succesful, the test fails today. I'm no longer able to start the debug service on IBM i... 😢

I tried to reset everything by

• stop the debug service and debug server on IBM i
• close VS Code
• clear directory /QIBM/UserData/IBMIDEBUGSERVICE on IBM i
• remove the certificate C:\Users\%UserID%\%HOSTNAME%_debug_service.crt on my PC
• start VS Code
• connect and reload server settings
• create the debug certificates on request
• start the debug server
• start the debug service

I get the following error:

It did work yeaterday - only change I can see is that the IBM i Debug extension has been updated from v2.0.1 to v2.0.2...

😭

[chrjorgensen]

@sebjulliand Good news: I found the issue and it was not your code - of course! 😃

I had created the debug certificate on the installed C4i extension version 2.14.5 - not using the master branch of the code! 😢 When I instead used the master branch to create the certificates, it all worked - also on my IBM i 7.4 system! 😃

I did some additional testing, checking the use and copying of /QIBM/UserData/IBMIDEBUGSERVICE/C4iDebugService.env, and everything is fine. So I will approve this PR. 👏

Since there seems to be some incompatibilities with the current prerelease version of C4i and Debug service 2.0.1, I will create a new prerelease incorporating this PR as well.