CSC/ECE 517 Spring 2023 - NTNX-3. Refactor models to keep profiles (software, compute, network, etc) as optional and use default if not specified: Difference between revisions

From Expertiza_Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(15 intermediate revisions by the same user not shown)
Line 67: Line 67:
==Potential Design Patterns, Principles, and Code Refactoring strategies==
==Potential Design Patterns, Principles, and Code Refactoring strategies==


The codebase could be converted into an Object Oriented fashion with classes. Further, here are some of the design patterns we could use:
Employing Clean Code Practices + Design Patterns:


'''Builder:''' This pattern could be used to create the provisioning request for a database instance in a more modular and flexible way. Rather than creating the request directly in one function, a builder class could be used to set individual properties of the request. This would make the code more maintainable and extensible, and would allow for easier testing of different combinations of request properties.
DRY (Do Not Repeat Yourself):
The initial draft of using 4 if & else statements for each of the profiles (namely: software, compute, network, and storage) and performing the same checks and code again proved to be in direct opposition to the DRY approach whose repetitiveness can be seen from the below snippet:
::::
:::::://Custom Software Profile Check and overriding the default values
::::::softwareProfile := dbSpec.Instance.Profiles.Software
::::::if softwareProfile == (Profile{}) {
::::::::log.Info("No enrichment for software profiles as no custom profile received for Software. Hence, proceeding with default OOB software profile")
::::::} else {
::::::::isValidProfile, matchedProfile, errorThroughChecks := performProfileAvailabilityCheck(ctx, dbEngineSpecificProfiles, softwareProfile, PROFILE_TYPE_SOFTWARE)
::::::::if errorThroughChecks != nil {
:::::::::://log.Error(err, "")
::::::::::return errorThroughChecks
::::::::}
::::::::if isValidProfile {
::::::::::profilesMap[PROFILE_TYPE_SOFTWARE] = matchedProfile
::::::::}
::::::}


'''Factory:''' Since there are different types of database instances that can be provisioned (e.g. MySQL, Postgres, etc.), a factory pattern could be used to create the appropriate request object based on the specified database type. This would help to decouple the creation of the request object from the calling code, and would make it easier to add support for new database types in the future.
:::::://Custom Compute Profile Check and overriding the default values
::::::computeProfile := dbSpec.Instance.Profiles.Compute
::::::if computeProfile == (Profile{}) {
::::::::log.Info("No enrichment for compute profiles as no custom profile received for Compute. Hence, proceeding with default OOB compute profile")
::::::} else {
::::::::isValidProfile, matchedProfile, errorThroughChecks := performProfileAvailabilityCheck(ctx, genericProfiles, computeProfile, PROFILE_TYPE_COMPUTE)
::::::::if errorThroughChecks != nil {
:::::::::://log.Error(err, "")
::::::::::return errorThroughChecks
::::::::}
::::::::if isValidProfile {
::::::::::profilesMap[PROFILE_TYPE_COMPUTE] = matchedProfile
::::::::}
::::::}


'''Dependency Injection:''' To allow for better testability, dependency injection can be used to decouple the code from its dependencies. For example, in the provided code snippet, the NDBClient is being passed into the GenerateProvisioningRequest() function. However, if the NDBClient had additional dependencies or if it were difficult to create a testable version of the NDBClient, dependency injection could be used to allow for easier testing and swapping of dependencies.
:::::://Custom Network Profile Check and overriding the default values
::::::networkProfile := dbSpec.Instance.Profiles.Network
::::::if networkProfile == (Profile{}) {
::::::::log.Info("No enrichment for network profiles as no custom profile received for Network. Hence, proceeding with default OOB network profile")
::::::} else {
::::::::isValidProfile, matchedProfile, errorThroughChecks := performProfileAvailabilityCheck(ctx, dbEngineSpecificProfiles, networkProfile, PROFILE_TYPE_NETWORK)
::::::::if errorThroughChecks != nil {
:::::::::://log.Error(err, "")
::::::::::return errorThroughChecks
::::::::}
::::::::if isValidProfile {
::::::::::profilesMap[PROFILE_TYPE_NETWORK] = matchedProfile
::::::::}
::::::}


''' Code Refactoring:'''
:::::://Custom DbParam Profile Check and overriding the default values
After reviewing the code base, it was discovered that the ndb_api_helpers.go file contains the code for provisioning the database. The main task of generating the request payload for provisioning the database is handled by the GenerateProvisioningRequest function. To retrieve all the profiles, this function utilizes the GetOOBProfiles function which returns a map of all the profiles. However, the current implementation of GenerateProvisioningRequest only retrieves the first element of the values within the map, which is assumed to be the default value. This means that the function doesn't verify if the user has provided a specific profile or not before assigning a default value.
::::::dbParamProfile := dbSpec.Instance.Profiles.DbParam
::::::if dbParamProfile == (Profile{}) {
::::::::log.Info("No enrichment for database parameter profiles as no custom profile received for it. Hence, proceeding with default OOB dbParam profile")
::::::} else {
::::::::isValidProfile, matchedProfile, errorThroughChecks := performProfileAvailabilityCheck(ctx, dbEngineSpecificProfiles, dbParamProfile, PROFILE_TYPE_DATABASE_PARAMETER)
::::::::if err != nil {
:::::::::://log.Error(err, "")
::::::::::return errorThroughChecks
::::::::}
::::::::if isValidProfile {
::::::::::profilesMap[PROFILE_TYPE_DATABASE_PARAMETER] = matchedProfile
::::::::}
::::::}
::::}
::::return
::}


To improve this behavior, we plan to iterate over all the profiles in the arrays that are inside the values of the profiles map. If the user has provided input for a specific profile, we will assign that input to the profiles variable. If not, we will use the first element of the array as the default value.
Hence, we create an array of profiles, and iterating over those profiles and calling a clean modular function by identifying the common key points from the above snippet helps in eliminating code duplication and makes the code more, readable, and open for extension by just adding new profile name to the list of profiles and easily maintainable! This approach can be viewed in EnrichProfilesMap() and delegate functions.


This change will allow us to properly check whether the user has provided input for a specific profile or not, and avoid the incorrect assumption that the first element of the values array is always the default value. By iterating over all the profiles, we can ensure that the correct profile is selected and assigned to the profiles variable. This will lead to more accurate and reliable database provisioning.
Refactoring + Delegation using Facade Design Pattern:


By default, for populating profiles, GetOOBProfiles() was called which did the task of fetching all profiles and populating default profile values. However, with the advent of custom profiles being provided from YAML, we suggest refactoring GetOOBProfiles() to EnrichProfilesMap() which will perform the same task as GetOOBProfiles did but in addition override the default values to input profiles provided after performing checks such as:
(1) Emptiness / Null checks for profiles
(2) Performing matching of the Id/VersionId for the custom profile provided & failing the database provisioning request in case of a match is not found.
Thus, for each of the checkers, we create modular functions and delegate the task of performing the above-mentioned checks.


[[File:file6.png|1000px]]
The flow proceeds as:


[[File:file7.png|1000px]]
EnrichProfilesMap()
Performs the task to set default values and override the default values by calling the below functions. 
 
PerformProfileMatchingAndEnrichProfiles() uses
[isEmptyProfile() + GetAppropriateProfileForType() + GetTopologyForProfileType() in filtering profiles]
Once, the user input is received, the input is delegated for checks and performing matching if the profile exists. Additionally, other factory methods are also used for performing the matching of profiles
 
EnrichProfileMapForProfileType()
Performs the final overriding of the default profile with the matched profile. Additionally, it cancels the database provisioning request for unmatched profiles.
 
Moreover, in Tests, new tests have been added which indicate their functionality through their names adhering to the Clean Coding Naming principle:
TestEnrichAndGetProfilesWhenCustomProfilesMatch()
TestEnrichAndGetProfilesWhenInvalidCustomProfilesProvided()
 
Additionally, we can also view the creation of specific functions as the alignment with the Facade Design Pattern that delegates the task of performing specific actions to respective functions.
 
Alternatively, a closer look at the initial draft and performing Cyclomatic Complexity checks indicate that our approach has breached the threshold value of permissible complexity. Hence, to tackle this problem, we will change the filtering profile functions to perform matching based on Id and further based on versionId and eliminating factory methods like getTopology(), getProfileForType(), and a few checker functions that will aid in reducing the cyclomatic complexity automatically.


== Modifications ==
== Modifications ==


