<?xml version="1.0" encoding="UTF-8"?>

<!--
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
-->

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>org.xwiki.commons</groupId>
    <artifactId>xwiki-commons-pom</artifactId>
    <version>9.1</version>
    <relativePath>../xwiki-commons-pom</relativePath>
  </parent>
  <artifactId>xwiki-commons-core</artifactId>
  <name>XWiki Commons - Core - Parent POM</name>
  <packaging>pom</packaging>
  <description>XWiki Commons - Core - Parent POM</description>
  <properties>
    <!-- By default check that unit tests don't output anything to the console -->
    <xwiki.surefire.captureconsole.skip>false</xwiki.surefire.captureconsole.skip>
  </properties>
  <modules>
    <!-- Sorted Alphabetically -->
    <module>xwiki-commons-blame</module>
    <module>xwiki-commons-cache</module>
    <module>xwiki-commons-classloader</module>
    <module>xwiki-commons-component</module>
    <module>xwiki-commons-configuration</module>
    <module>xwiki-commons-context</module>
    <module>xwiki-commons-crypto</module>
    <module>xwiki-commons-environment</module>
    <module>xwiki-commons-extension</module>
    <module>xwiki-commons-filter</module>
    <module>xwiki-commons-repository</module>
    <module>xwiki-commons-groovy</module>
    <module>xwiki-commons-job</module>
    <module>xwiki-commons-logging</module>
    <module>xwiki-commons-management</module>
    <module>xwiki-commons-observation</module>
    <module>xwiki-commons-properties</module>
    <module>xwiki-commons-script</module>
    <module>xwiki-commons-stability</module>
    <module>xwiki-commons-text</module>
    <module>xwiki-commons-velocity</module>
    <module>xwiki-commons-xml</module>
    <module>xwiki-commons-diff</module>
  </modules>
  <build>
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-jar-plugin</artifactId>
          <configuration>
            <archive>
              <!-- Use the manifest file generated by the OSGi Maven Bundle Plugin -->
              <manifestFile>${project.build.outputDirectory}/META-INF/MANIFEST.MF</manifestFile>
            </archive>
          </configuration>
        </plugin>
      </plugins>
    </pluginManagement>
    <plugins>
      <!-- Generate OSGi Manifest information to all JARs -->
      <plugin>
        <groupId>org.apache.felix</groupId>
        <artifactId>maven-bundle-plugin</artifactId>
        <executions>
          <execution>
            <id>bundle-manifest</id>
            <phase>process-classes</phase>
            <goals>
              <goal>manifest</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      <plugin>
        <!-- Apply the Checkstyle configurations defined in the top level pom.xml file -->
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
      </plugin>
      <plugin>
        <!-- Check license headers -->
        <groupId>com.mycila</groupId>
        <artifactId>license-maven-plugin</artifactId>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-enforcer-plugin</artifactId>
        <executions>
          <execution>
            <id>enforce-platform-rendering-isolation</id>
            <goals>
              <goal>enforce</goal>
            </goals>
            <configuration>
              <rules>
                <bannedDependencies>
                  <excludes>
                    <!-- Ensure that the XWiki Commons doesn't depend on platform -->
                    <exclude>org.xwiki.platform:*</exclude>
                    <!-- Ensure that the XWiki Commons doesn't depend on rendering -->
                    <exclude>org.xwiki.rendering:*</exclude>
                  </excludes>
                </bannedDependencies>
              </rules>
            </configuration>
          </execution>
          <!-- Verify that all org.xwiki.commons dependencies in Commons have a version specified either as:
               - ${project.version}
               - a value not starting with $ (we want to allow supporting ranges)
          -->
          <execution>
            <id>check-dependency-version</id>
            <goals>
              <goal>enforce</goal>
            </goals>
            <configuration>
              <rules>
                <validateDependencyVersion implementation="org.xwiki.tool.enforcer.ValidateDependencyVersion">
                  <versionCheck>
                    <groupIdPrefix>org.xwiki.commons</groupIdPrefix>
                    <allowedVersionRegex>\$\{project.version\}|[^$].*</allowedVersionRegex>
                  </versionCheck>
                </validateDependencyVersion>
              </rules>
            </configuration>
          </execution>
        </executions>
      </plugin>
      <plugin>
        <groupId>org.revapi</groupId>
        <artifactId>revapi-maven-plugin</artifactId>
        <configuration>
          <analysisConfiguration><![CDATA[
            {
              "revapi": {
                "java": {
                  "filter": {
                    "packages": {
                      "regex": true,
                      // Note that we currently don't include non-XWiki classes in the checks, the reason being that
                      // third-party deps break backward-compat or source compat all the time and we would need to have
                      // excludes all the time. So we currently trust them that the breakages are not real breakages
                      // that will affect us. We should probably improve this in the future.
                      "include": ["org\\.xwiki\\..*"],
                      "exclude": ["org\\.xwiki\\..*\\.internal(\\..*)?", "org\\.xwiki\\..*\\.test(\\..*)?"]
                    }
                  }
                },
                "ignore" : [
                  {
                    "code": "java.annotation.removed",
                    "annotationType": "org.xwiki.stability.Unstable",
                    "justification": "These are marker annotations that have no semantical consequences."
                  },
                  {
                    "code": "java.annotation.added",
                    "annotationType": "org.xwiki.stability.Unstable",
                    "justification": "Not a breakage. Indicates API readiness only and has no semantic consequences."
                  },
                  // The "externalClassExposedInAPI" check is used to detect code smells. It's documented as:
                  // "This is reported for classes from dependencies that are exposed in the API (for example as a
                  // return value). This is generally discouraged practice because it makes updating the dependency
                  // version a more complex task (you want a bugfix but you don’t want the changed API to leak to your
                  // users)."
                  // In the case of XWiki it's not a problem because we release all modules together using the same
                  // versioning. However we still want to detect this for non XWiki classes.
                  {
                    "regex": true,
                    "code": "java\.class\.externalClassExposedInAPI",
                    "package": "org\.xwiki\..*",
                    "justification": "Dragging of other XWiki types to the API is OK."
                  },
                  {
                    "code": "java.field.serialVersionUIDUnchanged",
                    "old": "field org.xwiki.extension.ExtensionId.serialVersionUID",
                    "new": "field org.xwiki.extension.ExtensionId.serialVersionUID",
                    "package": "org.xwiki.extension",
                    "classSimpleName": "ExtensionId",
                    "fieldName": "serialVersionUID",
                    "elementKind": "field",
                    "justification": "The ExtensionId.hashCode field was wrongly introduced as non transient and
                      deserializing some data serialized with the previous XWiki version should at worse initialize it
                      to the default value which is -1 and ok. In any case we're using the ignoreUnknownElements()
                      option on the XStream side so we should be ok anyway!"
                  },
                  {
                    "code": "java.field.serialVersionUIDUnchanged",
                    "old": "field org.xwiki.extension.job.AbstractExtensionRequest.serialVersionUID",
                    "new": "field org.xwiki.extension.job.AbstractExtensionRequest.serialVersionUID",
                    "package": "org.xwiki.extension.job",
                    "classSimpleName": "AbstractExtensionRequest",
                    "fieldName": "serialVersionUID",
                    "elementKind": "field",
                    "justification": "Does not break anything: new static field with no impact on the serialization/unserialization"
                  }

                  // Add more ignores below...
                ]
              }
            }
          ]]></analysisConfiguration>
        </configuration>
      </plugin>
      <!-- Verify that unit tests don't output anything to stdout/stderr -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <configuration>
          <systemProperties combine.children="append">
            <!-- This property makes it simple for some module to exclude the check (for example for functional
                 tests) -->
            <property>
              <name>xwiki.surefire.captureconsole.skip</name>
              <value>${xwiki.surefire.captureconsole.skip}</value>
            </property>
          </systemProperties>
          <properties>
            <property>
              <name>listener</name>
              <value>org.xwiki.test.CaptureConsoleRunListener</value>
            </property>
          </properties>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.xwiki.commons</groupId>
            <artifactId>xwiki-commons-tool-test-simple</artifactId>
            <version>${project.version}</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
  <profiles>
    <!-- Profile to build Legacy modules -->
    <profile>
      <id>legacy</id>
      <modules>
        <module>xwiki-commons-legacy</module>
      </modules>
    </profile>
    <profile>
      <id>clover</id>
      <properties>
        <!-- Don't check that unit tests don't output anything to the console since for example Clover will output
             messages such as "Updating existing database at '...'." during tests! -->
        <xwiki.surefire.captureconsole.skip>true</xwiki.surefire.captureconsole.skip>
      </properties>
    </profile>
  </profiles>
</project>