* limitations under the License.
 */

package gradlebuild.binarycompatibility.rules;

import gradlebuild.binarycompatibility.upgrades.UpgradedProperty.BinaryCompatibility;
import gradlebuild.binarycompatibility.upgrades.UpgradedProperty.ReplacedAccessor;
import gradlebuild.binarycompatibility.upgrades.UpgradedProperty.AccessorKey;
import me.champeau.gradle.japicmp.report.PostProcessViolationsRule;

 */

package gradlebuild.binarycompatibility.rules;

import gradlebuild.binarycompatibility.upgrades.UpgradedProperties;
import gradlebuild.binarycompatibility.upgrades.UpgradedProperty;
import gradlebuild.binarycompatibility.upgrades.UpgradedProperty.ReplacedAccessor;
import gradlebuild.binarycompatibility.upgrades.UpgradedProperty.AccessorKey;
import me.champeau.gradle.japicmp.report.SetupRule;

  echo "!!! EXPERIMENTAL !!!"
  echo "!!! This upgrade script is not meant to be run in production !!!"
  echo ""
  echo "${0} [-M | -N | -P] [-o] (-l | <version number or publication>)"
  echo "  Upgrades master and nodes by default"
  echo "  -M:  Upgrade master only"
  echo "  -N:  Upgrade nodes only"
  echo "  -P:  Node upgrade prerequisites only (create a new instance template)"

    /**
     * Automatically accept changes that are valid property upgrades of a getter or setter.
     *
     * Here we automatically accept the following cases:
     * - A setter `setX` of an upgraded property is removed
     * - A boolean `isX` of an upgraded property is removed
     * - A new getter `getX` is added, where the old getter is a boolean getter `isX` of an upgraded property

2. We will use `bytecode upgrades` when we talk about Property or API upgrades.
3. We will use `bytecode interception` when we talk about both bytecode instrumentation or bytecode upgrades.
4. We will use `transformation` when we talk about applying some interception to to jars or classes or classpath.

It is possible that in the code we use all these terms interchangeably, but we will try to be consistent in this document.

 * limitations under the License.
 */

package org.gradle.internal.instrumentation.property.upgrades;

import org.gradle.internal.instrumentation.api.annotations.VisitForInstrumentation;

/**
 * Add classes to visit to this registry to enable property upgrade instrumentation.
 *
 * Classes that should be visited should be added to the @VisitForInstrumentation annotation, e.g.

import me.champeau.gradle.japicmp.report.Violation
import org.gradle.api.Incubating

import javax.inject.Inject

import static gradlebuild.binarycompatibility.upgrades.UpgradedProperties.SEEN_OLD_ACCESSORS_OF_UPGRADED_PROPERTIES
import static gradlebuild.binarycompatibility.upgrades.UpgradedProperty.AccessorKey

@CompileStatic
abstract class AbstractGradleViolationRule extends AbstractContextAwareViolationRule {

        because("We need a KotlinScriptBasePluginsApplicator service implementation to use Kotlin DSL scripts.")
    }
    pluginsRuntimeOnly(project(":instrumentation-declarations")) {
        because("Property upgrades for core plugins reference types on plugin classpath and that is why interceptors need to be loaded from plugins' classpath.")
    }
    pluginsRuntimeOnly(project(":unit-test-fixtures")) {

        FilterableBytecodeInterceptorFactory.InstrumentationInterceptorFactory.class
    ),

    /**
     * An interceptor that is applied to the bytecode only for upgrades.
     */
    BYTECODE_UPGRADE(
        FilterableBytecodeInterceptor.BytecodeUpgradeInterceptor.class,
        FilterableBytecodeInterceptorFactory.BytecodeUpgradeInterceptorFactory.class
    );

plugins {
    id("gradlebuild.distribution.api-java")
}

description = "Contains declarations for instrumentation of plugins. Adds interceptors, bytecode upgrades etc."

dependencies {
    // All dependencies should be compileOnly, since this project is added also to worker classpath, so we don't pollute it.
    // If we need some dependency also at runtime we need to build a separate classpath and add it to :launcher project or :distributions-core project directly.