===\ndb-operator\api\v1alpha1\ndb_api_helpers.go ====
=== db-operator\api\v1alpha1db_api_helpers.go ===
====Functions Changed====
====Functions Changed====
===== GenerateProvisioningRequest =====
previous working : This function generates and returns a request for provisioning a database (and a dbserver vm) on NDB and uses default compute, software, network, databaseParams profiles
enhanced working : This function generates and returns a request for provisioning a database (and a dbserver vm) on NDB and if user has provided custom profiles in "\ndb-operator\config\samples\ndb_v1alpha1_database.yaml", it will use those profiles to create the provisioning request or it will fall back to default profiles
previous code :
[[File:file8.png|1000px]]
new code :
[[File:file9.png|1000px]]
Explanation of the change :
changed the name of GetOOBProfiles to EnrichAndGetProfiles due to added functionality of overriding default profile values with custom profiles read from YAML file after performing applicability checks


===== EnrichAndGetProfiles =====
=====GenerateProvisioningRequest =====
previous working : previously this function was named GetOOBProfiles. This function used to fetch all the profiles from NDB API and return ProfilesMap with default profiles for each of the compute, software, network and dbParams profiles.
 
enhanced working : now this function fetches all the profiles from NDB API and populates ProfilesMap with default profiles for each of the compute, software, network and dbParams profiles. Then it calls function EnrichProfilesMap function which will populate ProfilesMap with custom profiles if there are any in the YAML file.
'''Previous Working :''' This function generates and returns a request for provisioning a database (and a dbserver vm) on NDB and uses default compute, software, network, databaseParams profiles
previous code :
 
[[File:file10.png|1000px]]
<br>'''Enhanced Working :''' This function generates and returns a request for provisioning a database (and a dbserver vm) on NDB and if user has provided custom profiles in "db-operator\config\samplesdb_v1alpha1_database.yaml", it will use those profiles to create the provisioning request or it will fall back to default profiles
new code :
 
[[File:file11png|1000px]]
<br>'''Previous Code :'''
Explanation of the change : since we only want to fall back to default profiles if there are no custom profiles mentioned in the YAML file, we are calling a new function EnrichProfilesMap which will populate ProfilesMap with the custom profiles.
:// Fetch the OOB profiles for the database
:profilesMap, err := GetOOBProfiles(ctx, ndbclient, dbSpec.Instance.Type)
:if err != nil {
::log.Error(err, "Error occurred while getting OOB profiles", "database name", dbSpec.Instance.DatabaseInstanceName, "database type", dbSpec.Instance.Type)
::return
:}
<br>'''New Code :'''
 
:// Fetch upto date profiles for the database
::profilesMap, err := MatchAndGetProfiles(ctx, ndbclient, dbSpec.Instance.Type, dbSpec.Instance.Profiles)
::if err != nil {
:::log.Error(err, "Error occurred while enriching and getting profiles", "database name", dbSpec.Instance.DatabaseInstanceName, "database type", dbSpec.Instance.Type)
:::return
::}
 
<br>=====Explanation for the change :=====
Replaced the call for GetOOBProfiles function with MatchAndGetProfiles due to added functionality of populating the profileMap with all the values for the profileType available
 
 
=====MatchAndGetProfiles =====
 
'''Previous Working :''' This function was not there previously.
 
<br>'''Enhanced Working :''' now this function first fetches all the profiles from NDB API. Then for each profile type it checks if a profile is provided in the YAML file or not. If it is provided in the YAML file, then this function calls GetProfileByType and matchProfiles functions to do the further work. If it is not provided in the YAML file, then this function calls PopulateDefaultProfiles function to assign default profiles.
 
<br>'''Previous Code :''' N/A
 
<br>'''New Code :'''
:func MatchAndGetProfiles(ctx context.Context, ndbclient *ndbclient.NDBClient, dbType string, profiles Profiles) (profileMap map[string]ProfileResponse, err error) {
 
::log := ctrllog.FromContext(ctx)
 
::// Map of profile type to profiles
::profileMap = make(map[string]ProfileResponse)
 
::allProfiles, err := GetAllProfiles(ctx, ndbclient)
 
::if err != nil {
:::return
::}
 
::log.Info("Received Input Profiles = ", "Received Input Profiles", profiles)
::profileOptions := [...]string{PROFILE_TYPE_COMPUTE, PROFILE_TYPE_SOFTWARE, PROFILE_TYPE_NETWORK, PROFILE_TYPE_DATABASE_PARAMETER, PROFILE_TYPE_STORAGE}
::for _, profileType := range profileOptions {
:::if profiles == (Profiles{}) {
::::err = PopulateDefaultProfile(ctx, profileMap, profileType, allProfiles, dbType)
:::} else {
::::profile := GetProfileByType(profileType, profiles)
::::err = matchProfiles(ctx, profileType, profile, allProfiles, profileMap, dbType)
:::}
:::if err != nil {
::::return
:::}
::}
 
::return
 
:}
<br>=====Explanation for the change :===== We need a function that checks if profiles are there in YAML file for or not and depending on that we need to make the further decisions. This function helps us to check that and delegate the next tasks.
 
=====matchProfiles =====
 
'''Previous Working :''' This function was not there previously.
 
<br>'''Enhanced Working :''' This function does:
:(a) Id level matching with profiles in allProfiles
:(b) If Id level match is successful, flow proceeds to match based on versionId
::When matched, the latestVersionId is overridden with the versionId as it is this attribute while dbProvisioning which is used for
::profileType versionId.
 
<br>'''Previous Code :''' N/A
 
<br>'''New Code :'''
:func matchProfiles(ctx context.Context, profileType string, profile Profile, allProfiles []ProfileResponse, profilesMap map[string]ProfileResponse, dbType string) (err error) {
::log := ctrllog.FromContext(ctx)
::var idMatchedProfile []ProfileResponse
::var matchedVersion []Version
::if isEmptyProfile(profile) {
:::err = PopulateDefaultProfile(ctx, profilesMap, profileType, allProfiles, dbType)
:::return
::}
::log.Info("Performing profile matching for profileType => ", "profileType", profileType)
::// match based on ID
::idMatchedProfile = util.Filter(allProfiles, func(p ProfileResponse) bool { return p.Id == profile.Id && p.Type == profileType })
::// matching based on versionID
::if len(idMatchedProfile) > 0 {
:::matchedVersion = util.Filter(idMatchedProfile[0].Versions, func(versions Version) bool { return versions.Id == profile.VersionId })
:::// when versionID level match found, override latestVersionId as it is used in the database provisioning request
:::if len(matchedVersion) > 0 {
::::log.Info("Id and VersionId matched for profileType", "profileType", profileType)
::::idMatchedProfile[0].LatestVersionId = profile.VersionId
:::}
::}
::err = PopulateProfileOfType(ctx, profilesMap, profileType, allProfiles, dbType, idMatchedProfile)
::return
:}
<br>=====Explanation for the change :===== We use profiles in YAML file only when they have correct Id. To perform this essential task of checking the correctness of Id and after that populating the versionId, we have created this function. After checking the correctness, this function delegates the further tasks to PopulateProfileOfType function.
 
=====PopulateProfileOfType =====
 
'''Previous Working :''' This function was not there previously.
 
<br>'''Enhanced Working :''' This function performs the task of populating profileMap with response (matching result) received for the profileType.
 
<br>'''Previous Code :''' N/A
 
<br>'''New Code :'''
:func PopulateProfileOfType(ctx context.Context, profileMap map[string]ProfileResponse, profileType string, allProfiles []ProfileResponse, dbType string, response []ProfileResponse) (err error) {
::log := ctrllog.FromContext(ctx)
::// if response is empty, it indicates no matching profile found; hence set the default OOB profile for that type
::if len(response) == 0 {
:::err = fmt.Errorf("No matching profile found for profileType = %s", profileType)
:::log.Info("Error Occurred. No enrichment performed for profile = ", "profileType", profileType)
:::return
::}
::log.Info("Going to populate profile value in profilesMap for profileType = ", "profileType", profileType)
::profileMap[profileType] = response[0]
::return
:}
<br>=====Explanation for the change :===== Since this function is called only after the sanity check of Id and versionId, this function just has to populate the profiles by their respective types.
 
=====PopulateDefaultProfile =====
 
'''Previous Working :''' This function was not there previously.
 
<br>'''Enhanced Working :''' This method populates profileMap with the default value for the profileType.
 
<br>'''Previous Code :''' N/A
 
