#122 Refactoring the Foundation Core Python module; removing aiops references. #163

habibimoiz · 2024-06-21T19:36:49Z

Renamed the Foundation Metadata Core (Python) package.
Renamed the Foundation Encryption Policy (Python) package.
Renamed the Extensions Encryption Vault Python package.
Renamed the Extensions Data Delivery Spark (Python) package.
Renamed all the child directories, classes, and methods.
Corrected all the imports inside of the velocity templates to ensure a successful build of the Foundation Core Python.
Baton migration scripts for automated migrations from legacy package names to the new aiSSEMBLE landscape.

meliz19 · 2024-06-21T20:01:59Z

...ugins/mda-maven-plugin/src/main/java/com/boozallen/mda/maven/mojo/PipelineArtifactsMojo.java

@@ -12,6 +12,7 @@

 import com.boozallen.aiops.mda.generator.common.PipelineImplementationEnum;
 import com.boozallen.aiops.mda.generator.util.SemanticDataUtil;
+import com.boozallen.aiops.mda.metamodel.AIOpsModelInstanceRepostory;
 import com.boozallen.mda.maven.ArtifactType;


I'm assuming aiops is to remain for the packages in lines 13 - 15.

Yes, this a Java module. This PR is to focus on Python modules.

meliz19 · 2024-06-21T20:04:03Z

...tion-mda/src/main/java/com/boozallen/aiops/mda/generator/InferenceDockerModuleGenerator.java

@@ -10,7 +10,6 @@
 * #L%
 */

-import com.boozallen.aiops.mda.ManualActionNotificationService;
 import com.boozallen.aiops.mda.generator.common.MachineLearningStrategy;


Why are we getting rid of these imports?

I'm guessing they were not being used in that particular java file (import optimization)
but I'll leave it to Moiz to verify

Yes, that was the case. This import was removed when the foundation-mda module was built.

d-ryan-ashcraft

I assume the migrations are NOT final in the PR?

d-ryan-ashcraft · 2024-06-21T20:21:12Z

foundation/foundation-mda/src/main/resources/templates/data-delivery-pyspark/encryption.py.vm

        if(algorithm == 'VAULT_ENCRYPT'):
-            aiops_encrypt = VaultRemoteEncryptionStrategy()
+            aissemble_encrypt = VaultRemoteEncryptionStrategy()

        for record in inbound:
            for column in fields_to_update:


S: this and the following CustomRecord change look off from a quick scan...

I made these changes when my build was failing due to the Pylint implementation. I wasn't aware that I needed to run git clean -dfx in order to fix this issue. I reverted the change.

d-ryan-ashcraft · 2024-06-21T20:22:37Z

...ain/java/com/boozallen/aissemble/upgrade/migration/v1_8_0/AiopsReferencePythonMigration.java

+import java.util.stream.Collectors;
+
+import static com.boozallen.aissemble.upgrade.util.FileUtils.replaceLiteralInFile;
+


S: we'd like all classes to have a class-level comment. I generally used anything public or not obvious as my markers to add javadoc

d-ryan-ashcraft · 2024-06-21T20:24:03Z

...ain/java/com/boozallen/aissemble/upgrade/migration/v1_8_0/AiopsReferencePythonMigration.java

+import java.io.BufferedReader;
+import java.io.File;
+import java.io.FileReader;
+import java.util.*;


A: no wildcard imports please - they can have unintended consequences: https://rules.sonarsource.com/java/rspec-2208/

Updated to remove the wildcard import.

d-ryan-ashcraft · 2024-06-21T20:24:45Z

...ain/java/com/boozallen/aissemble/upgrade/migration/v1_8_0/AiopsReferencePythonMigration.java

