com.microsoft.azure.sdk.build.tool.AzureDependencyMapping Maven / Gradle / Ivy

Go to download
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.microsoft.azure.sdk.build.tool;

import com.microsoft.azure.sdk.build.tool.models.OutdatedDependency;
import com.microsoft.azure.sdk.build.tool.util.MavenUtils;
import org.apache.maven.artifact.Artifact;

import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collectors;

/**
 * Contains the mapping for outdated dependencies and it's replacement.
 */
public class AzureDependencyMapping {

    private static final String TRACK_ONE_GROUP_ID = "com.microsoft.azure";
    private static final String TRACK_TWO_GROUP_ID = "com.azure";

    // This map is for all com.microsoft.* group IDs, mapping them into their com.azure equivalents
    private static final Map> TRACK_ONE_REDIRECTS = new HashMap<>();
    static {
        // Cosmos
        TRACK_ONE_REDIRECTS.put("azure-cosmosdb", Collections.singletonList("azure-cosmos"));

        // Key Vault - Track 1 KeyVault library is split into three Track 2 libraries
        TRACK_ONE_REDIRECTS.put("azure-keyvault",
                Arrays.asList("azure-security-keyvault-keys",
                "azure-security-keyvault-certificates",
                "azure-security-keyvault-secrets"));

        // Blob Storage
        TRACK_ONE_REDIRECTS.put("azure-storage-blob", Collections.singletonList("azure-storage-blob"));

        // Event Hubs
        TRACK_ONE_REDIRECTS.put("azure-eventhubs", Collections.singletonList("azure-messaging-eventhubs"));
        TRACK_ONE_REDIRECTS.put("azure-eventhubs-eph", Collections.singletonList("azure-messaging-eventhubs-checkpointstore-blob"));

        // Service Bus
        TRACK_ONE_REDIRECTS.put("azure-servicebus", Collections.singletonList("azure-messaging-servicebus"));

        // Event Grid
        TRACK_ONE_REDIRECTS.put("azure-eventgrid", Collections.singletonList("azure-messaging-eventgrid"));

        // Log Analytics
        TRACK_ONE_REDIRECTS.put("azure-loganalytics", Collections.singletonList("azure-monitor-query"));
    }

    /**
     * This method will look to see if we have any recorded guidance on how to replace the given artifact with
     * something else.
     *
     * @param artifact The artifact for which we want to find a replacement
     * @return An {@link OutdatedDependency} if a replacement for the given {@code artifact} exists.
     */
    public static Optional lookupReplacement(Artifact artifact) {
        String groupId = artifact.getGroupId();
        String artifactId = artifact.getArtifactId();

        if (TRACK_ONE_GROUP_ID.equals(groupId)) {
            if (TRACK_ONE_REDIRECTS.containsKey(artifactId)) {
                final List newArtifactIds = TRACK_ONE_REDIRECTS.get(artifactId);

                List newGavs = newArtifactIds.stream()
                        .map(newArtifactId -> TRACK_TWO_GROUP_ID + ":" + newArtifactId + ":" + MavenUtils.getLatestArtifactVersion(TRACK_TWO_GROUP_ID, newArtifactId)).collect(Collectors.toList());
                return Optional.of(new OutdatedDependency(MavenUtils.toGAV(artifact), newGavs));
            } else {
                // we've hit artifact location where we don't know know if the com.microsoft.azure artifact has artifact newer
                // replacement...For now we will not give artifact failure
                return Optional.empty();
            }
        }
        return Optional.empty();
    }
}