<br>'''New Code :'''
:func PopulateDefaultProfile(ctx context.Context, profileMap map[string]ProfileResponse, profileType string, allProfiles []ProfileResponse, dbType string) (err error) {
::log := ctrllog.FromContext(ctx)
::log.Info("Going to set default profile value for profileType = ", "profileType", profileType)
::genericProfiles := util.Filter(allProfiles, func(p ProfileResponse) bool { return p.EngineType == DATABASE_ENGINE_TYPE_GENERIC })
::dbEngineSpecificProfiles := util.Filter(allProfiles, func(p ProfileResponse) bool { return p.EngineType == GetDatabaseEngineName(dbType) })
::response, err := GetDefaultProfileForType(genericProfiles, dbEngineSpecificProfiles, profileType)
::if err != nil {
:::return
::}
::profileMap[profileType] = response[0]
::return
:}
<br>=====Explanation for the change :===== Since this function is called only if profiles are missing in the YAML file or have wrong profile Id, this function just has to populate the default out of the box profiles for each profile type. This function calls GetDefaultProfileForType function to get profiles for each profile type.
 
=====GetDefaultProfileForType =====
 
'''Previous Working :''' This function was not there previously.
 
<br>'''Enhanced Working :''' This function gets default profile for each profile type from the result of GET API call to the NDB API.
 
'''Previous Code :''' N/A
 
<br>'''New Code :'''
:func GetDefaultProfileForType(genericProfiles []ProfileResponse, dbEngineSpecificProfiles []ProfileResponse, profileType string) (profile []ProfileResponse, err error) {
::switch profileType {
::case PROFILE_TYPE_COMPUTE:
:::profile = util.Filter(genericProfiles, func(p ProfileResponse) bool {
::::return p.Type == PROFILE_TYPE_COMPUTE && strings.Contains(strings.ToLower(p.Name), "small")
:::})
:::break
::case PROFILE_TYPE_SOFTWARE:
:::profile = util.Filter(dbEngineSpecificProfiles, func(p ProfileResponse) bool { return p.Type == PROFILE_TYPE_SOFTWARE && p.Topology == TOPOLOGY_SINGLE })
:::break
::case PROFILE_TYPE_NETWORK:
:::profile = util.Filter(dbEngineSpecificProfiles, func(p ProfileResponse) bool { return p.Type == PROFILE_TYPE_NETWORK })
:::break
::case PROFILE_TYPE_DATABASE_PARAMETER:
:::profile = util.Filter(dbEngineSpecificProfiles, func(p ProfileResponse) bool { return p.Type == PROFILE_TYPE_DATABASE_PARAMETER })
:::break
::case PROFILE_TYPE_STORAGE:
:::profile = util.Filter(genericProfiles, func(p ProfileResponse) bool { return p.Type == PROFILE_TYPE_STORAGE })
:::break
::default:
:::return
::}
::if len(profile) == 0 {
:::err = errors.New("oob profile: one or more OOB profile(s) were not found")
:::return
::}
::return
:}
<br>=====Explanation for the change :===== We have to find appropriate default profile from the API call result. With the help of some util functions, this function performs this filtering task.
 
=====GetProfileByType =====
 
'''Previous Working :''' This function was not there previously.
 
<br>'''Enhanced Working :''' This function just returns the appropriate costant value from the pre-defined object structures.
 
'''Previous Code :''' N/A


===== EnrichProfilesMap =====
<br>'''New Code :'''
previous working : This function was not there previously.
enhanced working : This function checks if there are any custom profiles in the "\ndb-operator\config\samples\ndb_v1alpha1_database.yaml" file. If there any custom profiles, this function will call function PerformProfileMatchingAndEnrichProfiles to fetch them for each category (Compute, Software, Network, dbParams) and populate ProfilesMap with it.
previous code : N/A
new code :
[[File:file13png|1000px]]
Explanation of the change : Since we have added new section for custom profiles in the "\ndb-operator\config\samples\ndb_v1alpha1_database.yaml" file, we needed a function that will check if there is a section for custom profiles and delegate the task to fetch the custom profiles from the YAML file. This function fulfills that need.


===== PerformProfileMatchingAndEnrichProfiles =====
:func GetProfileByType(profileType string, profiles Profiles) Profile {
previous working : This function was not there previously.
::defaultEmptyProfile := Profile{}
enhanced working : Based on compute or (software, network & dbParam), generic or dbEngineSpecific profiles are used for matching the input customProfile. Furthermore, based on whether matched or not matched, delegation is performed to override the default profile values.
::switch profileType {
previous code : N/A
::case PROFILE_TYPE_COMPUTE:
new code :
:::return profiles.Compute
[[File:file15png|1000px]]
::case PROFILE_TYPE_SOFTWARE:
Explanation of the change : We want to check if custom profiles mentioned in the YAML file are valid or not. If the profile type is compute, this function calls another function to validate the custom profile with generic profiles. If the profile type is network/software/dbParams, this function calls another function to validate the custom profile with dbEngineSpecific profiles.
:::return profiles.Software
::case PROFILE_TYPE_NETWORK:
:::return profiles.Network
::case PROFILE_TYPE_DATABASE_PARAMETER:
:::return profiles.DbParam
::default:
:::return defaultEmptyProfile
::}
:}
<br>=====Explanation for the change :===== We use pre-defined object structures for reference everywhere. This function helps us to make that references correctly.


===== GetAppropriateProfileForType =====
previous working : This function was not there previously.
enhanced working : This functions gives either generic or dbEngine specific profiles based upon the profile type to be filtered upon.
previous code : N/A
new code :
[[File:file16png|1000px]]
Explanation of the change : This function is used by PerformProfileMatchingAndEnrichProfiles function to make the decision of what kind of profiles are to be matched with what type of profiles.


===== EnrichProfileMapForProfileType =====
previous working : This function was not there previously.
enhanced working : This function checks the correctness of the profile (response) passed as the parameter and overrides the profilesMap for the custom profile type specified if the custom profile provided passes the checks.
previous code : N/A
new code :
[[File:file17png|1000px]]
Explanation of the change : The custom profile mentioned in the YAML file is only valid if it exists in the list of all profiles provided by the NDB API. This function performs the task to check if the given custom profile exists in the all profiles list.


== Test Plan ==
== Test Plan ==
Line 146: Line 392:
=== Test Case Scenario 1 ===
=== Test Case Scenario 1 ===


Test case name: Provisioning of appropriate database based on compute parameters
Test case name: Provisioning of appropriate database based on provided software/compute/network/dbParams profiles
** Description: This test case verifies that the appropriate database is provisioned based on the compute parameters passed as input, as expected.
** Description: This test case verifies that the appropriate database is provisioned based on the provided software/compute/network/dbParams profiles as input through YAML file, as expected.
** Pre-conditions:
** Pre-conditions:
*** The system is set up and running
*** Pre-requisites are installed
*** The compute parameters are available for input
*** Docker Desktop Application is running
*** Kubernetes cluster is up
*** Nutanix Test Drive is active and the cluster id and other credentials are present inside "db-operator\config\samplesdb_v1alpha1_database.yaml" and "db-operator\config\samples\secret.yaml"
*** The software/compute/network/dbParams profiles are available for input in a profiles section inside "db-operator\config\samplesdb_v1alpha1_database.yaml"
** Test steps:
** Test steps:
*** Pass the compute parameters as input to the system
*** Run command "make install run" in the root directory of the project
*** Check if the appropriate database has been provisioned based on the compute parameters
*** Create secrets with command "kubectl apply -f .\config\samples\secret.yaml"
*** Verify that the database configuration and settings match the expected values based on the input parameters
*** Provision the database with command "kubectl apply -f .\config\samplesdb_v1alpha1_database.yaml"
*** Check if the appropriate database has been provisioned on the Nutanix test drive
*** Verify that the compute/software/network/dbParams profiles of the database match the expected values based on the input parameters
** Expected results:
** Expected results:
*** The system provisions the appropriate database based on the compute parameters
*** The system provisions the appropriate database based on the configurations specified in "db-operator\config\samplesdb_v1alpha1_database.yaml"
*** The database configuration and settings match the expected values based on the input parameters
*** The the compute/software/network/dbParams profiles match the expected values based on the input parameters
*** The test case passes successfully
*** The test case passes successfully
=== Test Case Scenario 2 ===
=== Test Case Scenario 2 ===


