Add an aspectj-based tracing capability to trace tuscany code

git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@683368 13f79535-47bb-0310-9956-ffa450edef68

7 files changed, 408 insertions, 0 deletions

diff --git a/java/sca/modules/tracing-aspectj/launcher.bat b/java/sca/modules/tracing-aspectj/launcher.bat
new file mode 100644
index 0000000000..a5305f486d
--- /dev/null
+++ b/java/sca/modules/tracing-aspectj/launcher.bat
@@ -0,0 +1,5 @@
+@echo off

+set TUSCANY_HOME=C:\Apache\tuscany-sca-1.3

+set ASPECTJ_WEAVER=%HOMEPATH%\.m2\repository\org\aspectj\aspectjweaver\1.6.1\aspectjweaver-1.6.1.jar

+set CP=%ASPECTJ_WEAVER%;%TUSCANY_HOME%\lib\tuscany-sca-manifest.jar;%TUSCANY_HOME%\samples\calculator\target\sample-calculator.jar

+java -javaagent:"%ASPECTJ_WEAVER%" -cp "%CP%;target\classes" calculator.CalculatorClient
\ No newline at end of file
diff --git a/java/sca/modules/tracing-aspectj/pom.xml b/java/sca/modules/tracing-aspectj/pom.xml
new file mode 100644
index 0000000000..92d651377b
--- /dev/null
+++ b/java/sca/modules/tracing-aspectj/pom.xml
@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="UTF-8"?>

+<!--

+    * Licensed to the Apache Software Foundation (ASF) under one

+    * or more contributor license agreements.  See the NOTICE file

+    * distributed with this work for additional information

+    * regarding copyright ownership.  The ASF licenses this file

+    * to you 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.    

+-->

+<project>

+    <modelVersion>4.0.0</modelVersion>

+    <parent>

+        <groupId>org.apache.tuscany.sca</groupId>

+        <artifactId>tuscany-modules</artifactId>

+        <version>1.4-SNAPSHOT</version>

+        <relativePath>../pom.xml</relativePath>

+    </parent>

+    <artifactId>tuscany-tracing-aspectj</artifactId>

+    <name>Apache Tuscany AOP-based Logging and Tracing</name>

+    <dependencies>

+        <dependency>

+            <groupId>org.aspectj</groupId>

+            <artifactId>aspectjrt</artifactId>

+            <version>1.6.1</version>

+        </dependency>

+        <dependency>

+            <groupId>org.aspectj</groupId>

+            <artifactId>aspectjlib</artifactId>

+            <version>1.6.1</version>

+        </dependency>

+        <dependency>

+            <groupId>org.aspectj</groupId>

+            <artifactId>aspectjweaver</artifactId>

+            <version>1.6.1</version>

+            <scope>test</scope>

+        </dependency>

+    </dependencies>

+    <build>

+        <plugins>

+            <!-- surefire plugin configuration -->

+            <plugin>

+                <groupId>org.apache.maven.plugins</groupId>

+                <artifactId>maven-surefire-plugin</artifactId>

+                <version>LATEST</version>

+                <configuration>

+                    <includes>

