src/com/google/gct/testing/dimension/ApiDimension.java

/*
 * Copyright (C) 2014 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.google.gct.testing.dimension;

import com.google.api.services.testing.model.AndroidDeviceCatalog;
import com.google.api.services.testing.model.AndroidVersion;
import com.google.api.services.testing.model.Date;
import com.google.api.services.testing.model.Distribution;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Predicate;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
import com.google.common.collect.Ordering;
import com.google.gct.testing.CloudConfigurationImpl;
import icons.AndroidIcons;
import org.jetbrains.android.facet.AndroidFacet;

import javax.swing.*;
import java.util.*;

import static com.google.gct.testing.launcher.CloudAuthenticator.getAndroidDeviceCatalog;

public class ApiDimension extends CloudConfigurationDimension {

  public static final String DISPLAY_NAME = "Platform";

  //public static final ApiLevel KITKAT_19 =
  //  new ApiLevel("KitKat", "4.4.3", 19, ImmutableMap.of("Release date", "October 2013", "Market share", "13.6%"));
  //public static final ApiLevel JELLY_BEAN_18 =
  //  new ApiLevel("Jelly Bean", "4.3.1", 18, ImmutableMap.of("Release date", "July 2013", "Market share", "10.3%"));
  //public static final ApiLevel JELLY_BEAN_17 =
  //  new ApiLevel("Jelly Bean", "4.2.2", 17, ImmutableMap.of("Release date", "November 2012", "Market share", "19.1%"));
  //public static final ApiLevel JELLY_BEAN_16 =
  //  new ApiLevel("Jelly Bean", "4.1.2", 16, ImmutableMap.of("Release date", "July 2012", "Market share", "29.0%"));
  //public static final ApiLevel ICE_CREAM_SANDWICH_15 =
  //  new ApiLevel("Ice Cream Sandwich", "4.0.4", 15, ImmutableMap.of("Release date", "December 2011", "Market share", "12.3% (all Ice Cream Sandwich)"));
  //public static final ApiLevel ICE_CREAM_SANDWICH_14 =
  //  new ApiLevel("Ice Cream Sandwich", "4.0.2", 14, ImmutableMap.of("Release date", "October 2011", "Market share", "12.3% (all Ice Cream Sandwich)"));
  //public static final ApiLevel GINGERBREAD_10 =
  //  new ApiLevel("Gingerbread", "2.3.7", 10, ImmutableMap.of("Release date", "February 2011", "Market share", "14.9% (all Gingerbread)"));
  //public static final ApiLevel GINGERBREAD_9 =
  //  new ApiLevel("Gingerbread", "2.3.2", 9, ImmutableMap.of("Release date", "December 2010", "Market share", "14.9% (all Gingerbread)"));
  //public static final ApiLevel FROYO_8 =
    //  new ApiLevel("Froyo", "2.2.3", 8, ImmutableMap.of("Release date", "May 2010", "Market share", "0.8%"));
  //
  //private static final Set<ApiLevel> BACKEND_SUPPORTED_API_VERSIONS =
  //  ImmutableSet.of(KITKAT_19, JELLY_BEAN_18, JELLY_BEAN_17, JELLY_BEAN_16, ICE_CREAM_SANDWICH_15, ICE_CREAM_SANDWICH_14);

  private static ImmutableList<ApiLevel> FULL_DOMAIN;
  private static ApiLevel defaultApi;
  private final int minSdkVersion;


  public ApiDimension(CloudConfigurationImpl googleCloudTestingConfiguration, AndroidFacet facet) {
    super(googleCloudTestingConfiguration);
    minSdkVersion = facet.getAndroidModuleInfo().getMinSdkVersion().getApiLevel();
    // facet.getManifest().getUsesSdks().get(0).getMinSdkVersion() would read the app's manifest min SDK rather than the global one.
  }

  @VisibleForTesting
  public ApiDimension(CloudConfigurationImpl googleCloudTestingConfiguration, int minSdkVersion) {
    super(googleCloudTestingConfiguration);
    this.minSdkVersion = minSdkVersion;
  }

  @Override
  public List<? extends CloudTestingType> getAppSupportedDomain() {
    return Lists.newArrayList(Iterables.filter(getFullDomain(), new Predicate<CloudTestingType>() {
      @Override
      public boolean apply(CloudTestingType input) {
        if (input instanceof ApiLevel) {
          return ((ApiLevel)input).apiVersion >= minSdkVersion;
        }
        return false;
      }
    }));
  }

  @Override
  public List<? extends CloudTestingType> getSupportedDomain() {
    return Lists.newArrayList(Iterables.filter(getAppSupportedDomain(), new Predicate<CloudTestingType>() {
      @Override
      public boolean apply(CloudTestingType type) {
        //return BACKEND_SUPPORTED_API_VERSIONS.contains(type);
        return true;
      }
    }));
  }

  public static List<? extends CloudTestingType> getFullDomain() {
    if (isFullDomainMissing() || shouldPollDiscoveryTestApi(DISPLAY_NAME)) {
      List<ApiLevel> apiLevels = new LinkedList<ApiLevel>();
      AndroidDeviceCatalog androidDeviceCatalog = getAndroidDeviceCatalog();
      if (androidDeviceCatalog != null) {
        for (AndroidVersion version : androidDeviceCatalog.getVersions()) {
          Map<String, String> details = new HashMap<String, String>();
          Date date = version.getReleaseDate();
          details.put("Release date",
                      date == null ? "???" : String.format("%4d-%02d-%02d", date.getYear(), date.getMonth(), date.getDay()));
          Distribution distribution = version.getDistribution();
          details.put("Market share", distribution == null ? "???" : distribution.getMarketShare() + "%");
          ApiLevel apiLevel =
            new ApiLevel(version.getId(), version.getCodeName(), version.getVersionString(), version.getApiLevel(), details);
          apiLevels.add(apiLevel);
          List<String> tags = version.getTags();
          if (tags != null && tags.contains("default")) {
            defaultApi = apiLevel;
          }
        }
      }
      // Do not reset a valid full domain if some intermittent issues happened.
      if (isFullDomainMissing() || !apiLevels.isEmpty()) {
        // Sort them in descending order of api version.
        FULL_DOMAIN = ImmutableList.copyOf(Ordering.from(API_LEVEL_COMPARATOR).reverse().sortedCopy(apiLevels));
      }
      resetDiscoveryTestApiUpdateTimestamp(DISPLAY_NAME);
    }
    return FULL_DOMAIN;
  }

  private static boolean isFullDomainMissing() {
    return FULL_DOMAIN == null || FULL_DOMAIN.isEmpty();
  }

  private static ApiLevel getDefaultApi() {
    if (defaultApi == null) {
      getFullDomain();
    }
    return defaultApi;
  }

  public void enableDefault() {
    if (getDefaultApi() == null) {
      return;
    }
    List<? extends CloudTestingType> appSupportedDomain = getAppSupportedDomain();
    if (appSupportedDomain.contains(defaultApi)) {
      enable(defaultApi);
    } else if (!appSupportedDomain.isEmpty()) {
      enable(appSupportedDomain.get(0));
    }
  }

  @Override
  public String getDisplayName() {
    return DISPLAY_NAME;
  }

  @Override
  public String getId() {
    return "APILEVEL";
  }

  @Override
  public Icon getIcon() {
    return AndroidIcons.SdkManager;
  }

  public static class ApiLevel extends CloudTestingType {

    private final String id;
    private final String codeName;
    private final String osVersion;
    private final int apiVersion;

    public ApiLevel(String id, String codeName, String osVersion, int apiVersion, Map<String, String> details) {
      this.id = id;
      this.codeName = codeName;
      this.osVersion = osVersion;
      this.details = details;
      this.apiVersion = apiVersion;
    }

    @Override
    public String getConfigurationDialogDisplayName() {
      return String.format("Android %s - %s (API %d)", osVersion, codeName, apiVersion);
    }

    @Override
    public String getId() {
      return id;
    }
  }

  private static final Comparator<ApiLevel> API_LEVEL_COMPARATOR = new Comparator<ApiLevel>() {
    @Override
    public int compare(ApiLevel level1, ApiLevel level2) {
      return level1.apiVersion - level2.apiVersion;
    }
  };
}