Test case name: Use of default setup for configuration when optional parameters are not passed
Test case name: Throwing error if invalid software/compute/network/dbParams profiles are given as input
** Description: This test case verifies that the database configured uses the default setup for configuration when optional parameters are not passed as input, as expected.
** Description: This test case verifies that error is thrown if invalid software/compute/network/dbParams profiles are provided as input through YAML file.
** Pre-conditions:
** Pre-conditions:
*** The system is set up and running
*** Pre-requisites are installed
*** No optional parameters are passed as input
*** Docker Desktop Application is running
*** Kubernetes cluster is up
*** Nutanix Test Drive is active and the cluster id and other credentials are present inside "db-operator\config\samplesdb_v1alpha1_database.yaml" and "db-operator\config\samples\secret.yaml"
*** The software/compute/network/dbParams profiles are available for input in a profiles section inside "db-operator\config\samplesdb_v1alpha1_database.yaml"
** Test steps:
** Test steps:
*** Do not pass any optional parameters as input to the system
*** Run command "make install run" in the root directory of the project
*** Check if the database is configured using the default setup for configuration
*** Create secrets with command "kubectl apply -f .\config\samples\secret.yaml"
*** Verify that the database configuration and settings match the expected values based on the default setup
*** Provision the database with command "kubectl apply -f .\config\samplesdb_v1alpha1_database.yaml"
*** Check if the database has not been provisioned on the Nutanix test drive
*** Verify that the error is thrown on the command prompt
** Expected results:
** Expected results:
*** The system configures the database using the default setup when no optional parameters are passed
*** The system does not provision the database
*** The database configuration and settings match the expected values based on the default setup
*** The error is thrown saying that the id/version id of software/compute/network/dbParams profiles is invalid
*** The test case passes successfully
*** The test case passes successfully
=== Test Case Scenario 3 ===
Test case name: Use of default software/compute/network/dbParams profiles for database provisioning when software/compute/network/dbParams profiles are not passed
** Description: This test case verifies that the database configured uses the default software/compute/network/dbParams profiles for configuration when software/compute/network/dbParams profiles are not present in the profiles section of "db-operator\config\samplesdb_v1alpha1_database.yaml"
** Pre-conditions:
*** Pre-requisites are installed
*** Docker Desktop Application is running
*** Kubernetes cluster is up
*** Nutanix Test Drive is active and the cluster id and other credentials are present inside "db-operator\config\samplesdb_v1alpha1_database.yaml" and "db-operator\config\samples\secret.yaml"
*** The software/compute/network/dbParams profiles are not available for input in a profiles section inside "db-operator\config\samplesdb_v1alpha1_database.yaml"
** Test steps:
*** Run command "make install run" in the root directory of the project
*** Create secrets with command "kubectl apply -f .\config\samples\secret.yaml"
*** Provision the database with command "kubectl apply -f .\config\samplesdb_v1alpha1_database.yaml"
*** Check if the appropriate database has been provisioned on the Nutanix test drive
*** Verify that the compute/software/network/dbParams profiles of the database match the default profiles
** Expected results:
*** The system provisions the appropriate database based on the configurations specified in "db-operator\config\samplesdb_v1alpha1_database.yaml"
*** The the compute/software/network/dbParams profiles match the default profile values
*** The test case passes successfully
== Testing ==
Testcases were written in "db-operator\testdb_api_helpers_test.go"
<br>Dummy Objects required for these testcases were created in "db-operator\test\testutility.go"
=== Testcase to check Test Scenario 1 and Test Scenario 3 ===
::func TestEnrichAndGetProfilesWhenCustomProfilesMatch(t *testing.T) {
:::://Set
::::server := GetServerTestHelper(t)
::::defer server.Close()
::::ndbclient := ndbclient.NewNDBClient("username", "password", server.URL, "", true)
:::://Test
::::dbTypes := []string{"postgres", "mysql", "mongodb"}
::::for _, dbType := range dbTypes {
::::::// get custom profile based upon the database type
::::::customProfile := GetCustomProfileForDBType(dbType)
::::::profileMap, _ := v1alpha1.EnrichAndGetProfiles(context.Background(), ndbclient, dbType, customProfile)
:::::://Assert
::::::profileTypes := []string{
::::::::v1alpha1.PROFILE_TYPE_COMPUTE,
::::::::v1alpha1.PROFILE_TYPE_STORAGE,
::::::::v1alpha1.PROFILE_TYPE_SOFTWARE,
::::::::v1alpha1.PROFILE_TYPE_NETWORK,
::::::::v1alpha1.PROFILE_TYPE_DATABASE_PARAMETER,
::::::}
::::::for _, profileType := range profileTypes {
::::::::profile := profileMap[profileType]
:::::::://Assert that no profileType is empty
::::::::if profile == (v1alpha1.ProfileResponse{}) {
::::::::::t.Errorf("Empty profile type %s for dbType %s", profileType, dbType)
::::::::}
:::::::://Assert that profile EngineType matches the database engine or the generic type
::::::::if profile.EngineType != v1alpha1.GetDatabaseEngineName(dbType) && profile.EngineType != v1alpha1.DATABASE_ENGINE_TYPE_GENERIC {
::::::::::t.Errorf("Profile engine type %s for dbType %s does not match", profile.EngineType, dbType)
::::::::}
::::::::obtainedProfile := v1alpha1.GetProfileForType(profileType, customProfile)
::::::::// Ignoring Storage Profile Type as the Profile struct currently only supports compute, software, network and dbParam
::::::::if profileType != v1alpha1.PROFILE_TYPE_STORAGE && profile.Id != obtainedProfile.Id && profile.LatestVersionId != obtainedProfile.VersionId {
::::::::::t.Errorf("Custom Profile Enrichment failed for profileType = %s and dbType = %s", profileType, dbType)
::::::::}
::::::}
::::}
::}
==== Code for creating Dummy Objects required for this testcase ====
::func GetCustomProfileForDBType(dbType string) (profiles v1alpha1.Profiles) {
::::switch dbType {
::::case v1alpha1.DATABASE_TYPE_POSTGRES:
::::::profiles = v1alpha1.Profiles{
::::::::// Custom Software Profile Name = "custom postgres software profile"
::::::::Software: v1alpha1.Profile{
::::::::::Id: "12",
::::::::::VersionId: "v-id-12",
::::::::},
::::::::// Custom ompute Name = "a"
::::::::Compute: v1alpha1.Profile{
::::::::::Id: "1",
::::::::::VersionId: "v-id-1",
::::::::},
::::::::Network: v1alpha1.Profile{
::::::::::Id: "15",
::::::::::VersionId: "v-id-15",
::::::::},
::::::::DbParam: v1alpha1.Profile{
::::::::::Id: "18",
::::::::::VersionId: "v-id-18",
::::::::},
::::::}
::::::return profiles
=== Testcase to check Test Scenario 2 ===
::func TestEnrichAndGetProfilesWhenInvalidCustomProfilesProvided(t *testing.T) {
:::://Set
::::server := GetServerTestHelper(t)
::::defer server.Close()
::::ndbclient := ndbclient.NewNDBClient("username", "password", server.URL, "", true)
:::://Test
::::dbTypes := []string{"postgres_invalid_profiles", "mysql_invalid_profiles", "mongodb_invalid_profiles"}
::::for _, dbType := range dbTypes {
::::::// get custom profile based upon the database type
::::::customProfile := GetCustomProfileForDBType(dbType)
::::::profileMap, _ := v1alpha1.EnrichAndGetProfiles(context.Background(), ndbclient, dbType, customProfile)
:::::://Assert
::::::profileTypes := []string{
::::::::v1alpha1.PROFILE_TYPE_COMPUTE,
::::::::v1alpha1.PROFILE_TYPE_STORAGE,
::::::::v1alpha1.PROFILE_TYPE_SOFTWARE,
::::::::v1alpha1.PROFILE_TYPE_NETWORK,
::::::::v1alpha1.PROFILE_TYPE_DATABASE_PARAMETER,
::::::}
::::::for _, profileType := range profileTypes {
::::::::profile := profileMap[profileType]
:::::::://Assert that profile EngineType matches the database engine or the generic type
::::::::if profile.EngineType != v1alpha1.GetDatabaseEngineName(dbType) && profile.EngineType != v1alpha1.DATABASE_ENGINE_TYPE_GENERIC {
::::::::::t.Errorf("Profile engine type %s for dbType %s does not match", profile.EngineType, dbType)
::::::::}
::::::::/* since custom profile is passed it should not default to OOB, and err should be raised stating the custom profile passed does not exist,
::::::::and thus database provisioning does not occur
::::::::*/
::::::::if profile != (v1alpha1.ProfileResponse{}) {
::::::::::t.Errorf("Incorrect Profile Match found for profile type = %s and dbType = %s", profileType, dbType)
::::::::}
::::::}
::::}
::}
==== Code for creating Dummy Objects required for this testcase ====
::case v1alpha1.DATABASE_TYPE_MONGODB_INVALID_PROFILE, v1alpha1.DATABASE_TYPE_MYSQL_INVALID_PROFILE, v1alpha1.DATABASE_TYPE_POSTGRES_INVALID_PROFILE:
::::::// below custom profiles do not exist and will be used for the negative scenario
::::::profiles = v1alpha1.Profiles{
::::::::Software: v1alpha1.Profile{
::::::::::Id: "140",
::::::::::VersionId: "v-id-140",
::::::::},
::::::::Compute: v1alpha1.Profile{
::::::::::Id: "100",
::::::::::VersionId: "v-id-100",
::::::::},
::::::::Network: v1alpha1.Profile{
::::::::::Id: "170",
::::::::::VersionId: "v-id-170",
::::::::},
::::::::DbParam: v1alpha1.Profile{
::::::::::Id: "200",
::::::::::VersionId: "v-id-200",
::::::::},
::::::}
::::::return profiles


==Github==
==Github==
* Repo: https://github.com/karan-47/ndb-operator/tree/feature/ntnx_3
* Repo: https://github.com/karan-47/ndb-operator/tree/feature/ntnx3




Latest revision as of 21:28, 2 May 2023

Background

Kubernetes An open-source container orchestration technology called Kubernetes is used to automatically deploy, scale, and manage containerized applications. Developers can use Kubernetes to distribute and control containerized applications across a dispersed network of servers or PCs. To ensure that the actual state of an application matches the desired state, it uses a declarative model to express the desired state and automatically manages the containerized components. Kubernetes can be operated on public or private cloud infrastructure as well as in-house data centers and offers a wide range of functionality for managing containerized applications, such as autonomous scaling, rolling updates, self-healing, service discovery, and load balancing.

Nutanix Database Service

A hybrid multi-cloud database-as-a-service for Microsoft SQL Server, Oracle Database, PostgreSQL, MongoDB, and MySQL, among other databases, is called Nutanix Database Service. It allows for the efficient management of hundreds to thousands of databases, the quick creation of new ones, and the automation of time-consuming administration activities like patching and backups. Users can also choose certain operating systems, database versions, and extensions to satisfy application and compliance requirements. Customers from all around the world have optimized their databases across numerous locations and sped up software development using Nutanix Database Service.

Features offered by NDB Service:

  1. Nutanix NDB is a distributed NoSQL database service that is part of the Nutanix platform. Some of the key features of NDB include highly scalable architecture, distributed data storage, support for multiple data models, consistent data, fast data access, automatic sharding, real-time analytics, high availability and fault tolerance, and strong security features.
  2. With its ability to scale up or down the number of nodes in a cluster, Nutanix NDB provides highly scalable architecture without any downtime. Its distributed architecture ensures high availability and fault tolerance, while its support for multiple data models makes it a versatile database service for a wide range of use cases. Additionally, NDB supports strong consistency and fast data access by caching frequently accessed data in memory, which helps reduce the number of disk reads and improves query performance.
  3. NDB also provides automatic sharding, which helps ensure that your database can handle large amounts of data. You can use graph queries to analyze relationships between data in real-time, which can help you make more informed decisions. Furthermore, NDB offers high availability and fault tolerance through its distributed architecture and replication features. Lastly, NDB provides strong security features, including role-based access control, data encryption at rest, and network security features.

NDB Kubernetes Operator

The NDB Kubernetes Operator is an innovative tool created by Nutanix to streamline the management and operation of the Nutanix NDB (NoSQL database) on Kubernetes clusters.

With the NDB Kubernetes Operator, deploying and managing NDB clusters on Kubernetes has never been easier, as it eliminates the need to manually configure and manage the underlying infrastructure. Built on the Kubernetes operator framework, it offers a declarative way to manage the lifecycle of NDB clusters and other related resources.

One of the key benefits of the operator is that it simplifies the management of NDB clusters by automating common tasks, such as cluster creation, scaling, upgrading, backup, and recovery. It also offers a high degree of flexibility and customization, allowing you to configure various aspects of the cluster, such as storage, networking, and security.

Another advantage of the NDB Kubernetes Operator is its seamless integration with other Kubernetes tools and resources, such as Helm charts, Kubernetes secrets, and Kubernetes ConfigMaps. This integration makes it easy to integrate NDB into your existing Kubernetes-based infrastructure and workflows, providing a hassle-free solution for managing your database clusters.

Overall, the NDB Kubernetes Operator is a powerful and flexible tool for managing NDB clusters on Kubernetes, freeing you up to focus on your application logic rather than infrastructure management. Its automation capabilities and integration with other Kubernetes tools make it a must-have tool for developers and administrators looking to simplify and streamline their database management on Kubernetes.

Existing Architecture and Problem Statement

Problem Statement: Refactor models to keep profiles (software, compute, network, etc) as optional and use default if not specified

The NDB Kubernetes operator currently uses default compute, network and OS software profiles while provisioning the database. Refactor this module to include optional fields and only if absent, fall back to default.

NDB Architecture

Microsoft SQL Server, Oracle Database, PostgreSQL, MySQL, and MongoDB are just a few of the databases that can have high availability, scalability, and speed thanks to the distributed architecture of the Nutanix Database Service. The hyper-converged infrastructure from Nutanix, which offers a scalable and adaptable platform for handling enterprise workloads, is the foundation around which the architecture is built.

There are various layers in the architecture of the Nutanix Database Service. The Nutanix hyperconverged infrastructure is the basic layer that provides the storage, computing, and networking resources needed to run the databases. The Nutanix Acropolis operating system, which offers the essential virtualization and administration features, sits on top of this layer.

The Nutanix Era layer, which is located above the Nutanix Acropolis layer, offers the Nutanix Database Service the ability to manage databases throughout their existence. The Nutanix Era Manager, a centralized management console that offers a single point of access for controlling the databases across several clouds and data centers, is included in this tier.

The Nutanix Era Orchestrator, which is in charge of automating the provisioning, scaling, patching, and backup of the databases, is another component of the Nutanix Era layer. The Orchestrator offers a declarative approach for specifying the desired state of the databases and is built to work with a variety of databases.

The Nutanix Era Application, a web-based interface that enables database administrators and developers to quickly provision and administer the databases, is the final component of the top layer. A self-service interface for installing databases as well as a number of tools for tracking and troubleshooting database performance are offered by the Era Application.

Design & Workflow

Large amounts of data may be handled by the highly scalable, fault-tolerant, and consistent Nutanix NDB NoSQL database. It is a distributed database created to be installed over several cluster nodes. A portion of the data is stored on each node in the cluster, and the data is replicated across several nodes to guarantee high availability.

Configure your Nutanix cluster: We need to configure your Nutanix cluster to support NDB. This includes setting up the storage and network configurations, configuring the NDB nodes, and defining the replication factor.

Create a table: We need to create a table in NDB to store your data. This includes defining the schema, specifying the replication factor, and configuring any other options you need.

Write your code: We need to write your code to interact with the NDB cluster. This includes inserting and retrieving data, as well as performing more complex operations such as querying, indexing, and data aggregation.

Test your code: We need to test your code to ensure that it works as expected. This includes testing basic operations such as creating and retrieving data, as well as testing more complex operations such as queries and data aggregation.

Monitor your cluster: We need to monitor your NDB cluster to ensure that it is performing as expected. This includes monitoring resource usage, handling errors and exceptions, and optimizing performance.

Optimize your cluster: We need to optimize your NDB cluster over time to ensure that it continues to meet your needs. This includes tuning the configuration, optimizing queries, and scaling the cluster as needed.

Backup and recovery: We need to establish backup and recovery procedures to ensure that your data is protected against data loss or corruption. This includes regularly backing up your data, testing your backups, and establishing procedures for recovering data in case of a disaster.

Potential Design Patterns, Principles, and Code Refactoring strategies

Employing Clean Code Practices + Design Patterns:

DRY (Do Not Repeat Yourself): The initial draft of using 4 if & else statements for each of the profiles (namely: software, compute, network, and storage) and performing the same checks and code again proved to be in direct opposition to the DRY approach whose repetitiveness can be seen from the below snippet:

//Custom Software Profile Check and overriding the default values
softwareProfile := dbSpec.Instance.Profiles.Software
if softwareProfile == (Profile{}) {
log.Info("No enrichment for software profiles as no custom profile received for Software. Hence, proceeding with default OOB software profile")
} else {
isValidProfile, matchedProfile, errorThroughChecks := performProfileAvailabilityCheck(ctx, dbEngineSpecificProfiles, softwareProfile, PROFILE_TYPE_SOFTWARE)
if errorThroughChecks != nil {
//log.Error(err, "")
return errorThroughChecks
}
if isValidProfile {
profilesMap[PROFILE_TYPE_SOFTWARE] = matchedProfile
}
}
//Custom Compute Profile Check and overriding the default values
computeProfile := dbSpec.Instance.Profiles.Compute
if computeProfile == (Profile{}) {
log.Info("No enrichment for compute profiles as no custom profile received for Compute. Hence, proceeding with default OOB compute profile")
} else {
isValidProfile, matchedProfile, errorThroughChecks := performProfileAvailabilityCheck(ctx, genericProfiles, computeProfile, PROFILE_TYPE_COMPUTE)
if errorThroughChecks != nil {
//log.Error(err, "")
return errorThroughChecks
}
if isValidProfile {
profilesMap[PROFILE_TYPE_COMPUTE] = matchedProfile
}
}
//Custom Network Profile Check and overriding the default values
networkProfile := dbSpec.Instance.Profiles.Network
if networkProfile == (Profile{}) {
log.Info("No enrichment for network profiles as no custom profile received for Network. Hence, proceeding with default OOB network profile")
} else {
isValidProfile, matchedProfile, errorThroughChecks := performProfileAvailabilityCheck(ctx, dbEngineSpecificProfiles, networkProfile, PROFILE_TYPE_NETWORK)
if errorThroughChecks != nil {
//log.Error(err, "")
return errorThroughChecks
}
if isValidProfile {
profilesMap[PROFILE_TYPE_NETWORK] = matchedProfile
}
}
//Custom DbParam Profile Check and overriding the default values
dbParamProfile := dbSpec.Instance.Profiles.DbParam
if dbParamProfile == (Profile{}) {
log.Info("No enrichment for database parameter profiles as no custom profile received for it. Hence, proceeding with default OOB dbParam profile")
} else {
isValidProfile, matchedProfile, errorThroughChecks := performProfileAvailabilityCheck(ctx, dbEngineSpecificProfiles, dbParamProfile, PROFILE_TYPE_DATABASE_PARAMETER)
if err != nil {
//log.Error(err, "")
return errorThroughChecks
}
if isValidProfile {
profilesMap[PROFILE_TYPE_DATABASE_PARAMETER] = matchedProfile
}
}
}
return
}

