Merge pull request #743 from bohdan-harniuk/uct-api-coverage-index

eduard13 · web-flow · commit 01db38f61f89 · 2021-11-10T14:29:53.000+02:00
UCT-703: Added API coverage index, indexed Magento 2.3.0-2.4.3
diff --git a/resources/uct/api/indexes.API_COVERAGE.idc b/resources/uct/api/indexes.API_COVERAGE.idc
diff --git a/src/com/magento/idea/magento2uct/packages/IndexRegistry.java b/src/com/magento/idea/magento2uct/packages/IndexRegistry.java
@@ -5,8 +5,10 @@
 
 package com.magento.idea.magento2uct.packages;
 
+import com.magento.idea.magento2uct.versioning.indexes.data.ApiCoverageStateIndex;
 import com.magento.idea.magento2uct.versioning.indexes.data.DeprecationStateIndex;
 import com.magento.idea.magento2uct.versioning.indexes.data.ExistenceStateIndex;
+import com.magento.idea.magento2uct.versioning.processors.ApiCoverageIndexProcessor;
 import com.magento.idea.magento2uct.versioning.processors.DeprecationIndexProcessor;
 import com.magento.idea.magento2uct.versioning.processors.ExistenceIndexProcessor;
 import com.magento.idea.magento2uct.versioning.processors.IndexProcessor;
@@ -26,6 +28,11 @@ public enum IndexRegistry {
             ExistenceStateIndex.class,
             new ExistenceIndexProcessor(),
             SupportedVersion.getSupportedVersions().toArray(new String[0])
+    ),
+    API_COVERAGE(
+            ApiCoverageStateIndex.class,
+            new ApiCoverageIndexProcessor(),
+            SupportedVersion.getSupportedVersions().toArray(new String[0])
     );
 
     private final String key;
diff --git a/src/com/magento/idea/magento2uct/packages/SupportedVersion.java b/src/com/magento/idea/magento2uct/packages/SupportedVersion.java
@@ -5,6 +5,7 @@
 
 package com.magento.idea.magento2uct.packages;
 
+import java.util.ArrayList;
 import java.util.LinkedList;
 import java.util.List;
 import org.jetbrains.annotations.NotNull;
@@ -82,4 +83,23 @@ public static List<String> getSupportedVersions() {
 
         return versions;
     }
+
+    /**
+     * Get previous versions.
+     *
+     * @param version SupportedVersion
+     *
+     * @return List[SupportedVersion]
+     */
+    public static List<SupportedVersion> getPriorVersions(final SupportedVersion version) {
+        final List<SupportedVersion> previousVersions = new ArrayList<>();
+
+        for (final SupportedVersion supportedVersion : SupportedVersion.values()) {
+            if (supportedVersion.compareTo(version) < 0) {
+                previousVersions.add(supportedVersion);
+            }
+        }
+
+        return previousVersions;
+    }
 }
diff --git a/src/com/magento/idea/magento2uct/ui/ReindexDialog.form b/src/com/magento/idea/magento2uct/ui/ReindexDialog.form
@@ -7,7 +7,7 @@
     </constraints>
     <properties>
       <enabled value="true"/>
-      <preferredSize width="380" height="130"/>
+      <preferredSize width="380" height="180"/>
     </properties>
     <border type="none"/>
     <children>
diff --git a/src/com/magento/idea/magento2uct/ui/ReindexDialog.java b/src/com/magento/idea/magento2uct/ui/ReindexDialog.java
@@ -139,6 +139,7 @@ private void createUIComponents() {
             targetVersion.addItem(new ComboBoxItemData(version, version));
         }
         targetIndex = new ComboBox<>();