+                }
+            }
+        } catch (Exception e) {
+            logger.error("Error in determining whether a 'AIOPS' renamed python package requires a migration.");


S: log or throw, but don't do both

d-ryan-ashcraft · 2024-06-21T20:25:14Z

...ain/java/com/boozallen/aissemble/upgrade/migration/v1_8_0/AiopsReferencePythonMigration.java

+     */
+    @Override
+    protected boolean shouldExecuteOnFile(File file) {
+        System.out.println("Inside should execute on file......*******");


S: should not be using System.out.println - use logger instead (or just remove).

If this file will be the target of the follow on ticket, recommend a preemptive comment to let the reviewer know.

d-ryan-ashcraft · 2024-06-21T20:26:30Z

...oozallen/aissemble/upgrade/migration/v1_8_0/AiopsReferencePythonPropertiesFileMigration.java

+import java.util.Map;
+
+import static com.boozallen.aissemble.upgrade.util.FileUtils.replaceLiteralInFile;
+


S: similar comment to the prior file

d-ryan-ashcraft · 2024-06-21T20:27:02Z

...len/aissemble/upgrade/migration/v1_8_0/AiopsReferencePythonPropertiesFileMigrationSteps.java

+        try {
+            isMigrated =  FileUtils.contentEquals(original, migrated);
+        } catch (Exception e) {
+            e.printStackTrace();


S: use logger

chang-annie · 2024-06-21T20:28:04Z

...oozallen/aissemble/upgrade/migration/v1_8_0/AiopsReferencePythonPropertiesFileMigration.java

+    protected boolean shouldExecuteOnFile(File file) {
+        boolean shouldExecute = false;
+
+//        getMavenProject().getPlugin("");


can remove this comment

chang-annie · 2024-06-21T20:29:27Z

...oozallen/aissemble/upgrade/migration/v1_8_0/AiopsReferencePythonPropertiesFileMigration.java

+        boolean isMigrated = false;
+
+        try {
+//            // I am not sure how to rename the file automatically, is this something that could potentially be a part of the manual upgrade instructions?


can we remove this? or is this a comment for future reference (for the follow on ticket)?

I will remove this.

aaron-gary · 2024-06-21T20:31:29Z

...oozallen/aissemble/upgrade/migration/v1_8_0/AiopsReferencePythonPropertiesFileMigration.java

+                while((lineOne = aiopsReferencePythonPropertiesFileConfig.readLine()) !=null && !shouldExecute) {
+                    for (String key : AIOPS_REFERENCE_PYTHON_PROPERTIES_FILE_PACKAGE_MAP.keySet()) {
+                        if (lineOne.contains(key)) {
+                            return true;


Would be easier to read if instead of returning, we set shouldExecute to true and have just one return statement

- Renamed the Foundation Metadata Core (Python) package. - Renamed the Foundation Encryption Policy (Python) package. - Renamed the Extensions Encryption Vault Python package. - Renamed the Extensions Data Delivery Spark (Python) package. - Renamed all the child directories, classes, and methods. - Corrected all the imports inside of the velocity templates to ensure a successful build of the Foundation Core Python. - Baton migration scripts for automated migrations from legacy package names to the new aiSSEMBLE landscape.

habibimoiz · 2024-06-21T21:11:59Z

I assume the migrations are NOT final in the PR?

The foundation-core-python module migrations are final (AiopsReferencePythonMigration.java), however, NOT the PDP migrations.

habibimoiz changed the title ~~#122 Renamed the Foundation Core Python package.~~ #122 Refactoring the Foundation Core Python module; removing aiops references. Jun 21, 2024

meliz19 reviewed Jun 21, 2024

View reviewed changes

d-ryan-ashcraft reviewed Jun 21, 2024

View reviewed changes

chang-annie reviewed Jun 21, 2024

View reviewed changes

aaron-gary reviewed Jun 21, 2024

View reviewed changes

aaron-gary approved these changes Jun 21, 2024

View reviewed changes

habibimoiz force-pushed the 122-rename-foundation-core-python branch from 97fca8c to 235ec3d Compare June 21, 2024 21:07

habibimoiz force-pushed the 122-rename-foundation-core-python branch from 235ec3d to cc04fa9 Compare June 21, 2024 21:11

d-ryan-ashcraft approved these changes Jun 21, 2024

View reviewed changes

habibimoiz merged commit ac96c84 into feature-rename-foundation-core-python Jun 21, 2024

habibimoiz deleted the 122-rename-foundation-core-python branch June 21, 2024 21:38

habibimoiz mentioned this pull request Jun 27, 2024

#122 & #169 Feature rename Foundation Core Python & Policy Decision Point Python #178

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#122 Refactoring the Foundation Core Python module; removing aiops references. #163

#122 Refactoring the Foundation Core Python module; removing aiops references. #163

habibimoiz commented Jun 21, 2024

meliz19 Jun 21, 2024

habibimoiz Jun 21, 2024

meliz19 Jun 21, 2024

aaron-gary Jun 21, 2024

habibimoiz Jun 21, 2024

d-ryan-ashcraft left a comment

d-ryan-ashcraft Jun 21, 2024

habibimoiz Jun 21, 2024

d-ryan-ashcraft Jun 21, 2024

d-ryan-ashcraft Jun 21, 2024

habibimoiz Jun 21, 2024

d-ryan-ashcraft Jun 21, 2024

d-ryan-ashcraft Jun 21, 2024

d-ryan-ashcraft Jun 21, 2024

d-ryan-ashcraft Jun 21, 2024

chang-annie Jun 21, 2024

chang-annie Jun 21, 2024

habibimoiz Jun 21, 2024

aaron-gary Jun 21, 2024 •

edited

Loading

habibimoiz commented Jun 21, 2024

		import java.util.stream.Collectors;

		import static com.boozallen.aissemble.upgrade.util.FileUtils.replaceLiteralInFile;

		import java.util.Map;

		import static com.boozallen.aissemble.upgrade.util.FileUtils.replaceLiteralInFile;

#122 Refactoring the Foundation Core Python module; removing aiops references. #163

#122 Refactoring the Foundation Core Python module; removing aiops references. #163

Conversation

habibimoiz commented Jun 21, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

d-ryan-ashcraft left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aaron-gary Jun 21, 2024 • edited Loading

Choose a reason for hiding this comment

habibimoiz commented Jun 21, 2024

aaron-gary Jun 21, 2024 •

edited

Loading