Hence, we create an array of profiles, and iterating over those profiles and calling a clean modular function by identifying the common key points from the above snippet helps in eliminating code duplication and makes the code more, readable, and open for extension by just adding new profile name to the list of profiles and easily maintainable! This approach can be viewed in EnrichProfilesMap() and delegate functions.

Refactoring + Delegation using Facade Design Pattern:

By default, for populating profiles, GetOOBProfiles() was called which did the task of fetching all profiles and populating default profile values. However, with the advent of custom profiles being provided from YAML, we suggest refactoring GetOOBProfiles() to EnrichProfilesMap() which will perform the same task as GetOOBProfiles did but in addition override the default values to input profiles provided after performing checks such as: (1) Emptiness / Null checks for profiles (2) Performing matching of the Id/VersionId for the custom profile provided & failing the database provisioning request in case of a match is not found. Thus, for each of the checkers, we create modular functions and delegate the task of performing the above-mentioned checks.

The flow proceeds as:

EnrichProfilesMap() Performs the task to set default values and override the default values by calling the below functions.

PerformProfileMatchingAndEnrichProfiles() uses [isEmptyProfile() + GetAppropriateProfileForType() + GetTopologyForProfileType() in filtering profiles] Once, the user input is received, the input is delegated for checks and performing matching if the profile exists. Additionally, other factory methods are also used for performing the matching of profiles