+        targetIndex.addItem(new ComboBoxItemData("", " --- Choose Target Index --- "));
 
         for (final String key : IndexRegistry.getIndexList()) {
             targetIndex.addItem(new ComboBoxItemData(key, key));
diff --git a/src/com/magento/idea/magento2uct/versioning/indexes/data/ApiCoverageStateIndex.java b/src/com/magento/idea/magento2uct/versioning/indexes/data/ApiCoverageStateIndex.java
@@ -0,0 +1,145 @@
+/*
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+package com.magento.idea.magento2uct.versioning.indexes.data;
+
+import com.intellij.openapi.util.Pair;
+import com.magento.idea.magento2uct.packages.IndexRegistry;
+import com.magento.idea.magento2uct.packages.SupportedVersion;
+import com.magento.idea.magento2uct.versioning.indexes.storage.FileLoader;
+import com.magento.idea.magento2uct.versioning.indexes.storage.IndexLoader;
+import com.magento.idea.magento2uct.versioning.indexes.storage.ResourceLoader;
+import com.magento.idea.magento2uct.versioning.processors.util.VersioningDataOperationsUtil;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import org.jetbrains.annotations.NotNull;
+
+public class ApiCoverageStateIndex implements VersionStateIndex {
+
+    private static final String RESOURCE_DIR = "api";
+
+    private final Map<String, Map<String, Boolean>> data;
+    private final Map<String, String> changelog = new HashMap<>();//NOPMD
+    private String projectBasePath;
+    private String version;//NOPMD
+
+    public ApiCoverageStateIndex() {
+        data = new LinkedHashMap<>();
+    }
+
+    /**
+     * Set project base path.
+     *
+     * @param projectBasePath String
+     */
+    public void setProjectBasePath(final @NotNull String projectBasePath) {
+        this.projectBasePath = projectBasePath;
+    }
+
+    /**
+     * Get version state after lookup.
+     *
+     * @return String
+     */
+    public String getVersion() {
+        return version;
+    }
+
+    /**
+     * Get API coverage index data.
+     *
+     * @return Map[String, Boolean]
+     */
+    public Map<String, Boolean> getIndexData() {
+        final Pair<Map<String, Boolean>, Map<String, String>> gatheredData =
+                VersioningDataOperationsUtil.unionVersionDataWithChangelog(
+                        data,
+                        new ArrayList<>(Collections.singletonList(
+                                SupportedVersion.V230.getVersion()
+                        )),
+                        true
+                );
+
+        return gatheredData.getFirst();
+    }
+
+    @Override
+    public void load(final @NotNull List<SupportedVersion> versions) {
+        final IndexLoader<String, Map<String, Boolean>> loader = new ResourceLoader<>(RESOURCE_DIR);
+        processLoading(versions, loader);
+    }
+
+    @Override
+    public void loadFromFile(final @NotNull List<SupportedVersion> versions) {
+        if (projectBasePath == null) {
+            throw new IllegalArgumentException(
+                    "Project base path is mandatory for loading index data from the file."
+            );
+        }
+        final IndexLoader<String, Map<String, Boolean>> loader = new FileLoader<>(projectBasePath);
+        processLoading(versions, loader);
+    }
+
+    /**
+     * Process index loading.
+     *
+     * @param versions List[SupportedVersion]
+     * @param loader IndexLoader
+     */
+    private void processLoading(
+            final @NotNull List<SupportedVersion> versions,
+            final IndexLoader<String, Map<String, Boolean>> loader
+    ) {
+        final IndexRegistry apiIndexInfo = IndexRegistry.getRegistryInfoByClass(
+                ApiCoverageStateIndex.class
+        );
+        assert apiIndexInfo != null;
+
+        final String apiIndexesFileName = VersionStateIndex.SINGLE_FILE_NAME_PATTERN
+                .replace("%key", apiIndexInfo.getKey());
+
+        try {
+            final Map<String, Map<String, Boolean>> loadedData = loader.load(apiIndexesFileName);
+
+            if (loadedData == null) {
+                return;
+            }
+
+            for (final Map.Entry<String, Map<String, Boolean>> loadedEntry
+                    : loadedData.entrySet()) {
+                final SupportedVersion loadedVersion = SupportedVersion.getVersion(
+                        loadedEntry.getKey()
+                );
+
+                if (loadedVersion == null || !versions.contains(loadedVersion)) {
+                    continue;
+                }
+                putIndexData(loadedVersion.getVersion(), loadedEntry.getValue());
+            }
+        } catch (IOException | ClassNotFoundException exception) { //NOPMD
+            // Just go for the next version.
+        }
+    }
+
+    /**
+     * Put index for version.
+     *
+     * @param version String
+     * @param indexData Map
+     */
+    private void putIndexData(
+            final @NotNull String version,
+            final Map<String, Boolean> indexData
+    ) {
+        if (indexData != null) {
+            data.put(version, indexData);
+        }
+    }
+}
diff --git a/src/com/magento/idea/magento2uct/versioning/indexes/data/DeprecationStateIndex.java b/src/com/magento/idea/magento2uct/versioning/indexes/data/DeprecationStateIndex.java
@@ -6,7 +6,6 @@
 package com.magento.idea.magento2uct.versioning.indexes.data;
 
 import com.intellij.openapi.util.Pair;
-import com.magento.idea.magento2plugin.magento.packages.File;
 import com.magento.idea.magento2uct.packages.IndexRegistry;
 import com.magento.idea.magento2uct.packages.SupportedVersion;
 import com.magento.idea.magento2uct.versioning.indexes.storage.FileLoader;
