-
Notifications
You must be signed in to change notification settings - Fork 56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
2. Add abstractions for MetadataProfile #1440
Open
shreyabiradar07
wants to merge
3
commits into
kruize:mvp_demo
Choose a base branch
from
shreyabiradar07:metadata-profile-abstractions
base: mvp_demo
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
103 changes: 103 additions & 0 deletions
103
src/main/java/com/autotune/analyzer/metadataProfiles/MetadataProfile.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2024, 2024 Red Hat, IBM Corporation and others. | ||
| * | ||
| * 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. | ||
| *******************************************************************************/ | ||
| package com.autotune.analyzer.metadataProfiles; | ||
|
|
||
| import com.autotune.common.data.metrics.Metric; | ||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import com.google.gson.annotations.SerializedName; | ||
|
|
||
| import java.util.ArrayList; | ||
|
|
||
| /** | ||
| * Container class for the MetadataProfile kubernetes kind, which is used to define | ||
| * a metadata queries | ||
| * | ||
| * This class provides a direct representation of MetadataProfile CRD in JSON format, | ||
| * corresponding to the structure of MetadataProfile YAML file. It includes mandatory fields | ||
| * for API version, kind, metadata and additional custom fields - profile_version, k8s_type and query_variables | ||
| */ | ||
|
|
||
| public class MetadataProfile { | ||
| private String apiVersion; | ||
|
|
||
| private String kind; | ||
|
|
||
| private JsonNode metadata; | ||
|
|
||
| private String name; | ||
|
|
||
| private double profile_version; | ||
|
|
||
| @SerializedName("k8s_type") | ||
| private String k8s_type; | ||
|
|
||
| @SerializedName("query_variables") | ||
| private ArrayList<Metric> metrics; | ||
|
|
||
| public MetadataProfile(String apiVersion, String kind, JsonNode metadata, | ||
| double profile_version, String k8s_type, ArrayList<Metric> metrics) { | ||
|
|
||
| this.apiVersion = apiVersion; | ||
| this.kind = kind; | ||
| this.metadata = metadata; | ||
| this.name = metadata.get("name").asText(); | ||
| this.profile_version = profile_version; | ||
| this.k8s_type = k8s_type; | ||
| this.metrics = metrics; | ||
| } | ||
|
|
||
| public String getApiVersion() { | ||
| return apiVersion; | ||
| } | ||
|
|
||
| public String getKind() { | ||
| return kind; | ||
| } | ||
|
|
||
| public JsonNode getMetadata() { | ||
| return metadata; | ||
| } | ||
|
|
||
| public String getName() { | ||
| return name; | ||
| } | ||
|
|
||
| public double getProfile_version() { | ||
| return profile_version; | ||
| } | ||
|
|
||
| public String getK8s_type() { | ||
| return k8s_type; | ||
| } | ||
|
|
||
| public ArrayList<Metric> getQueryVariables() { | ||
| return new ArrayList<>(metrics); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return "MetadataProfile{" + | ||
| "apiVersion='" + apiVersion + '\'' + | ||
| ", kind='" + kind + '\'' + | ||
| ", metadata=" + metadata + | ||
| ", name='" + name + '\'' + | ||
| ", profile_version=" + profile_version + | ||
| ", k8s_type='" + k8s_type + '\'' + | ||
| ", query_variables=" + metrics + | ||
| '}'; | ||
| } | ||
|
|
||
| } |
263 changes: 263 additions & 0 deletions
263
src/main/java/com/autotune/analyzer/metadataProfiles/MetadataProfileValidation.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,263 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2024, 2024 Red Hat, IBM Corporation and others. | ||
| * | ||
| * 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. | ||
| *******************************************************************************/ | ||
| package com.autotune.analyzer.metadataProfiles; | ||
|
|
||
| import com.autotune.analyzer.utils.AnalyzerConstants; | ||
| import com.autotune.analyzer.utils.AnalyzerErrorConstants; | ||
| import com.autotune.common.data.ValidationOutputData; | ||
| import com.autotune.common.data.metrics.Metric; | ||
| import com.autotune.utils.KruizeConstants; | ||
| import com.autotune.utils.KruizeSupportedTypes; | ||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import javax.servlet.http.HttpServletResponse; | ||
| import java.lang.reflect.InvocationTargetException; | ||
| import java.lang.reflect.Method; | ||
| import java.util.ArrayList; | ||
| import java.util.Arrays; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * This class validates MetadataProfile fields and object | ||
| */ | ||
| public class MetadataProfileValidation { | ||
| private static final Logger LOGGER = LoggerFactory.getLogger(MetadataProfileValidation.class); | ||
| private boolean success; | ||
| private String errorMessage; | ||
| private final Map<String, MetadataProfile> metadataProfilesMap; | ||
|
|
||
| //Mandatory fields for MetadataProfile | ||
| private final List<String> mandatoryMetadataFields = new ArrayList<>(Arrays.asList( | ||
| AnalyzerConstants.API_VERSION, | ||
| AnalyzerConstants.KIND, | ||
| AnalyzerConstants.AutotuneObjectConstants.METADATA, | ||
| AnalyzerConstants.AutotuneObjectConstants.DATASOURCE, | ||
| AnalyzerConstants.MetadataProfileConstants.QUERY_VARIABLES | ||
| )); | ||
|
|
||
| private final List<String> mandatoryQueryVariables = new ArrayList<>(Arrays.asList( | ||
| AnalyzerConstants.AutotuneObjectConstants.NAME, | ||
| AnalyzerConstants.MetadataProfileConstants.VALUE_TYPE | ||
| )); | ||
|
|
||
| public MetadataProfileValidation(Map<String, MetadataProfile> metadataProfilesMap) { | ||
| this.metadataProfilesMap = metadataProfilesMap; | ||
| } | ||
|
|
||
| /** | ||
| * Validates query variables | ||
| * | ||
| * @param metadataProfile Metadata Profile Object to be validated | ||
| * @return Returns the ValidationOutputData containing the response based on the validation | ||
| */ | ||
| public ValidationOutputData validate(MetadataProfile metadataProfile) { | ||
|
|
||
| return validateMetadataProfileData(metadataProfile); | ||
| } | ||
|
|
||
| /** | ||
| * Validates the data present in the metadata profile object before adding it to the map | ||
| * @param metadataProfile Metadata Profile Object to be validated | ||
| * @return Returns the ValidationOutputData containing the response based on the validation | ||
| */ | ||
| private ValidationOutputData validateMetadataProfileData(MetadataProfile metadataProfile) { | ||
| ValidationOutputData validationOutputData = new ValidationOutputData(false, null, null); | ||
| StringBuilder errorString = new StringBuilder(); | ||
| try { | ||
| // validate the mandatory values first | ||
| validationOutputData = validateMandatoryMetadataProfileFieldsAndData(metadataProfile); | ||
|
|
||
| // If the mandatory values are present,proceed for further validation else return the validation object directly | ||
| if (validationOutputData.isSuccess()) { | ||
| // TODO: Loading saved metadata profiles from DB | ||
|
|
||
| // Check if profile metadata exists | ||
| JsonNode metadata = metadataProfile.getMetadata(); | ||
| if (null == metadata) { | ||
| errorString.append(AnalyzerErrorConstants.AutotuneObjectErrors.MISSING_METADATA_PROFILE_METADATA); | ||
| } | ||
| // check if the metadata profile already exists | ||
| if (null != metadataProfilesMap.get(metadataProfile.getMetadata().get(KruizeConstants.JSONKeys.NAME).asText())) { | ||
| errorString.append(AnalyzerErrorConstants.AutotuneObjectErrors.DUPLICATE_METADATA_PROFILE).append(metadataProfile.getMetadata().get(KruizeConstants.JSONKeys.NAME).asText()); | ||
| return new ValidationOutputData(false, errorString.toString(), HttpServletResponse.SC_CONFLICT); | ||
| } | ||
|
|
||
| // Validates fields like k8s_type and slo object | ||
| validateCommonProfileFields(metadataProfile, errorString, validationOutputData); | ||
|
|
||
| if (!errorString.toString().isEmpty()) { | ||
| validationOutputData.setSuccess(false); | ||
| validationOutputData.setMessage(errorString.toString()); | ||
| validationOutputData.setErrorCode(HttpServletResponse.SC_BAD_REQUEST); | ||
| } else { | ||
| validationOutputData.setSuccess(true); | ||
| } | ||
| } | ||
| } catch (Exception e){ | ||
| validationOutputData.setSuccess(false); | ||
| validationOutputData.setMessage(errorString.toString()); | ||
| validationOutputData.setErrorCode(HttpServletResponse.SC_INTERNAL_SERVER_ERROR); | ||
| } | ||
| return validationOutputData; | ||
| } | ||
|
|
||
| /** | ||
| * Check if all mandatory values are present. | ||
| * | ||
| * @param metadataObj Mandatory fields of this Metadata Profile Object will be validated | ||
| * @return ValidationOutputData object containing status of the validations | ||
| */ | ||
| public ValidationOutputData validateMandatoryMetadataProfileFieldsAndData(MetadataProfile metadataObj) { | ||
| List<String> missingMandatoryFields = new ArrayList<>(); | ||
| ValidationOutputData validationOutputData = new ValidationOutputData(false, null, null); | ||
| String errorMsg; | ||
| errorMsg = ""; | ||
| mandatoryMetadataFields.forEach( | ||
| mField -> { | ||
| String methodName = "get" + mField.substring(0, 1).toUpperCase() + mField.substring(1); | ||
| try { | ||
| LOGGER.debug(AnalyzerConstants.CommonProfileMsgs.METHOD_NAME,methodName); | ||
| Method getNameMethod = metadataObj.getClass().getMethod(methodName); | ||
| if (null == getNameMethod.invoke(metadataObj) || getNameMethod.invoke(metadataObj).toString().isEmpty()) | ||
| missingMandatoryFields.add(mField); | ||
| } catch (NoSuchMethodException | IllegalAccessException | InvocationTargetException e) { | ||
| LOGGER.error(AnalyzerConstants.CommonProfileMsgs.INVALID_METHOD_NAME, mField); | ||
| } | ||
| } | ||
| ); | ||
| if (missingMandatoryFields.isEmpty()) { | ||
| try { | ||
| String mandatoryMetadataPerf = AnalyzerConstants.MetadataProfileConstants.METADATA_PROFILE_NAME; | ||
| try { | ||
| JsonNode metadata = metadataObj.getMetadata(); | ||
| String metadataProfileName = metadata.get(mandatoryMetadataPerf).asText(); | ||
| if (null == metadataProfileName || metadataProfileName.isEmpty() || metadataProfileName.equals("null")) { | ||
| missingMandatoryFields.add(mandatoryMetadataPerf); | ||
| } | ||
| } catch (Exception e) { | ||
| LOGGER.error(AnalyzerConstants.CommonProfileMsgs.INVALID_METHOD_NAME, mandatoryMetadataPerf); | ||
| } | ||
|
|
||
| if (missingMandatoryFields.isEmpty()) { | ||
| mandatoryQueryVariables.forEach( | ||
| mField -> { | ||
| String methodName = "get" + mField.substring(0, 1).toUpperCase() + mField.substring(1); | ||
| try { | ||
| LOGGER.debug(AnalyzerConstants.CommonProfileMsgs.METHOD_NAME, methodName); | ||
| Method getNameMethod = metadataObj.getQueryVariables().get(0) | ||
| .getClass().getMethod(methodName); | ||
| if (getNameMethod.invoke(metadataObj.getQueryVariables().get(0)) == null) | ||
| missingMandatoryFields.add(mField); | ||
| } catch (NoSuchMethodException | IllegalAccessException | | ||
| InvocationTargetException e) { | ||
| LOGGER.error(AnalyzerConstants.CommonProfileMsgs.INVALID_METHOD_NAME, mField); | ||
| } | ||
|
|
||
| }); | ||
| validationOutputData.setSuccess(true); | ||
|
|
||
| } | ||
|
|
||
| if (!missingMandatoryFields.isEmpty()) { | ||
| errorMsg = errorMsg.concat(String.format(AnalyzerConstants.CommonProfileMsgs.MISSING_MANDATORY_PARAMETERS, missingMandatoryFields)); | ||
| validationOutputData.setSuccess(false); | ||
| validationOutputData.setMessage(errorMsg); | ||
| validationOutputData.setErrorCode(HttpServletResponse.SC_BAD_REQUEST); | ||
| LOGGER.error(AnalyzerConstants.CommonProfileMsgs.VALIDATION_ERROR_MSG, errorMsg); | ||
| } | ||
| } catch (Exception e) { | ||
| validationOutputData.setSuccess(false); | ||
| errorMsg = errorMsg.concat(e.getMessage()); | ||
| validationOutputData.setMessage(errorMsg); | ||
| validationOutputData.setErrorCode(HttpServletResponse.SC_INTERNAL_SERVER_ERROR); | ||
| } | ||
| } else { | ||
| errorMsg = errorMsg.concat(String.format(AnalyzerConstants.CommonProfileMsgs.MISSING_MANDATORY_PARAMETERS, missingMandatoryFields)); | ||
| validationOutputData.setSuccess(false); | ||
| validationOutputData.setMessage(errorMsg); | ||
| validationOutputData.setErrorCode(HttpServletResponse.SC_BAD_REQUEST); | ||
| LOGGER.error(AnalyzerConstants.CommonProfileMsgs.VALIDATION_ERROR_MSG, errorMsg); | ||
| } | ||
|
|
||
| return validationOutputData; | ||
| } | ||
|
|
||
| /** | ||
| * Validates fields like k8s_type and query_variables | ||
| * @param metadataProfile Metadata Profile object to be validated | ||
| * @param errorString StringBuilder to collect error messages during validation of multiple fields | ||
| * @param validationOutputData ValidationOutputData containing the response based on the validation | ||
| */ | ||
| private void validateCommonProfileFields(MetadataProfile metadataProfile, StringBuilder errorString, ValidationOutputData validationOutputData){ | ||
| // Check if k8s type is supported | ||
| String k8sType = metadataProfile.getK8s_type(); | ||
| if (!KruizeSupportedTypes.K8S_TYPES_SUPPORTED.contains(k8sType)) { | ||
| errorString.append(AnalyzerConstants.MetadataProfileConstants.K8S_TYPE).append(k8sType) | ||
| .append(AnalyzerErrorConstants.AutotuneObjectErrors.UNSUPPORTED); | ||
| } | ||
|
|
||
|
|
||
| // Check if query_variables is empty | ||
| if (metadataProfile.getQueryVariables().isEmpty()) | ||
| errorString.append(AnalyzerErrorConstants.AutotuneObjectErrors.QUERY_VARIABLES_EMPTY); | ||
|
|
||
|
|
||
| for (Metric queryVariable : metadataProfile.getQueryVariables()) { | ||
| // Check if datasource is supported | ||
| if (!KruizeSupportedTypes.MONITORING_AGENTS_SUPPORTED.contains(queryVariable.getDatasource().toLowerCase())) { | ||
| errorString.append(AnalyzerConstants.AutotuneObjectConstants.QUERY_VARIABLE) | ||
| .append(queryVariable.getName()) | ||
| .append(AnalyzerErrorConstants.AutotuneObjectErrors.DATASOURCE_NOT_SUPPORTED); | ||
| } | ||
|
|
||
| // Check if value_type is supported | ||
| if (!KruizeSupportedTypes.VALUE_TYPES_SUPPORTED.contains(queryVariable.getValueType().toLowerCase())) { | ||
| errorString.append(AnalyzerConstants.AutotuneObjectConstants.QUERY_VARIABLE) | ||
| .append(queryVariable.getName()) | ||
| .append(AnalyzerErrorConstants.AutotuneObjectErrors.VALUE_TYPE_NOT_SUPPORTED); | ||
| } | ||
|
|
||
| // Check if kubernetes_object type is supported, set default to 'container' if it's absent. | ||
| String kubernetes_object = queryVariable.getKubernetesObject(); | ||
| if (null == kubernetes_object) | ||
| queryVariable.setKubernetesObject(KruizeConstants.JSONKeys.CONTAINER); | ||
| else { | ||
| if (!KruizeSupportedTypes.KUBERNETES_OBJECTS_SUPPORTED.contains(kubernetes_object.toLowerCase())) | ||
| errorString.append(AnalyzerConstants.KUBERNETES_OBJECTS).append(kubernetes_object) | ||
| .append(AnalyzerErrorConstants.AutotuneObjectErrors.UNSUPPORTED); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public boolean isSuccess() { | ||
| return success; | ||
| } | ||
|
|
||
| public void setSuccess(boolean success) { | ||
| this.success = success; | ||
| } | ||
| @Override | ||
| public String toString() { | ||
| return "MetadataProfileValidation{" + | ||
| "success=" + success + | ||
| ", errorMessage='" + errorMessage + '\'' + | ||
| '}'; | ||
| } | ||
|
|
||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why hashMap ? can we have String and MetadataProfile variable instead
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
HashMap will store all the metadata profiles created.. helping in validation with few database calls and also will be used in Create and List REST APIs in the subsequent PRs.