Spring/spring-tools
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add tests and hovers for docker-image source attributes.

Browse Source
This commit is contained in:
Kris De Volder
2017-01-22 11:35:29 -08:00
parent 5087c8a647
commit fa6ab481d0
12 changed files with 181 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
vscode-extensions/vscode-concourse/src/main/java/org/springframework/ide/vscode/concourse/PipelineYmlSchema.java
View File

@@ -264,13 +264,16 @@ public class PipelineYmlSchema implements YamlSchema {
addProp(source, "aws_access_key_id", t_ne_string);
addProp(source, "aws_secret_access_key", t_ne_string);
addProp(source, "insecure_registries", t_strings);
addProp(source, "registry_mirror", t_strings);
YBeanType t_cert_entry = f.ybean("DomainAndCert",
addProp(source, "registry_mirror", t_ne_string);
addProp(source, "ca_certs", f.yseq(f.ybean("CaCertsEntry",
f.yprop("domain", t_ne_string),
f.yprop("cert", t_ne_string)
);
addProp(source, "ca_certs", f.yseq(t_cert_entry));
addProp(source, "client_certs", f.yseq(t_cert_entry));
)));
addProp(source, "client_certs", f.yseq(f.ybean("ClientCertsEntry",
f.yprop("domain", t_ne_string),
f.yprop("key", t_ne_string),
f.yprop("cert", t_ne_string)
)));
YBeanType get = f.ybean("DockerImageGetParams");
addProp(get, "save", t_boolean);

2
vscode-extensions/vscode-concourse/src/main/resources/desc/DockerImageSource/aws_access_key_id.md Normal file
View File

@@ -0,0 +1,2 @@
*Optional.* AWS access key to use for acquiring ECR
credentials.

2
vscode-extensions/vscode-concourse/src/main/resources/desc/DockerImageSource/aws_secret_access_key.md Normal file
View File

@@ -0,0 +1,2 @@
*Optional.* AWS secret key to use for acquiring ECR
credentials.

25
vscode-extensions/vscode-concourse/src/main/resources/desc/DockerImageSource/ca_certs.md Normal file
View File

@@ -0,0 +1,25 @@
*Optional.* An array of objects with the following format:
```yaml
ca_certs:
- domain: example.com:443
cert: |
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
- domain: 10.244.6.2:443
cert: |
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
```
Each entry specifies the x509 CA certificate for the trusted docker registry
residing at the specified domain. This is used to validate the certificate of
the docker registry when the registry's certificate is signed by a custom
authority (or itself).
The domain should match the first component of `repository`, including the
port. If the registry specified in `repository` does not use a custom cert,
adding `ca_certs` will break the check script. This option is overridden by
entries in `insecure_registries` with the same address or a matching CIDR.

27
vscode-extensions/vscode-concourse/src/main/resources/desc/DockerImageSource/client_certs.md Normal file
View File

@@ -0,0 +1,27 @@
*Optional.* An array of objects with the following format:
```yaml
client_certs:
- domain: example.com:443
cert: |
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
key: |
-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA PRIVATE KEY-----
- domain: 10.244.6.2:443
cert: |
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
key: |
-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA PRIVATE KEY-----
```
Each entry specifies the x509 certificate and key to use for authenticating
against the docker registry residing at the specified domain. The domain
should match the first component of `repository`, including the port.

3
vscode-extensions/vscode-concourse/src/main/resources/desc/DockerImageSource/insecure_registries.md Normal file
View File

@@ -0,0 +1,3 @@
*Optional.* An array of CIDRs or `host:port` addresses
to whitelist for insecure access (either `http` or unverified `https`).
This option overrides any entries in `ca_certs` with the same address.

1
vscode-extensions/vscode-concourse/src/main/resources/desc/DockerImageSource/password.md Normal file
View File

@@ -0,0 +1 @@
*Optional.* The password to use when authenticating.

1
vscode-extensions/vscode-concourse/src/main/resources/desc/DockerImageSource/registry_mirror.md Normal file
View File

@@ -0,0 +1 @@
*Optional.* A URL pointing to a docker registry mirror service.

2
vscode-extensions/vscode-concourse/src/main/resources/desc/DockerImageSource/repository.md Normal file
View File

@@ -0,0 +1,2 @@
*Required.* The name of the repository, e.g.
`concourse/docker-image-resource`.

1
vscode-extensions/vscode-concourse/src/main/resources/desc/DockerImageSource/tag.md Normal file
View File

@@ -0,0 +1 @@
*Optional.* The tag to track. Defaults to `latest`.

1
vscode-extensions/vscode-concourse/src/main/resources/desc/DockerImageSource/username.md Normal file
View File

@@ -0,0 +1 @@
*Optional.* The username to authenticate with when pushing.

108
vscode-extensions/vscode-concourse/src/test/java/org/springframework/ide/vscode/concourse/PipelineYamlEditorTest.java
View File

@@ -1122,6 +1122,114 @@ public class PipelineYamlEditorTest {
editor.assertProblems("jobs: []|'name' is required");
}
@Test public void dockerImageResourceSourceReconcile() throws Exception {
Editor editor;
editor = harness.newEditor(
"resources:\n" +
"- name: my-docker-image\n" +
" type: docker-image\n" +
" source:\n" +
" tag: latest\n"
);
editor.assertProblems("tag: latest|'repository' is required");
editor = harness.newEditor(
"resources:\n" +
"- name: my-docker-image\n" +
" type: docker-image\n" +
" source:\n" +
" repository: kdvolder/sts4-build-env\n" +
" tag: latest\n" +
" username: kdvolder\n" +
" password: {{docker_password}}\n" +
" aws_access_key_id: {{aws_access_key}}\n" +
" aws_secret_access_key: {{aws_secret_key}}\n" +
" insecure_registries: no-list\n" +
" registry_mirror: https://my-docker-registry.com\n" +
" ca_certs:\n" +
" - domain: example.com:443\n" +
" cert: |\n" +
" -----BEGIN CERTIFICATE-----\n" +
" ...\n" +
" -----END CERTIFICATE-----\n" +
" bogus_ca_certs_prop: bad\n" +
" client_certs:\n" +
" - domain: example.com:443\n" +
" cert: |\n" +
" -----BEGIN CERTIFICATE-----\n" +
" ...\n" +
" -----END CERTIFICATE-----\n" +
" key: |\n" +
" -----BEGIN RSA PRIVATE KEY-----\n" +
" ...\n" +
" -----END RSA PRIVATE KEY-----\n" +
" bogus_client_cert_prop: bad\n"
);
editor.assertProblems(
"no-list|Expecting a 'Sequence'",
"bogus_ca_certs_prop|Unknown property", //ca_certs
"bogus_client_cert_prop|Unknown property" //client_certs
);
}
@Test public void dockerImageResourceSourceHovers() throws Exception {
Editor editor;
editor = harness.newEditor(
"resources:\n" +
"- name: my-docker-image\n" +
" type: docker-image\n" +
" source:\n" +
" tag: latest\n"
);
editor.assertProblems("tag: latest|'repository' is required");
editor = harness.newEditor(
"resources:\n" +
"- name: my-docker-image\n" +
" type: docker-image\n" +
" source:\n" +
" repository: kdvolder/sts4-build-env\n" +
" tag: latest\n" +
" username: kdvolder\n" +
" password: {{docker_password}}\n" +
" aws_access_key_id: {{aws_access_key}}\n" +
" aws_secret_access_key: {{aws_secret_key}}\n" +
" insecure_registries: no-list\n" +
" registry_mirror: https://my-docker-registry.com\n" +
" ca_certs:\n" +
" - domain: example.com:443\n" +
" cert: |\n" +
" -----BEGIN CERTIFICATE-----\n" +
" ...\n" +
" -----END CERTIFICATE-----\n" +
" bogus_ca_certs_prop: bad\n" +
" client_certs:\n" +
" - domain: example.com:443\n" +
" cert: |\n" +
" -----BEGIN CERTIFICATE-----\n" +
" ...\n" +
" -----END CERTIFICATE-----\n" +
" key: |\n" +
" -----BEGIN RSA PRIVATE KEY-----\n" +
" ...\n" +
" -----END RSA PRIVATE KEY-----\n" +
" bogus_client_cert_prop: bad\n"
);
editor.assertHoverContains("repository", "The name of the repository");
editor.assertHoverContains("tag", "The tag to track");
editor.assertHoverContains("username", "username to authenticate");
editor.assertHoverContains("password", "password to use");
editor.assertHoverContains("aws_access_key_id", "AWS access key to use");
editor.assertHoverContains("aws_secret_access_key", "AWS secret key to use");
editor.assertHoverContains("insecure_registries", "array of CIDRs");
editor.assertHoverContains("registry_mirror", "URL pointing to a docker registry");
editor.assertHoverContains("ca_certs", "Each entry specifies the x509 CA certificate for");
editor.assertHoverContains("client_certs", "Each entry specifies the x509 certificate and key");
}
//////////////////////////////////////////////////////////////////////////////
private void assertContextualCompletions(String conText, String textBefore, String... textAfter) throws Exception {