1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
/*
* ============LICENSE_START=======================================================
* SDC-HELM-VALIDATOR
* ================================================================================
* Copyright (C) 2021 Nokia. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END=========================================================
*/
package org.onap.sdc.helmvalidator.api;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.ExampleObject;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.parameters.RequestBody;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.onap.sdc.helmvalidator.config.docs.ValidationRequestParameters;
import org.onap.sdc.helmvalidator.errorhandling.ValidationErrorResponse;
import org.onap.sdc.helmvalidator.helm.validation.ValidationService;
import org.onap.sdc.helmvalidator.helm.validation.model.ValidationResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
@RestController
@Tag(name = "ValidationService")
public class ValidationController {
private static final Logger LOGGER = LoggerFactory.getLogger(ValidationController.class);
private final ValidationService validationService;
@Autowired
public ValidationController(ValidationService validationService) {
this.validationService = validationService;
}
/**
* Validates Helm chart.
*
* @param version requested version of Helm client to be used
* @param file packaged Helm chart file
* @param isLinted flag deciding if chart should be linted
* @param isStrictLinted flag deciding if chart should be linted with strict option turned on
* @return Response with result of validation
*/
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Helm chart successfully validated",
content = {
@Content(
schema = @Schema(implementation = ValidationResult.class),
examples = {
@ExampleObject(ref = "#/components/examples/simpleValidation", name = "Simple Validation"),
@ExampleObject(ref = "#/components/examples/validationWithLint", name = "Lint Validation")
})}),
@ApiResponse(responseCode = "400", description = "Chart cannot be validated using selected version",
content = @Content(schema = @Schema(implementation = ValidationErrorResponse.class))),
@ApiResponse(responseCode = "500", description = "Something went wrong during validation execution",
content = @Content(schema = @Schema(implementation = ValidationErrorResponse.class)))
})
@Operation(
summary = "Validate chart",
description = "Web endpoint for Helm charts validation. Helm chart in .tgz format is required.",
tags = "ValidationService",
requestBody = @RequestBody(
required = true,
content = @Content(mediaType = MediaType.MULTIPART_FORM_DATA_VALUE,
schema = @Schema(implementation = ValidationRequestParameters.class)
)
)
)
@PostMapping(value = "/validate", produces = "application/json", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
public ResponseEntity<ValidationResult> validate(
@Parameter(hidden = true)
@RequestParam(value = "versionDesired", required = false) String version,
@Parameter(description = "Helm chart that should be validated (packed in .tgz format)", required = true)
@RequestParam MultipartFile file,
@Parameter(hidden = true)
@RequestParam(value = "isLinted", required = false, defaultValue = "false") boolean isLinted,
@Parameter(hidden = true)
@RequestParam(value = "isStrictLinted", required = false, defaultValue = "false") boolean isStrictLinted) {
LOGGER.debug("Received file: {}, size: {}, helm version: {}",
file.getOriginalFilename(), file.getSize(), version);
ValidationResult result = validationService
.process(version, file, isLinted, isStrictLinted);
return new ResponseEntity<>(result, HttpStatus.OK);
}
}
|
