Skip to content

Commit 5462ee1

Browse files
krmahadevankrmahadevan
committed
Fixing review comments
1 parent 64f8711 commit 5462ee1

File tree

10 files changed

+37
-27
lines changed

10 files changed

+37
-27
lines changed

‎testng-core-api/src/main/java/org/testng/IParameterInfo.java ‎testng-core-api/src/main/java/org/testng/ITestClassInstance.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
package org.testng;
22

33
/** Represents the ability to retrieve the parameters associated with a factory method. */
4-
public interface IParameterInfo {
4+
public interface ITestClassInstance {
55

66
/** @return - The actual instance associated with a factory method */
77
Object getInstance();
@@ -22,14 +22,14 @@ public interface IParameterInfo {
2222
* each of the invocations to this method would return a value from <code>0</code> to <code>3
2323
* </code>
2424
*/
25-
int currentIndex();
25+
int getInvocationIndex();
2626

2727
/** @return - The parameters associated with the factory method as an array. */
2828
Object[] getParameters();
2929

3030
static Object embeddedInstance(Object original) {
31-
if (original instanceof IParameterInfo) {
32-
return ((IParameterInfo) original).getInstance();
31+
if (original instanceof ITestClassInstance) {
32+
return ((ITestClassInstance) original).getInstance();
3333
}
3434
return original;
3535
}

‎testng-core-api/src/main/java/org/testng/internal/IParameterInfo.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
package org.testng.internal;
22

3+
import org.testng.ITestClassInstance;
4+
35
/**
46
* Represents the ability to retrieve the parameters associated with a factory method.
57
*
68
* @deprecated - This interface stands deprecated as of TestNG <code>7.11.0</code>.
79
*/
810
@Deprecated
9-
public interface IParameterInfo extends org.testng.IParameterInfo {}
11+
public interface IParameterInfo extends ITestClassInstance {}

‎testng-core/src/main/java/org/testng/TestClass.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ private void initTestClassesAndInstances() {
126126
IObject.IdentifiableObject[] instances = getObjects(true, this.m_errorMsgPrefix);
127127
Arrays.stream(instances)
128128
.map(IdentifiableObject::getInstance)
129-
.map(IParameterInfo::embeddedInstance)
129+
.map(ITestClassInstance::embeddedInstance)
130130
.filter(it -> it instanceof ITest)
131131
.findFirst()
132132
.ifPresent(it -> testName = ((ITest) it).getTestName());
@@ -208,7 +208,7 @@ private void initMethods() {
208208
true,
209209
xmlTest,
210210
eachInstance);
211-
Object instance = IParameterInfo.embeddedInstance(eachInstance.getInstance());
211+
Object instance = ITestClassInstance.embeddedInstance(eachInstance.getInstance());
212212
beforeClassConfig.put(instance, m_beforeClassMethods);
213213
m_afterClassMethods =
214214
ConfigurationMethod.createClassConfigurationMethods(

‎testng-core/src/main/java/org/testng/internal/BaseTestMethod.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
import org.testng.IClass;
2020
import org.testng.IRetryAnalyzer;
2121
import org.testng.ITestClass;
22+
import org.testng.ITestClassInstance;
2223
import org.testng.ITestNGMethod;
2324
import org.testng.ITestObjectFactory;
2425
import org.testng.ITestResult;
@@ -153,7 +154,7 @@ public String getMethodName() {
153154
public Object getInstance() {
154155
return Optional.ofNullable(m_instance)
155156
.map(IObject.IdentifiableObject::getInstance)
156-
.map(org.testng.IParameterInfo::embeddedInstance)
157+
.map(ITestClassInstance::embeddedInstance)
157158
.orElse(null);
158159
}
159160

‎testng-core/src/main/java/org/testng/internal/ClassImpl.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
import java.util.Map;
66
import org.testng.IClass;
77
import org.testng.ITest;
8+
import org.testng.ITestClassInstance;
89
import org.testng.ITestContext;
910
import org.testng.ITestObjectFactory;
1011
import org.testng.annotations.ITestAnnotation;
@@ -162,7 +163,7 @@ public void addInstance(Object instance) {
162163
}
163164

164165
private static int computeHashCode(Object instance) {
165-
return org.testng.IParameterInfo.embeddedInstance(instance).hashCode();
166+
return ITestClassInstance.embeddedInstance(instance).hashCode();
166167
}
167168

168169
private DetailedAttributes newDetailedAttributes(boolean create, String errMsgPrefix) {

‎testng-core/src/main/java/org/testng/internal/FactoryMethod.java

+7-6
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
import org.testng.IDataProviderInterceptor;
1414
import org.testng.IDataProviderListener;
1515
import org.testng.IInstanceInfo;
16+
import org.testng.ITestClassInstance;
1617
import org.testng.ITestContext;
1718
import org.testng.ITestMethodFinder;
1819
import org.testng.ITestNGListener;
@@ -145,8 +146,8 @@ private static String[] getAllGroups(
145146
return groups.toArray(new String[0]);
146147
}
147148

148-
public org.testng.IParameterInfo[] invoke() {
149-
List<org.testng.IParameterInfo> result = Lists.newArrayList();
149+
public ITestClassInstance[] invoke() {
150+
List<ITestClassInstance> result = Lists.newArrayList();
150151

151152
Map<String, String> allParameterNames = Maps.newHashMap();
152153
Parameters.MethodParameters methodParameters =
@@ -175,7 +176,7 @@ public org.testng.IParameterInfo[] invoke() {
175176
try {
176177
List<Integer> indices = factoryAnnotation.getIndices();
177178
int position = 0;
178-
AtomicInteger counter = new AtomicInteger(0);
179+
AtomicInteger invocationCounter = new AtomicInteger(0);
179180
while (parameterIterator.hasNext()) {
180181
Object[] parameters = parameterIterator.next();
181182
if (parameters == null) {
@@ -201,15 +202,15 @@ public org.testng.IParameterInfo[] invoke() {
201202
.map(
202203
instance ->
203204
new ParameterInfo(
204-
instance, instancePosition, parameters, counter.getAndIncrement()))
205+
instance, instancePosition, parameters, invocationCounter.getAndIncrement()))
205206
.collect(Collectors.toList()));
206207
} else {
207208
for (Integer index : indices) {
208209
int i = index - position;
209210
if (i >= 0 && i < testInstances.length) {
210211
result.add(
211212
new ParameterInfo(
212-
testInstances[i], position, parameters, counter.getAndIncrement()));
213+
testInstances[i], position, parameters, invocationCounter.getAndIncrement()));
213214
}
214215
}
215216
}
@@ -218,7 +219,7 @@ public org.testng.IParameterInfo[] invoke() {
218219
if (indices == null || indices.isEmpty() || indices.contains(position)) {
219220
Object instance = m_objectFactory.newInstance(com.getConstructor(), parameters);
220221
result.add(
221-
new ParameterInfo(instance, position, parameters, counter.getAndIncrement()));
222+
new ParameterInfo(instance, position, parameters, invocationCounter.getAndIncrement()));
222223
}
223224
position++;
224225
}

‎testng-core/src/main/java/org/testng/internal/ParameterInfo.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ public class ParameterInfo implements IParameterInfo {
44
private final Object instance;
55
private final int index;
66
private final Object[] parameters;
7-
private final int currentIndex;
7+
private final int invocationIndex;
88

9-
public ParameterInfo(Object instance, int index, Object[] parameters, int currentIndex) {
9+
public ParameterInfo(Object instance, int index, Object[] parameters, int invocationIndex) {
1010
this.instance = instance;
1111
this.index = index;
1212
this.parameters = parameters;
13-
this.currentIndex = currentIndex;
13+
this.invocationIndex = invocationIndex;
1414
}
1515

1616
@Override
@@ -24,8 +24,8 @@ public int getIndex() {
2424
}
2525

2626
@Override
27-
public int currentIndex() {
28-
return currentIndex;
27+
public int getInvocationIndex() {
28+
return invocationIndex;
2929
}
3030

3131
@Override

‎testng-core/src/main/java/org/testng/internal/TestNGClassFinder.java

+4-3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
import org.testng.DataProviderHolder;
1515
import org.testng.IClass;
1616
import org.testng.IInstanceInfo;
17+
import org.testng.ITestClassInstance;
1718
import org.testng.ITestContext;
1819
import org.testng.ITestObjectFactory;
1920
import org.testng.TestNGException;
@@ -178,7 +179,7 @@ private ClassInfoMap processFactory(IClass ic, ConstructorOrMethod factoryMethod
178179
// If the factory returned IInstanceInfo, get the class from it,
179180
// otherwise, just call getClass() on the returned instances
180181
int i = 0;
181-
for (org.testng.IParameterInfo o : fm.invoke()) {
182+
for (ITestClassInstance o : fm.invoke()) {
182183
if (o == null) {
183184
throw new TestNGException(
184185
"The factory " + fm + " returned a null instance" + "at index " + i);
@@ -329,8 +330,8 @@ private <T> void addInstance(IInstanceInfo<T> ii) {
329330

330331
private void addInstance(IObject.IdentifiableObject o) {
331332
Class<?> key = o.getInstance().getClass();
332-
if (o.getInstance() instanceof org.testng.IParameterInfo) {
333-
key = ((org.testng.IParameterInfo) o.getInstance()).getInstance().getClass();
333+
if (o.getInstance() instanceof ITestClassInstance) {
334+
key = ((ITestClassInstance) o.getInstance()).getInstance().getClass();
334335
}
335336
addInstance(key, o);
336337
}

‎testng-core/src/test/java/test/factory/FactoryIntegrationTest.java

+6-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
import java.util.List;
88
import java.util.stream.Collectors;
99
import org.testng.Assert;
10-
import org.testng.IParameterInfo;
10+
import org.testng.ITestClassInstance;
1111
import org.testng.ITestListener;
1212
import org.testng.ITestResult;
1313
import org.testng.TestListenerAdapter;
@@ -82,7 +82,7 @@ public void doubleFactoryMethodShouldWork() {
8282

8383
@Test(dataProvider = "testdata", description = "GITHUB-3111")
8484
public void ensureCurrentIndexWorksForFactoryPoweredTests(Class<?> klass, Integer[] expected) {
85-
List<IParameterInfo> params = new ArrayList<>();
85+
List<ITestClassInstance> params = new ArrayList<>();
8686
TestNG testng = create(klass);
8787
testng.addListener(
8888
new ITestListener() {
@@ -93,7 +93,10 @@ public void onTestSuccess(ITestResult result) {
9393
});
9494
testng.run();
9595
List<Integer> actualIndices =
96-
params.stream().map(IParameterInfo::currentIndex).sorted().collect(Collectors.toList());
96+
params.stream()
97+
.map(ITestClassInstance::getInvocationIndex)
98+
.sorted()
99+
.collect(Collectors.toList());
97100
assertThat(actualIndices).containsExactly(expected);
98101
}
99102

‎testng-runner-api/src/main/java/org/testng/internal/TestResult.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
import org.testng.IAttributes;
1414
import org.testng.IClass;
1515
import org.testng.ITest;
16+
import org.testng.ITestClassInstance;
1617
import org.testng.ITestContext;
1718
import org.testng.ITestNGMethod;
1819
import org.testng.ITestResult;
@@ -298,7 +299,7 @@ public void setParameters(Object[] parameters) {
298299

299300
@Override
300301
public Object getInstance() {
301-
return org.testng.IParameterInfo.embeddedInstance(this.m_method.getInstance());
302+
return ITestClassInstance.embeddedInstance(this.m_method.getInstance());
302303
}
303304

304305
@Override

0 commit comments

Comments
 (0)