Плетение производственных классов с аспектами AspectJ в Maven только для выполнения тестов

Question

У меня есть проект со сборкой Maven, и мне нужно добавить базовую трассировку производительности в методы.Я решил использовать AspectJ для этого.Основное требование - включить аспект трассировки в производственные классы , но только для этапа выполнения модульных тестов .

Мне удалось настроить ткачество в Maven, однако после выполнения тестов те же производственные классы с примененным аспектом переходят в упакованную войну.

Дело выглядит довольно распространенным, но я не смог найтирешение для этого в сети.

Answer 1

Вы можете поместить свои аспекты в тестовую директорию и установить для флага weaveMainSourceFolder значение true в конфигурации тестовой компиляции

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>aspectj-maven-plugin</artifactId>
    <version>1.4</version>
    <configuration>
        <showWeaveInfo>true</showWeaveInfo>
        <source>1.7</source>
        <target>1.7</target>
    </configuration>
        <executions>
            <execution>
                <id>test-compile</id>
                <configuration>
                    <weaveMainSourceFolder>true</weaveMainSourceFolder>
                </configuration>
                <goals>
                    <goal>test-compile</goal>
                </goals>
            </execution>
        </executions>
    <dependencies>
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjrt</artifactId>
            <version>${aspectj.version}</version>
        </dependency>
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjtools</artifactId>
            <version>${aspectj.version}</version>
        </dependency>
    </dependencies>
</plugin>

См. http://mojo.codehaus.org/aspectj-maven-plugin/test-compile-mojo.html

Answer 2

Я решил это с помощью ткачества во время загрузки. Таким образом, переплетение происходит, когда выполняются ваши юнит-тесты (через аргумент командной строки при запуске юнит-тестов), но ваши аспекты не вплетаются в опубликованные артефакты.

Например, я хотел подделать системные часы в моих юнит-тестах, но явно не связываться с ними в живом коде. Вот мой класс аспекта:

@Aspect
public class TweakSystemAspects {
    private static long timeOffsetMillis = 0;

    public static void advanceTime(int amount, TimeUnit unit) {
        timeOffsetMillis += unit.toMillis(amount);
    }

    @Around("call (long System.currentTimeMillis())")
    public long aroundSystemTime(ProceedingJoinPoint joinPoint) throws Throwable {
        return ((Long) joinPoint.proceed()) + timeOffsetMillis;
    }
}

Очевидно, это используется в юнит-тестах, вызывая метод TweakSystemAspects.advanceTime(), чтобы имитировать течение времени в системе. Чтобы выполнить переплетение времени загрузки, мне просто нужно было создать файл aop.xml, который определил мои аспекты (и такое переплетение должно происходить во всех классах):

<aspectj>
    <aspects>
        <aspect name="com.mypackage.TweakSystemAspects"/>
    </aspects>
    <weaver options="-nowarn -Xlint:ignore"/>
    <!-- During testing this was useful, but I didn't want all that output normally. -->
    <!--<weaver options="-verbose -showWeaveInfo"/>-->
</aspectj>

Наконец, я внес изменения в свой pom-файл, чтобы объявить зависимость времени выполнения AspectJ и сообщить верному файлу время выполнения ткачества.

<project ...>
    ...
    <properties>
        ...
        <version.aspectj>1.8.10</version.aspectj>
    <properties>

    <dependencies>
        ...
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjrt</artifactId>
            <version>${version.aspectj}</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            ...
            <plugin>
                <artifactId>maven-surefire-plugin</artifactId>
                <configuration>
                    <!-- For Load Time Weaving of our AspectJ helper code -->
                    <argLine>-javaagent:${settings.localRepository}/org/aspectj/aspectjweaver/${version.aspectj}/aspectjweaver-${version.aspectj}.jar</argLine>
                    ...
                </configuration>
            </plugin>
        </plugins>
    </build>
    ...
</project>

Answer 3

На основе примера, предоставленного в Компонент AspectJ Maven Plugin - Использование должно работать что-то вроде следующего:

<project>
    ...
    <build>
        <plugins>
            ...
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>aspectj-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>test-compile</goal>
                        </goals>
                    </execution>
               </executions>
           </plugin>
           ...
       </plugins>
   <build>
   ...
</project>

Answer 4

Я бы сделал это в выделенном модуле, используя плагин Maven Dependency Plugin, чтобы распаковать артефакт «в тесте» во время фазы generate-test-sources, затем сплетить классы и, наконец, запустить тесты.

---

Позвольте мне попытаться проиллюстрировать, что я имею в виду. Давайте представим следующую структуру проекта:

.
|-- pom.xml
`-- some-module    // this is the module that we want to weave 
    |-- pom.xml    // but only for testing purpose
    `-- ...

Так что я предлагаю сделать что-то вроде этого:

.
|-- pom.xml
|-- some-module      
|   |-- pom.xml      
|   `-- ...
`-- test-module    // we're going to weave the classes here because we don't want
    |-- pom.xml    // the tracing aspect to be packaged in the "production" jar
    `-- ...

Идея состоит в том, чтобы иметь дополнительный «тест-модуль», в котором мы распаковали бы артефакт, который мы хотим проверить, чтобы мы могли плести его классы, не влияя на «реальный» рабочий контейнер.

Для этого объявите зависимость от тестируемого модуля и используйте dependency:unpack, чтобы распаковать классы в target/classes, прежде чем вызывать плагин AspectJ для переплетения "основных" классов.