@@ -21,8 +20,7 @@
 
 public class DeprecationStateIndex implements VersionStateIndex {
 
-    private static final String RESOURCE_PATH = File.separator + "uct"
-            + File.separator + "deprecation" + File.separator;
+    private static final String RESOURCE_DIR = "deprecation";
 
     private final Map<String, Map<String, Boolean>> versioningData;
     private String projectBasePath;
@@ -73,7 +71,7 @@ public String getVersion() {
 
     @Override
     public void load(final @NotNull List<SupportedVersion> versions) {
-        final IndexLoader<String, Boolean> loader = new ResourceLoader<>();
+        final IndexLoader<String, Boolean> loader = new ResourceLoader<>(RESOURCE_DIR);
         processLoading(versions, loader);
     }
 
@@ -123,7 +121,7 @@ private void processLoading(
                     .replace("%version", version.getVersion())
                     .replace("%key", registrationInfo.getKey());
             try {
-                putIndexData(version.getVersion(), loader.load(RESOURCE_PATH + indexName));
+                putIndexData(version.getVersion(), loader.load(indexName));
             } catch (IOException | ClassNotFoundException exception) { //NOPMD
                 // Just go for the next version.
             }
diff --git a/src/com/magento/idea/magento2uct/versioning/indexes/data/ExistenceStateIndex.java b/src/com/magento/idea/magento2uct/versioning/indexes/data/ExistenceStateIndex.java
@@ -5,7 +5,6 @@
 
 package com.magento.idea.magento2uct.versioning.indexes.data;
 
-import com.magento.idea.magento2plugin.magento.packages.File;
 import com.magento.idea.magento2uct.packages.IndexRegistry;
 import com.magento.idea.magento2uct.packages.SupportedVersion;
 import com.magento.idea.magento2uct.versioning.indexes.storage.FileLoader;
@@ -21,8 +20,7 @@
 
 public class ExistenceStateIndex implements VersionStateIndex {
 
-    private static final String RESOURCE_PATH = File.separator + "uct"
-            + File.separator + "existence" + File.separator;
+    private static final String RESOURCE_DIR = "existence";
 
     private final Map<String, Map<String, Boolean>> data;
     private String projectBasePath;
@@ -81,7 +79,7 @@ public Map<String, Boolean> getIndexData() {
 
     @Override
     public void load(final @NotNull List<SupportedVersion> versions) {
-        final IndexLoader<String, Map<String, Boolean>> loader = new ResourceLoader<>();
+        final IndexLoader<String, Map<String, Boolean>> loader = new ResourceLoader<>(RESOURCE_DIR);
         processLoading(versions, loader);
     }
 
@@ -115,9 +113,7 @@ private void processLoading(
                 .replace("%key", registrationInfo.getKey());
 
         try {
-            final Map<String, Map<String, Boolean>> loadedData = loader.load(
-                    RESOURCE_PATH + indexesFileName
-            );
+            final Map<String, Map<String, Boolean>> loadedData = loader.load(indexesFileName);
 
             if (loadedData == null) {
                 return;
diff --git a/src/com/magento/idea/magento2uct/versioning/indexes/storage/ResourceLoader.java b/src/com/magento/idea/magento2uct/versioning/indexes/storage/ResourceLoader.java
@@ -5,6 +5,7 @@
 
 package com.magento.idea.magento2uct.versioning.indexes.storage;
 
+import com.magento.idea.magento2plugin.magento.packages.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.ObjectInputStream;
@@ -15,12 +16,26 @@
 
 public class ResourceLoader<K, V> implements IndexLoader<K, V> {
 
+    private static final String BASE_PATH = File.separator + "uct";
+
+    private final String resourcePath;
+
+    /**
+     * Resource loader constructor.
+     *
+     * @param baseDir String
+     */
+    public ResourceLoader(final @NotNull String baseDir) {
+        resourcePath = BASE_PATH + File.separator + baseDir + File.separator;
+    }
+
     @Override
     public @Nullable Map<K, V> load(final @NotNull String resourceName)
             throws IOException, ClassNotFoundException {
         ObjectInputStream objectInputStream = null;
+        final String path = resourcePath + resourceName;
 
-        try (InputStream inputStream = getClass().getResourceAsStream(resourceName)) { // NOPMD
+        try (InputStream inputStream = getClass().getResourceAsStream(path)) { // NOPMD
             if (inputStream == null) {
                 return null;
             }
diff --git a/src/com/magento/idea/magento2uct/versioning/processors/ApiCoverageIndexProcessor.java b/src/com/magento/idea/magento2uct/versioning/processors/ApiCoverageIndexProcessor.java
diff --git a/src/com/magento/idea/magento2uct/versioning/processors/util/VersioningDataOperationsUtil.java b/src/com/magento/idea/magento2uct/versioning/processors/util/VersioningDataOperationsUtil.java

Original file line number	Diff line number	Diff line change
`@@ -139,6 +139,7 @@ private void createUIComponents() {`
`139`	`139`	`targetVersion.addItem(new ComboBoxItemData(version, version));`
`140`	`140`	`}`
`141`	`141`	`targetIndex = new ComboBox<>();`
	`142`	`+ targetIndex.addItem(new ComboBoxItemData("", " --- Choose Target Index --- "));`
`142`	`143`
`143`	`144`	`for (final String key : IndexRegistry.getIndexList()) {`
`144`	`145`	`targetIndex.addItem(new ComboBoxItemData(key, key));`