com.jetbrains.pluginverifier.options.PluginsSet.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of verifier-cli Show documentation

Command-line interface for JetBrains Plugin Verifier with set of high-level tasks for plugin and IDE validation

There is a newer version: 1.379

/*
 * Copyright 2000-2020 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
 */

package com.jetbrains.pluginverifier.options

import com.jetbrains.plugin.structure.intellij.plugin.IdePlugin
import com.jetbrains.pluginverifier.options.filter.DeprecatedPluginFilter
import com.jetbrains.pluginverifier.options.filter.PluginFilter
import com.jetbrains.pluginverifier.repository.PluginInfo
import com.jetbrains.pluginverifier.repository.repositories.local.LocalPluginRepository
import com.jetbrains.pluginverifier.tasks.InvalidPluginFile

/**
 * Set of plugins to be verified and to be ignored,
 * which is filled on the verification command parsing.
 *
 * After the data of this class is filled, [pluginsToCheck] returns
 * the actual set of plugins to be verified.
 */
data class PluginsSet(
  /**
   * All plugins scheduled for the verification.
   *
   * Some of these plugins may be excluded later by [pluginFilters].
   *
   * The plugins listed here are not necessarily valid,
   * but it may be unknown until the verification starts.
   */
  private val scheduledPlugins: MutableList = arrayListOf(),

  /**
   * Plugin filters that determine which plugins should be verified.
   *
   * By default, the list is initialized with [DeprecatedPluginFilter].
   */
  private val pluginFilters: MutableList = arrayListOf(DeprecatedPluginFilter())

) {

  /**
   * Evaluates the actual set of plugins to be verified
   * in the upcoming verification task.
   */
  val pluginsToCheck: List
    get() = scheduledPlugins.filter { plugin ->
      pluginFilters.all { it.shouldVerifyPlugin(plugin) == PluginFilter.Result.Verify }
    }

  /**
   * Contains reasons why the plugins were ignored from the verification.
   */
  val ignoredPlugins: Map
    get() = scheduledPlugins.asSequence().mapNotNull { plugin ->
      val ignoreReason = getReasonToNotVerify(plugin)
      if (ignoreReason != null) {
        plugin to ignoreReason
      } else {
        null
      }
    }.toMap()

  private fun getReasonToNotVerify(pluginInfo: PluginInfo): String? {
    return pluginFilters.asSequence()
      .map { it.shouldVerifyPlugin(pluginInfo) }
      .filterIsInstance()
      .firstOrNull()
      ?.reason
  }

  fun shouldVerifyPlugin(pluginInfo: PluginInfo): Boolean {
    return getReasonToNotVerify(pluginInfo) != null
  }

  /**
   * Plugins' files that have been specified for check
   * but are not valid plugins
   */
  val invalidPluginFiles: MutableList = arrayListOf()

  val localRepository = LocalPluginRepository()

  fun addPluginFilter(pluginFilter: PluginFilter) {
    pluginFilters += pluginFilter
  }

  fun schedulePlugin(pluginInfo: PluginInfo) {
    scheduledPlugins += pluginInfo
  }

  fun scheduleLocalPlugin(idePlugin: IdePlugin) {
    schedulePlugin(localRepository.addLocalPlugin(idePlugin))
  }

  fun schedulePlugins(pluginInfos: Iterable) {
    scheduledPlugins.addAll(pluginInfos)
  }

  override fun toString(): String {
    //Evaluate pluginsToCheck once to avoid double work.
    val plugins = pluginsToCheck
    return """
        |Plugins (${plugins.size}): [${plugins.joinToString()}]
        |Ignored : [${ignoredPlugins.keys.joinToString()}]
    """.trimMargin()
  }

}