EnrichProfileMapForProfileType() Performs the final overriding of the default profile with the matched profile. Additionally, it cancels the database provisioning request for unmatched profiles.

Moreover, in Tests, new tests have been added which indicate their functionality through their names adhering to the Clean Coding Naming principle: TestEnrichAndGetProfilesWhenCustomProfilesMatch() TestEnrichAndGetProfilesWhenInvalidCustomProfilesProvided()

Additionally, we can also view the creation of specific functions as the alignment with the Facade Design Pattern that delegates the task of performing specific actions to respective functions.

Alternatively, a closer look at the initial draft and performing Cyclomatic Complexity checks indicate that our approach has breached the threshold value of permissible complexity. Hence, to tackle this problem, we will change the filtering profile functions to perform matching based on Id and further based on versionId and eliminating factory methods like getTopology(), getProfileForType(), and a few checker functions that will aid in reducing the cyclomatic complexity automatically.

Modifications

db-operator\api\v1alpha1db_api_helpers.go

Functions Changed

GenerateProvisioningRequest

Previous Working : This function generates and returns a request for provisioning a database (and a dbserver vm) on NDB and uses default compute, software, network, databaseParams profiles


Enhanced Working : This function generates and returns a request for provisioning a database (and a dbserver vm) on NDB and if user has provided custom profiles in "db-operator\config\samplesdb_v1alpha1_database.yaml", it will use those profiles to create the provisioning request or it will fall back to default profiles


Previous Code :

// Fetch the OOB profiles for the database
profilesMap, err := GetOOBProfiles(ctx, ndbclient, dbSpec.Instance.Type)
if err != nil {
log.Error(err, "Error occurred while getting OOB profiles", "database name", dbSpec.Instance.DatabaseInstanceName, "database type", dbSpec.Instance.Type)
return
}


New Code :

// Fetch upto date profiles for the database
profilesMap, err := MatchAndGetProfiles(ctx, ndbclient, dbSpec.Instance.Type, dbSpec.Instance.Profiles)
if err != nil {
log.Error(err, "Error occurred while enriching and getting profiles", "database name", dbSpec.Instance.DatabaseInstanceName, "database type", dbSpec.Instance.Type)
return
}


=====Explanation for the change :===== Replaced the call for GetOOBProfiles function with MatchAndGetProfiles due to added functionality of populating the profileMap with all the values for the profileType available


MatchAndGetProfiles

Previous Working : This function was not there previously.


Enhanced Working : now this function first fetches all the profiles from NDB API. Then for each profile type it checks if a profile is provided in the YAML file or not. If it is provided in the YAML file, then this function calls GetProfileByType and matchProfiles functions to do the further work. If it is not provided in the YAML file, then this function calls PopulateDefaultProfiles function to assign default profiles.


Previous Code : N/A


New Code :

func MatchAndGetProfiles(ctx context.Context, ndbclient *ndbclient.NDBClient, dbType string, profiles Profiles) (profileMap map[string]ProfileResponse, err error) {
log := ctrllog.FromContext(ctx)
// Map of profile type to profiles
profileMap = make(map[string]ProfileResponse)
allProfiles, err := GetAllProfiles(ctx, ndbclient)
if err != nil {
return
}
log.Info("Received Input Profiles = ", "Received Input Profiles", profiles)
profileOptions := [...]string{PROFILE_TYPE_COMPUTE, PROFILE_TYPE_SOFTWARE, PROFILE_TYPE_NETWORK, PROFILE_TYPE_DATABASE_PARAMETER, PROFILE_TYPE_STORAGE}
for _, profileType := range profileOptions {
if profiles == (Profiles{}) {
err = PopulateDefaultProfile(ctx, profileMap, profileType, allProfiles, dbType)
} else {
profile := GetProfileByType(profileType, profiles)
err = matchProfiles(ctx, profileType, profile, allProfiles, profileMap, dbType)
}
if err != nil {
return
}
}
return
}


=====Explanation for the change :===== We need a function that checks if profiles are there in YAML file for or not and depending on that we need to make the further decisions. This function helps us to check that and delegate the next tasks.

matchProfiles

Previous Working : This function was not there previously.


Enhanced Working : This function does:

(a) Id level matching with profiles in allProfiles
(b) If Id level match is successful, flow proceeds to match based on versionId
When matched, the latestVersionId is overridden with the versionId as it is this attribute while dbProvisioning which is used for
profileType versionId.


Previous Code : N/A