+                        <include>**/*TestCase.java</include>

+                    </includes>

+                    <reportFormat>brief</reportFormat>

+                    <useFile>false</useFile>

+                    <forkMode>once</forkMode>

+                        <!--  I hit a bug in maven-surefire-plugin 

+                        http://jira.codehaus.org/browse/SUREFIRE-128 -->

+                    <argLine>-ea -Xmx128m -javaagent:&quot;${settings.localRepository}/org/aspectj/aspectjweaver/1.6.1/aspectjweaver-1.6.1.jar&quot;</argLine>

+                </configuration>

+            </plugin>

+        </plugins>

+    </build>

+

+</project>

diff --git a/java/sca/modules/tracing-aspectj/src/main/java/org/apache/tuscany/sca/aspectj/LoggingAspect.java b/java/sca/modules/tracing-aspectj/src/main/java/org/apache/tuscany/sca/aspectj/LoggingAspect.java
new file mode 100644
index 0000000000..8ad64d498b
--- /dev/null
+++ b/java/sca/modules/tracing-aspectj/src/main/java/org/apache/tuscany/sca/aspectj/LoggingAspect.java
@@ -0,0 +1,93 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 org.apache.tuscany.sca.aspectj;
+
+import java.util.Arrays;
+
+import org.aspectj.lang.JoinPoint;
+import org.aspectj.lang.ProceedingJoinPoint;
+import org.aspectj.lang.annotation.After;
+import org.aspectj.lang.annotation.AfterReturning;
+import org.aspectj.lang.annotation.AfterThrowing;
+import org.aspectj.lang.annotation.Around;
+import org.aspectj.lang.annotation.Aspect;
+import org.aspectj.lang.annotation.Before;
+import org.aspectj.lang.annotation.Pointcut;
+
+/**
+ * @version $Rev$ $Date$
+ */
+@Aspect
+public class LoggingAspect {
+    @Pointcut("call(* org.apache.tuscany.sca..*(..)) && (!within(org.apache.tuscany.sca.aspectj.*Aspect))")
+    public void anyMethodCall() {
+    }
+    
+    @Pointcut("execution(* org.apache.tuscany.sca..*(..)) && (!within(org.apache.tuscany.sca.aspectj.*Aspect))")
+    public void anyMethodExecution() {
+    }
+    
+    @Pointcut("call(* java.util.logging.Logger.info(..))")
+    public void anyLogCall() {
+    }    
+    
+    @Pointcut("cflow(anyMethodExecution()) && anyLogCall()")
+    public void anyLog() {
+        
+    }
+    
+    // @Around("anyMethodCall() || anyLog()")
+    @Around("anyLog()")
+    public Object around(ProceedingJoinPoint jp) throws Throwable {
+        System.out.println("Around: " + jp);
+        long start = System.currentTimeMillis();
+        try {
+            return jp.proceed();
+        } finally {
+            long end = System.currentTimeMillis();
+            System.out.println("Roundtrip is " + (end - start) + "ms for " + jp.getSignature());
+        }
+
+    }
+
+    @Before("anyMethodCall()")
+    public void before(JoinPoint jp) {
+        System.out.println("Before: " + jp);
+        System.out.println("Location: " + jp.getSourceLocation());
+        System.out.println("This: " + jp.getThis());
+        System.out.println("Target: " + jp.getTarget());
+        System.out.println("Input: " + Arrays.asList(jp.getArgs()));
+    }
+
+    @After("anyMethodCall()")
+    public void after(JoinPoint jp) {
+        System.out.println("After: " + jp);
+    }
+
+    @AfterReturning(pointcut = "anyMethodCall()", returning = "result")
+    public void afterReturning(JoinPoint jp, Object result) {
+        System.out.println("After returning: " + jp + " " + result);
+    }
+
+    @AfterThrowing(pointcut = "anyMethodCall()", throwing = "e")
+    public void afterThrowing(Exception e) {
+    }
+
+}
diff --git a/java/sca/modules/tracing-aspectj/src/main/java/org/apache/tuscany/sca/aspectj/SimpleTracingAspect.java b/java/sca/modules/tracing-aspectj/src/main/java/org/apache/tuscany/sca/aspectj/SimpleTracingAspect.java
new file mode 100644
index 0000000000..67fe54f396
--- /dev/null
+++ b/java/sca/modules/tracing-aspectj/src/main/java/org/apache/tuscany/sca/aspectj/SimpleTracingAspect.java
@@ -0,0 +1,82 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 org.apache.tuscany.sca.aspectj;
+
+import java.util.Arrays;
+
+import org.aspectj.lang.JoinPoint;
+import org.aspectj.lang.annotation.Aspect;
+import org.aspectj.lang.annotation.Pointcut;
+
+/**
+ * @version $Rev$ $Date$
+ */
+@Aspect
+public class SimpleTracingAspect extends TracingAspect {
+
+    public SimpleTracingAspect() {
+        super();
+    }
+
+    @Override
+    protected void completeLog() {
+        System.out.println("completeLog()");
+    }
+
+    @Pointcut("execution(public * org.apache.tuscany.sca..*.*(..)) &&!within(java..*)")
+    protected void entry() {
+    }
+
+    @Pointcut("within(org.apache.tuscany.sca..*) && !within(org.apache.tuscany.sca.aspectj.*Aspect)")
+    protected void withinScope() {
+    }
+
+    @Override
+    protected void logEnter(JoinPoint jp) {
+        System.out.println("> " + jp.getSignature());
+        if (jp.getArgs().length != 0) {
+            System.out.println("Input: " + Arrays.asList(jp.getArgs()));
+        }
+    }
+
+    @Override
+    protected void logExit(JoinPoint jp) {
+        // System.out.println("> " + jp.getSignature());
+    }
+
+    @Override
+    protected void logException(JoinPoint jp, Throwable throwable) {
+        System.out.println("! " + jp.getSignature() + " " + throwable.getMessage());
+    }
+
+    @Override
+    protected void logExit(JoinPoint jp, Object result) {
+        System.out.println("< " + jp.getSignature());
+        if (!jp.getSignature().toString().startsWith("void ")) {
+            System.out.println("Output: " + result);
+        }
+    }
+
+    @Override
+    protected void startLog() {
+        System.out.println("startLog()");
+    }
+
+}
diff --git a/java/sca/modules/tracing-aspectj/src/main/java/org/apache/tuscany/sca/aspectj/TracingAspect.java b/java/sca/modules/tracing-aspectj/src/main/java/org/apache/tuscany/sca/aspectj/TracingAspect.java
new file mode 100644
index 0000000000..53ef73573b
--- /dev/null
+++ b/java/sca/modules/tracing-aspectj/src/main/java/org/apache/tuscany/sca/aspectj/TracingAspect.java
@@ -0,0 +1,100 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 org.apache.tuscany.sca.aspectj;
+
+import org.aspectj.lang.JoinPoint;
+import org.aspectj.lang.annotation.After;
+import org.aspectj.lang.annotation.AfterReturning;
+import org.aspectj.lang.annotation.AfterThrowing;
+import org.aspectj.lang.annotation.Aspect;
+import org.aspectj.lang.annotation.Before;
+import org.aspectj.lang.annotation.Pointcut;
+
+/**
+ * @version $Rev$ $Date$
+ */
+
+@Aspect
+public abstract class TracingAspect {
+
+    @Pointcut("")
+    protected abstract void entry();
+
+    /** ignore join points outside this scope - use within(..) */
+    @Pointcut("")
+    protected abstract void withinScope();
+
+    @Pointcut("withinScope() && call(* java..*.*(..))")
+    protected void exit() {
+    }
+
+    @Pointcut("withinScope() && entry() && !cflowbelow(entry())")
+    void start() {
+    }
+
+    @Pointcut("withinScope() && cflow(entry()) && !cflowbelow(exit()) && !within(org.apache.tuscany.sca.aspectj.*Aspect)")
+    void trace() {
+    }
+
+    @Pointcut("!handler(*) && !preinitialization(new(..))")
+    protected void supportsAfterAdvice() {
+    }
+
+    @Before("start()")
+    public void beforeStart() {
+        startLog();
+    }
+
+    @Before("trace() && supportsAfterAdvice()")
+    public void beforeTrace(JoinPoint jp) {
+        logEnter(jp);
+    }
+
+    @After("trace() && supportsAfterAdvice()")
+    public void afterTrace(JoinPoint jp) {
+        logExit(jp);
+    }
+    
+    @AfterReturning(pointcut = "trace() && supportsAfterAdvice()", returning = "result")
+    public void afterReturning(JoinPoint jp, Object result) {
+        logExit(jp, result);
+    }
+
+    @AfterThrowing(pointcut = "trace() && supportsAfterAdvice()", throwing = "e")
+    public void afterThrowing(JoinPoint jp, Throwable e) {
+        logException(jp, e);
+    }
+
+    @After("start()")
+    public void afterStart() {
+        completeLog();
+    }
+
+    protected abstract void logEnter(JoinPoint jp);
+
+    protected abstract void logExit(JoinPoint jp);
+    protected abstract void logExit(JoinPoint jp, Object result);
+    protected abstract void logException(JoinPoint jp, Throwable throwable);
+
+    protected abstract void startLog();
+
+    protected abstract void completeLog();
+
+}
diff --git a/java/sca/modules/tracing-aspectj/src/main/resources/META-INF/aop.xml b/java/sca/modules/tracing-aspectj/src/main/resources/META-INF/aop.xml
new file mode 100644
index 0000000000..60c0132e9a
--- /dev/null
+++ b/java/sca/modules/tracing-aspectj/src/main/resources/META-INF/aop.xml
@@ -0,0 +1,17 @@
+<aspectj>
+
+    <aspects>
+        <!-- declare two existing aspects to the weaver -->
+        <aspect name="org.apache.tuscany.sca.aspectj.SimpleTracingAspect" />
+        <!-- 
+        <aspect name="org.apache.tuscany.sca.aspectj.LoggingAspect" />
+         -->
+
+    </aspects>
+
+    <!--weaver options="-verbose -debug -showWeaveInfo"-->
+    <weaver options="">
+        <include within="org.apache.tuscany.sca..*" />
+    </weaver>
+
+</aspectj>
diff --git a/java/sca/modules/tracing-aspectj/src/test/java/org/apache/tuscany/sca/aspectj/TracingTestCase.java b/java/sca/modules/tracing-aspectj/src/test/java/org/apache/tuscany/sca/aspectj/TracingTestCase.java
new file mode 100644
index 0000000000..7b76faaf36
--- /dev/null
+++ b/java/sca/modules/tracing-aspectj/src/test/java/org/apache/tuscany/sca/aspectj/TracingTestCase.java
@@ -0,0 +1,41 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 org.apache.tuscany.sca.aspectj;
+
+import java.util.logging.Logger;
+
+import org.junit.Test;
+
+/**
+ * @version $Rev$ $Date$
+ */
+public class TracingTestCase  {
+
+    @Test
+    public void testAOP() {
+        Logger log = Logger.getLogger(getClass().getName());
+        System.out.println("doSomething()");
+        log.info("Hello, Log");
+    }
+
+    public static void main(String[] args) {
+        new TracingTestCase().testAOP();
+    }
+}