aboutsummaryrefslogtreecommitdiffstats
path: root/api/src/test/java/org/semver/jardiff/DeprecateDetectionTest.java
blob: a85a52ebc046d1c30b32f6f8a6b37d492af9f55a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
/**
 * Copyright 2012-2014 Julien Eluard and contributors
 * This project includes software developed by Julien Eluard: https://github.com/jeluard/
 *
 * Licensed 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.semver.jardiff;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;

import junit.framework.Assert;
import org.junit.Test;
import org.objectweb.asm.ClassReader;
import org.osjava.jardiff.ClassInfo;
import org.osjava.jardiff.JarDiff;
import org.osjava.jardiff.SimpleDiffCriteria;
import org.semver.Delta.Deprecate;
import org.semver.Delta.Difference;
import org.semver.Dumper;

public class DeprecateDetectionTest {

  public static abstract class InheritanceRoot {
    public abstract void aMethod();
  }

  public static class DirectDescendant extends InheritanceRoot {
    @Override
    public void aMethod() {}
  }

  public static class ClassA extends InheritanceRoot {
    @Override
    public void aMethod() {}
    
    public int aField = 0;
  }

  public static class ClassB extends DirectDescendant {
	  @Override
	  @Deprecated
	  public void aMethod() {}
	  
	  @Deprecated
	  public int aField = 0;
  }

  @Test
  public void shouldInheritedMethodMatchImplementedMethod() throws Exception {
    /**
     * The situation we are testing is as follows:
     * Abstract class InheritanceRoot is initially implemented directly by ClassA.
     * ClassA is later modified to extend another implementation of InheritanceRoot
     * and the methods required by InheritanceRoot are now removed from ClassA directly,
     * and instead inherited from the new parent, DirectDescendant. For the purposes of
     * this test, this new ClassA is represented by ClassB (as we can't have the same
     * class declared twice in a test -- in real life, this would both be ClassA's,
     * in different jars).
     */
    Map<String, ClassInfo> oldClassInfoMap = new HashMap<String, ClassInfo>();
    Map<String, ClassInfo> newClassInfoMap = new HashMap<String, ClassInfo>();
    JarDiff jd = new JarDiff();
    addClassInfo(oldClassInfoMap, ClassA.class, jd);
    addClassInfo(oldClassInfoMap, DirectDescendant.class, jd);
    addClassInfo(oldClassInfoMap, InheritanceRoot.class, jd);
    addClassInfo(newClassInfoMap, ClassB.class, jd);
    addClassInfo(newClassInfoMap, DirectDescendant.class, jd);
    addClassInfo(newClassInfoMap, InheritanceRoot.class, jd);

    // Make B look like A
    newClassInfoMap.put("org/semver/jardiff/DeprecateDetectionTest$ClassA",
            newClassInfoMap.get("org/semver/jardiff/DeprecateDetectionTest$ClassB"));
    newClassInfoMap.remove("org/semver/jardiff/DeprecateDetectionTest$ClassB");
    DifferenceAccumulatingHandler handler = new DifferenceAccumulatingHandler();
    jd.diff(handler, new SimpleDiffCriteria(),
        "0.1.0", "0.2.0", oldClassInfoMap, newClassInfoMap);
    
    Dumper.dump(handler.getDelta());

    Set<Difference> differences = handler.getDelta().getDifferences();
	Assert.assertEquals("differences found", 3, differences.size());
	// Naive search for Deprecate.
	boolean hasDeprecate = false;
	for (Difference d : differences) {
		if (d instanceof Deprecate)
			hasDeprecate = true;
	}
	Assert.assertTrue("No Delta.Deprecate found", hasDeprecate);
  }

  private void addClassInfo(Map<String, ClassInfo> classMap, Class klass, JarDiff jd) throws Exception {
    ClassInfo classInfo = jd.loadClassInfo(new ClassReader(klass.getName()));
    classMap.put(classInfo.getName(), classInfo);
  }
}