New Code :

func matchProfiles(ctx context.Context, profileType string, profile Profile, allProfiles []ProfileResponse, profilesMap map[string]ProfileResponse, dbType string) (err error) {
log := ctrllog.FromContext(ctx)
var idMatchedProfile []ProfileResponse
var matchedVersion []Version
if isEmptyProfile(profile) {
err = PopulateDefaultProfile(ctx, profilesMap, profileType, allProfiles, dbType)
return
}
log.Info("Performing profile matching for profileType => ", "profileType", profileType)
// match based on ID
idMatchedProfile = util.Filter(allProfiles, func(p ProfileResponse) bool { return p.Id == profile.Id && p.Type == profileType })
// matching based on versionID
if len(idMatchedProfile) > 0 {
matchedVersion = util.Filter(idMatchedProfile[0].Versions, func(versions Version) bool { return versions.Id == profile.VersionId })
// when versionID level match found, override latestVersionId as it is used in the database provisioning request
if len(matchedVersion) > 0 {
log.Info("Id and VersionId matched for profileType", "profileType", profileType)
idMatchedProfile[0].LatestVersionId = profile.VersionId
}
}
err = PopulateProfileOfType(ctx, profilesMap, profileType, allProfiles, dbType, idMatchedProfile)
return
}


=====Explanation for the change :===== We use profiles in YAML file only when they have correct Id. To perform this essential task of checking the correctness of Id and after that populating the versionId, we have created this function. After checking the correctness, this function delegates the further tasks to PopulateProfileOfType function.

PopulateProfileOfType

Previous Working : This function was not there previously.


Enhanced Working : This function performs the task of populating profileMap with response (matching result) received for the profileType.


Previous Code : N/A


New Code :

func PopulateProfileOfType(ctx context.Context, profileMap map[string]ProfileResponse, profileType string, allProfiles []ProfileResponse, dbType string, response []ProfileResponse) (err error) {
log := ctrllog.FromContext(ctx)
// if response is empty, it indicates no matching profile found; hence set the default OOB profile for that type
if len(response) == 0 {
err = fmt.Errorf("No matching profile found for profileType = %s", profileType)
log.Info("Error Occurred. No enrichment performed for profile = ", "profileType", profileType)
return
}
log.Info("Going to populate profile value in profilesMap for profileType = ", "profileType", profileType)
profileMap[profileType] = response[0]
return
}


=====Explanation for the change :===== Since this function is called only after the sanity check of Id and versionId, this function just has to populate the profiles by their respective types.

PopulateDefaultProfile

Previous Working : This function was not there previously.


Enhanced Working : This method populates profileMap with the default value for the profileType.


Previous Code : N/A


New Code :

func PopulateDefaultProfile(ctx context.Context, profileMap map[string]ProfileResponse, profileType string, allProfiles []ProfileResponse, dbType string) (err error) {
log := ctrllog.FromContext(ctx)
log.Info("Going to set default profile value for profileType = ", "profileType", profileType)
genericProfiles := util.Filter(allProfiles, func(p ProfileResponse) bool { return p.EngineType == DATABASE_ENGINE_TYPE_GENERIC })
dbEngineSpecificProfiles := util.Filter(allProfiles, func(p ProfileResponse) bool { return p.EngineType == GetDatabaseEngineName(dbType) })
response, err := GetDefaultProfileForType(genericProfiles, dbEngineSpecificProfiles, profileType)
if err != nil {
return
}
profileMap[profileType] = response[0]
return
}


=====Explanation for the change :===== Since this function is called only if profiles are missing in the YAML file or have wrong profile Id, this function just has to populate the default out of the box profiles for each profile type. This function calls GetDefaultProfileForType function to get profiles for each profile type.

GetDefaultProfileForType

Previous Working : This function was not there previously.


Enhanced Working : This function gets default profile for each profile type from the result of GET API call to the NDB API.

Previous Code : N/A


New Code :

func GetDefaultProfileForType(genericProfiles []ProfileResponse, dbEngineSpecificProfiles []ProfileResponse, profileType string) (profile []ProfileResponse, err error) {
switch profileType {
case PROFILE_TYPE_COMPUTE:
profile = util.Filter(genericProfiles, func(p ProfileResponse) bool {
return p.Type == PROFILE_TYPE_COMPUTE && strings.Contains(strings.ToLower(p.Name), "small")
})
break
case PROFILE_TYPE_SOFTWARE:
profile = util.Filter(dbEngineSpecificProfiles, func(p ProfileResponse) bool { return p.Type == PROFILE_TYPE_SOFTWARE && p.Topology == TOPOLOGY_SINGLE })
break
case PROFILE_TYPE_NETWORK:
profile = util.Filter(dbEngineSpecificProfiles, func(p ProfileResponse) bool { return p.Type == PROFILE_TYPE_NETWORK })
break
case PROFILE_TYPE_DATABASE_PARAMETER:
profile = util.Filter(dbEngineSpecificProfiles, func(p ProfileResponse) bool { return p.Type == PROFILE_TYPE_DATABASE_PARAMETER })
break
case PROFILE_TYPE_STORAGE:
profile = util.Filter(genericProfiles, func(p ProfileResponse) bool { return p.Type == PROFILE_TYPE_STORAGE })
break
default:
return
}
if len(profile) == 0 {
err = errors.New("oob profile: one or more OOB profile(s) were not found")
return
}
return
}


=====Explanation for the change :===== We have to find appropriate default profile from the API call result. With the help of some util functions, this function performs this filtering task.

GetProfileByType

Previous Working : This function was not there previously.


Enhanced Working : This function just returns the appropriate costant value from the pre-defined object structures.

Previous Code : N/A


New Code :

func GetProfileByType(profileType string, profiles Profiles) Profile {
defaultEmptyProfile := Profile{}
switch profileType {
case PROFILE_TYPE_COMPUTE:
return profiles.Compute
case PROFILE_TYPE_SOFTWARE:
return profiles.Software
case PROFILE_TYPE_NETWORK:
return profiles.Network
case PROFILE_TYPE_DATABASE_PARAMETER:
return profiles.DbParam
default:
return defaultEmptyProfile
}
}


=====Explanation for the change :===== We use pre-defined object structures for reference everywhere. This function helps us to make that references correctly.


Test Plan

Test Case Scenario 1

Test case name: Provisioning of appropriate database based on provided software/compute/network/dbParams profiles

    • Description: This test case verifies that the appropriate database is provisioned based on the provided software/compute/network/dbParams profiles as input through YAML file, as expected.
    • Pre-conditions:
      • Pre-requisites are installed
      • Docker Desktop Application is running
      • Kubernetes cluster is up
      • Nutanix Test Drive is active and the cluster id and other credentials are present inside "db-operator\config\samplesdb_v1alpha1_database.yaml" and "db-operator\config\samples\secret.yaml"
      • The software/compute/network/dbParams profiles are available for input in a profiles section inside "db-operator\config\samplesdb_v1alpha1_database.yaml"
    • Test steps:
      • Run command "make install run" in the root directory of the project
      • Create secrets with command "kubectl apply -f .\config\samples\secret.yaml"
      • Provision the database with command "kubectl apply -f .\config\samplesdb_v1alpha1_database.yaml"
      • Check if the appropriate database has been provisioned on the Nutanix test drive
      • Verify that the compute/software/network/dbParams profiles of the database match the expected values based on the input parameters
    • Expected results:
      • The system provisions the appropriate database based on the configurations specified in "db-operator\config\samplesdb_v1alpha1_database.yaml"
      • The the compute/software/network/dbParams profiles match the expected values based on the input parameters
      • The test case passes successfully

Test Case Scenario 2

Test case name: Throwing error if invalid software/compute/network/dbParams profiles are given as input

    • Description: This test case verifies that error is thrown if invalid software/compute/network/dbParams profiles are provided as input through YAML file.
    • Pre-conditions:
      • Pre-requisites are installed
      • Docker Desktop Application is running
      • Kubernetes cluster is up
      • Nutanix Test Drive is active and the cluster id and other credentials are present inside "db-operator\config\samplesdb_v1alpha1_database.yaml" and "db-operator\config\samples\secret.yaml"
      • The software/compute/network/dbParams profiles are available for input in a profiles section inside "db-operator\config\samplesdb_v1alpha1_database.yaml"
    • Test steps:
      • Run command "make install run" in the root directory of the project
      • Create secrets with command "kubectl apply -f .\config\samples\secret.yaml"
      • Provision the database with command "kubectl apply -f .\config\samplesdb_v1alpha1_database.yaml"
      • Check if the database has not been provisioned on the Nutanix test drive
      • Verify that the error is thrown on the command prompt
    • Expected results:
      • The system does not provision the database
      • The error is thrown saying that the id/version id of software/compute/network/dbParams profiles is invalid
      • The test case passes successfully

