Update Concourse registry-image schema

[LukeBalizet]

Update Concourse registry-image resource schema to match concourse/registry-image-resource

Sources:

• Source Configuration
• get Step params
• put Steps params

[kdvolder]

Thanks a lot for the PR. Indeed it looks like 'registry-image' resource schema is in need of some TLC and has fallen a bit behind on recent (or even not so recent :-) changes.

I took a quick peek at the PR and it looks good on the surface. However besides changes to the schema we also need a few other things:

• markdown snippets documentation snippets for all the new properties (these show up when hovering a property).
• new test cases for the added functionality
• ensure any breaking test cases amongst old cases are fixed. (Test cases break because some added schema elements may show up 'unexpectedly' in existing test cases. So the tests just need updating so they accept this new output as 'expected' instead of failing with an error.

For some examples of existing markdown snippets see here:

• https://github.com/spring-projects/sts4/tree/main/headless-services/concourse-language-server/src/main/resources/desc/RegistryImageSource

For the test cases... usually for every new property added we try to ensure that it is covered by two test at least:

• one case uses the property in a source code snippet and this validates that the editor understands the property is part of the schema (so doesn't give a 'unknown property' warning'). Usually this test case also tries to validate the schema expresses the correct type information (e.g. if we expect a 'boolean' then we can put something like 'not-a-bool' in the sample and we'd expect it should be flagged as an error with some message like 'expecting a booleam'.
• one case checks that the new property has a 'meaningful' hover doc (the check usually consists of looking for some text snippet we expect in a 'meaningful' explanation to be a substring of the actual hover text.

For some examples of these kinds of test cases you can look here:

• sample of 'schema test case' that might be extended to cover additional properties:
  https://github.com/spring-projects/sts4/blob/main/headless-services/concourse-language-server/src/test/java/org/springframework/ide/vscode/concourse/ConcourseEditorTest.java#L1587
• sample of hover test case:
• sample of test case that combines both: https://github.com/spring-projects/sts4/blob/main/headless-services/concourse-language-server/src/test/java/org/springframework/ide/vscode/concourse/ConcourseEditorTest.java#L2593

Another possible test case to add would be to check for expected completions are working. This is not mandatory. If the schema validation works, then there is little doubdt that the property is part of the schema and so completions will work (this sort of thing is covered adequately by other test cases).

• https://github.com/spring-projects/sts4/blob/main/headless-services/concourse-language-server/src/test/java/org/springframework/ide/vscode/concourse/ConcourseEditorTest.java#L2235

A tip for finding a good place to work in new properties in the test cases. Choose a property that existed before in a 'similar' location of the schema. Use text search to search it in the source code of the repo. You will find some occurrences inside the ConcourseEditorTest class. This is usually a good place to extend the tests and cover additional / similar properties.

[kdvolder]

A tip for running the tests:

• it is run as part of the cli build. You can simply execute the 'build.sh' script in https://github.com/spring-projects/sts4/blob/main/headless-services/concourse-language-server/build.sh
• If you use Eclipse, you can right-click on the concourse-language-server project in your workpsace and select 'Run As >> JUnit test'. Eclipse will find all the test cases in the project and run them.
• If you use another IDE... I don't know, but you probably do :-)

[kdvolder]

Before merging I would like to see some test cases added and the missing markdown snippets for the newly added properties. I've added more detailed explanation about this in the main PR discussion thread.

[kdvolder]

@LukeBalizet This is probably a lot of work or you. If you want to do it, that is great! But if not, I can take it over from you and do the required polishing (test cases, markdown snippets etc).

What would you prefer? Do you want to do the test cases and hover snippets, or shall I take it over?

Either one is fine by me and I don't want to take this from you if you are really eager to contribute these fixes. Just let me know. I may actually have some time tomorrow to look at this.

[LukeBalizet]

@kdvolder, yeah it might be better for you to take over 😅 I added the markdown snippets yesterday, but feel free to change them in any way. Thank you for all the work!

[kdvolder]

it might be better for you to take over

Sure, will do! Thanks for the PR and taking it this far. You already went 'the extra mile' to do part of the work. Most people just raise a ticket without any PR at all.

[kdvolder]

I'm following up in this branch: https://github.com/spring-projects/sts4/tree/LukeBalizet-update-registry-image-schema

[kdvolder]

It is merged with a few little problems fixed. Extra test cases, and a few 'enhancements'. E.g. added an emum for the 'AWSRegion' instead of leaving it just a string.

You can try out snapshot

• https://s3-us-west-1.amazonaws.com/s3-test.spring.io/sts4/vscode-extensions/snapshots/vscode-concourse-1.34.0-202206021955.vsix