Test Case Scenario 3

Test case name: Use of default software/compute/network/dbParams profiles for database provisioning when software/compute/network/dbParams profiles are not passed

    • Description: This test case verifies that the database configured uses the default software/compute/network/dbParams profiles for configuration when software/compute/network/dbParams profiles are not present in the profiles section of "db-operator\config\samplesdb_v1alpha1_database.yaml"
    • Pre-conditions:
      • Pre-requisites are installed
      • Docker Desktop Application is running
      • Kubernetes cluster is up
      • Nutanix Test Drive is active and the cluster id and other credentials are present inside "db-operator\config\samplesdb_v1alpha1_database.yaml" and "db-operator\config\samples\secret.yaml"
      • The software/compute/network/dbParams profiles are not available for input in a profiles section inside "db-operator\config\samplesdb_v1alpha1_database.yaml"
    • Test steps:
      • Run command "make install run" in the root directory of the project
      • Create secrets with command "kubectl apply -f .\config\samples\secret.yaml"
      • Provision the database with command "kubectl apply -f .\config\samplesdb_v1alpha1_database.yaml"
      • Check if the appropriate database has been provisioned on the Nutanix test drive
      • Verify that the compute/software/network/dbParams profiles of the database match the default profiles
    • Expected results:
      • The system provisions the appropriate database based on the configurations specified in "db-operator\config\samplesdb_v1alpha1_database.yaml"
      • The the compute/software/network/dbParams profiles match the default profile values
      • The test case passes successfully

Testing

Testcases were written in "db-operator\testdb_api_helpers_test.go"
Dummy Objects required for these testcases were created in "db-operator\test\testutility.go"

Testcase to check Test Scenario 1 and Test Scenario 3

func TestEnrichAndGetProfilesWhenCustomProfilesMatch(t *testing.T) {
//Set
server := GetServerTestHelper(t)
defer server.Close()
ndbclient := ndbclient.NewNDBClient("username", "password", server.URL, "", true)
//Test
dbTypes := []string{"postgres", "mysql", "mongodb"}
for _, dbType := range dbTypes {
// get custom profile based upon the database type
customProfile := GetCustomProfileForDBType(dbType)
profileMap, _ := v1alpha1.EnrichAndGetProfiles(context.Background(), ndbclient, dbType, customProfile)
//Assert
profileTypes := []string{
v1alpha1.PROFILE_TYPE_COMPUTE,
v1alpha1.PROFILE_TYPE_STORAGE,
v1alpha1.PROFILE_TYPE_SOFTWARE,
v1alpha1.PROFILE_TYPE_NETWORK,
v1alpha1.PROFILE_TYPE_DATABASE_PARAMETER,
}
for _, profileType := range profileTypes {
profile := profileMap[profileType]
//Assert that no profileType is empty
if profile == (v1alpha1.ProfileResponse{}) {
t.Errorf("Empty profile type %s for dbType %s", profileType, dbType)
}
//Assert that profile EngineType matches the database engine or the generic type
if profile.EngineType != v1alpha1.GetDatabaseEngineName(dbType) && profile.EngineType != v1alpha1.DATABASE_ENGINE_TYPE_GENERIC {
t.Errorf("Profile engine type %s for dbType %s does not match", profile.EngineType, dbType)
}
obtainedProfile := v1alpha1.GetProfileForType(profileType, customProfile)
// Ignoring Storage Profile Type as the Profile struct currently only supports compute, software, network and dbParam
if profileType != v1alpha1.PROFILE_TYPE_STORAGE && profile.Id != obtainedProfile.Id && profile.LatestVersionId != obtainedProfile.VersionId {
t.Errorf("Custom Profile Enrichment failed for profileType = %s and dbType = %s", profileType, dbType)
}
}
}
}

Code for creating Dummy Objects required for this testcase

func GetCustomProfileForDBType(dbType string) (profiles v1alpha1.Profiles) {
switch dbType {
case v1alpha1.DATABASE_TYPE_POSTGRES:
profiles = v1alpha1.Profiles{
// Custom Software Profile Name = "custom postgres software profile"
Software: v1alpha1.Profile{
Id: "12",
VersionId: "v-id-12",
},
// Custom ompute Name = "a"
Compute: v1alpha1.Profile{
Id: "1",
VersionId: "v-id-1",
},
Network: v1alpha1.Profile{
Id: "15",
VersionId: "v-id-15",
},
DbParam: v1alpha1.Profile{
Id: "18",
VersionId: "v-id-18",
},
}
return profiles


Testcase to check Test Scenario 2

func TestEnrichAndGetProfilesWhenInvalidCustomProfilesProvided(t *testing.T) {
//Set
server := GetServerTestHelper(t)
defer server.Close()
ndbclient := ndbclient.NewNDBClient("username", "password", server.URL, "", true)
//Test
dbTypes := []string{"postgres_invalid_profiles", "mysql_invalid_profiles", "mongodb_invalid_profiles"}
for _, dbType := range dbTypes {
// get custom profile based upon the database type
customProfile := GetCustomProfileForDBType(dbType)
profileMap, _ := v1alpha1.EnrichAndGetProfiles(context.Background(), ndbclient, dbType, customProfile)
//Assert
profileTypes := []string{
v1alpha1.PROFILE_TYPE_COMPUTE,
v1alpha1.PROFILE_TYPE_STORAGE,
v1alpha1.PROFILE_TYPE_SOFTWARE,
v1alpha1.PROFILE_TYPE_NETWORK,
v1alpha1.PROFILE_TYPE_DATABASE_PARAMETER,
}
for _, profileType := range profileTypes {
profile := profileMap[profileType]
//Assert that profile EngineType matches the database engine or the generic type
if profile.EngineType != v1alpha1.GetDatabaseEngineName(dbType) && profile.EngineType != v1alpha1.DATABASE_ENGINE_TYPE_GENERIC {
t.Errorf("Profile engine type %s for dbType %s does not match", profile.EngineType, dbType)
}
/* since custom profile is passed it should not default to OOB, and err should be raised stating the custom profile passed does not exist,
and thus database provisioning does not occur
  • /
if profile != (v1alpha1.ProfileResponse{}) {
t.Errorf("Incorrect Profile Match found for profile type = %s and dbType = %s", profileType, dbType)
}
}
}
}

Code for creating Dummy Objects required for this testcase

case v1alpha1.DATABASE_TYPE_MONGODB_INVALID_PROFILE, v1alpha1.DATABASE_TYPE_MYSQL_INVALID_PROFILE, v1alpha1.DATABASE_TYPE_POSTGRES_INVALID_PROFILE:
// below custom profiles do not exist and will be used for the negative scenario
profiles = v1alpha1.Profiles{
Software: v1alpha1.Profile{
Id: "140",
VersionId: "v-id-140",
},
Compute: v1alpha1.Profile{
Id: "100",
VersionId: "v-id-100",
},
Network: v1alpha1.Profile{
Id: "170",
VersionId: "v-id-170",
},
DbParam: v1alpha1.Profile{
Id: "200",
VersionId: "v-id-200",
},
}
return profiles

Github


Mentors

  • Prof. Edward F. Gehringer
  • Krunal Jhaveri
  • Manav Rajvanshi
  • Krishna Saurabh Vankadaru
  • Kartiki Bhandakkar

Contributors

  • Karan Pradeep Gala (kgala2)
  • Ashish Joshi (ajoshi24)
  • Tilak Satra (trsatra)

References

[1] Nutanix. (n.d.). Nutanix Database Service. Retrieved from https://www.nutanix.com/products/database-service

[2] Kubernetes Operator Pattern https://kubernetes.io/docs/concepts/extend-kubernetes/operator

[3] NDB Operator Document - https://docs.google.com/document/d/1-VykKyIeky3n4JciIIrNgirk-Cn4pDT1behc9Yl8Nxk/

[4] Go Operator SDK - https://sdk.operatorframework.io/docs/buildingoperators/golang/tutorial/

Retrieved from "https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_NTNX-3._Refactor_models_to_keep_profiles_(software,_compute,_network,_etc)_as_optional_and_use_default_if_not_specified&oldid=150356"