Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix cross-multiplication of multi-assignment data providers (#2074) #2078

Merged
merged 3 commits into from
Jan 13, 2025
+95 −40
Merged

Fix cross-multiplication of multi-assignment data providers (#2074) #2078

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6d8dc3c
Fix cross-multiplication of multi-assignment data providers (#2074)
Vampire Jan 8, 2025
3dfd907
Review Feedback Vol. 1
Vampire Jan 8, 2025
f75bcdd
Review Feedback Vol. 2
Vampire Jan 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 63 additions & 40 deletions spock-core/src/main/java/org/spockframework/runtime/DataIteratorFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import java.util.*;

import org.jetbrains.annotations.NotNull;
import org.spockframework.util.Assert;
import org.spockframework.util.Nullable;
import spock.config.RunnerConfiguration;

Expand Down Expand Up @@ -431,23 +432,31 @@ private IDataIterator[] createDataProviderIterators() {
nextDataVariableMultiplication = null;
}

List<DataProviderInfo> dataProviderInfos = context.getCurrentFeature().getDataProviders();
List<IDataIterator> dataIterators = new ArrayList<>(dataProviders.length);
for (int i = 0; i < dataProviders.length; i++) {
String nextDataVariableName = dataVariableNames.get(i);
for (int dataProviderIndex = 0, dataVariableNameIndex = 0; dataProviderIndex < dataProviders.length; dataProviderIndex++, dataVariableNameIndex++) {
String nextDataVariableName = dataVariableNames.get(dataVariableNameIndex);
if ((nextDataVariableMultiplication != null)
&& (nextDataVariableMultiplication.getDataVariables()[0].equals(nextDataVariableName))) {

// a cross multiplication starts
dataIterators.add(createDataProviderMultiplier(nextDataVariableMultiplication, i));
// skip processed variables
i += nextDataVariableMultiplication.getDataVariables().length - 1;
dataIterators.add(createDataProviderMultiplier(nextDataVariableMultiplication, dataProviderIndex));
// skip processed providers and variables
int remainingVariables = nextDataVariableMultiplication.getDataVariables().length;
dataVariableNameIndex += remainingVariables - 1;
while (remainingVariables > 0) {
remainingVariables -= dataProviderInfos.get(dataProviderIndex).getDataVariables().size();
dataProviderIndex++;
}
dataProviderIndex--;
Assert.that(remainingVariables == 0);
// wait for next cross multiplication
nextDataVariableMultiplication = dataVariableMultiplications.hasNext() ? dataVariableMultiplications.next() : null;
} else {
// not a cross multiplication, just use a data provider iterator
dataIterators.add(new DataProviderIterator(
supervisor, context, nextDataVariableName,
context.getCurrentFeature().getDataProviders().get(i), dataProviders[i]));
dataProviderInfos.get(dataProviderIndex), dataProviders[dataProviderIndex]));
}
}
return dataIterators.toArray(new IDataIterator[0]);
Expand All @@ -457,16 +466,13 @@ private IDataIterator[] createDataProviderIterators() {
* Creates a multiplier that is backed by data providers and on-the-fly multiplies them as they are processed.
*
* @param dataVariableMultiplication the multiplication for which to create the multiplier
* @param i the index of the first data variable for the given multiplication
* @param dataProviderOffset the index of the first data provider for the given multiplication
* @return the data provider multiplier
*/
private DataProviderMultiplier createDataProviderMultiplier(DataVariableMultiplication dataVariableMultiplication, int i) {
private DataProviderMultiplier createDataProviderMultiplier(DataVariableMultiplication dataVariableMultiplication, int dataProviderOffset) {
DataVariableMultiplicationFactor multiplier = dataVariableMultiplication.getMultiplier();
DataVariableMultiplicationFactor multiplicand = dataVariableMultiplication.getMultiplicand();

int multiplierDataVariablesLength = multiplier.getDataVariables().length;
int multiplicandDataVariablesLength = multiplicand.getDataVariables().length;

if (multiplier instanceof DataVariableMultiplication) {
// recursively dive into the multiplication depth-first
// if you combined a with b with c with d, the multiplication is represented as
Expand All @@ -478,49 +484,48 @@ private DataProviderMultiplier createDataProviderMultiplier(DataVariableMultipli
// here we first build the data provider multiplier for the multiplier
// then we collect the data provider infos and data providers for the multiplicand
// and then create the data provider multiplier for them
DataProviderMultiplier multiplierProvider = createDataProviderMultiplier((DataVariableMultiplication) multiplier, i);
DataProviderMultiplier multiplierProvider = createDataProviderMultiplier((DataVariableMultiplication) multiplier, dataProviderOffset);
List<DataProviderInfo> multiplicandProviderInfos = new ArrayList<>();
Object[] multiplicandProviders = new Object[multiplicandDataVariablesLength];

List<DataProviderInfo> dataProviderInfos = context.getCurrentFeature().getDataProviders();
int j = multiplierDataVariablesLength;
int j2 = multiplierDataVariablesLength + multiplicandDataVariablesLength;
int k = 0;
for (; j < j2; j++, k++) {
multiplicandProviderInfos.add(dataProviderInfos.get(i + j));
multiplicandProviders[k] = dataProviders[i + j];
}
List<Object> multiplicandProviders = new ArrayList<>();
collectDataProviders(dataProviderOffset + multiplierProvider.getProcessedDataProviders(), multiplicand, multiplicandProviderInfos, multiplicandProviders);

return new DataProviderMultiplier(supervisor, context,
Arrays.asList(dataVariableMultiplication.getDataVariables()),
multiplicandProviderInfos, multiplierProvider, multiplicandProviders);
multiplicandProviderInfos, multiplierProvider,
multiplicandProviders.toArray(new Object[0]));
} else {
// this path handles the innermost multiplication (a * b)
//
// it collects the data provider infos and data providers for a and b
// and then creates a data provider multiplier for them
List<DataProviderInfo> multiplierProviderInfos = new ArrayList<>();
List<DataProviderInfo> multiplicandProviderInfos = new ArrayList<>();
Object[] multiplierProviders = new Object[multiplierDataVariablesLength];
Object[] multiplicandProviders = new Object[multiplicandDataVariablesLength];

List<DataProviderInfo> dataProviderInfos = context.getCurrentFeature().getDataProviders();
int j = 0;
int j2 = multiplierDataVariablesLength;
for (; j < j2; j++) {
multiplierProviderInfos.add(dataProviderInfos.get(i + j));
multiplierProviders[j] = dataProviders[i + j];
}
int k = 0;
for (j2 += multiplicandDataVariablesLength; j < j2; j++, k++) {
multiplicandProviderInfos.add(dataProviderInfos.get(i + j));
multiplicandProviders[k] = dataProviders[i + j];
}
List<Object> multiplierProviders = new ArrayList<>();
List<Object> multiplicandProviders = new ArrayList<>();
collectDataProviders(dataProviderOffset, multiplier, multiplierProviderInfos, multiplierProviders);
collectDataProviders(dataProviderOffset + multiplierProviderInfos.size(), multiplicand, multiplicandProviderInfos, multiplicandProviders);

return new DataProviderMultiplier(supervisor, context,
Arrays.asList(dataVariableMultiplication.getDataVariables()),
multiplierProviderInfos, multiplicandProviderInfos, multiplierProviders, multiplicandProviders);
multiplierProviderInfos, multiplicandProviderInfos,
multiplierProviders.toArray(new Object[0]),
multiplicandProviders.toArray(new Object[0]));
}
}

private void collectDataProviders(int dataProviderOffset, DataVariableMultiplicationFactor factor,
List<DataProviderInfo> factorProviderInfos, List<Object> factorProviders) {
List<DataProviderInfo> dataProviderInfos = context.getCurrentFeature().getDataProviders();
int factorDataVariables = factor.getDataVariables().length;
int remainingDataVariables = factorDataVariables;
while (remainingDataVariables > 0) {
int dataProviderIndex = dataProviderOffset + factorDataVariables - remainingDataVariables;
DataProviderInfo dataProviderInfo = dataProviderInfos.get(dataProviderIndex);
factorProviderInfos.add(dataProviderInfo);
factorProviders.add(dataProviders[dataProviderIndex]);
remainingDataVariables -= dataProviderInfo.getDataVariables().size();
}
Assert.that(remainingDataVariables == 0);
}

@NotNull
Expand Down Expand Up @@ -667,7 +672,7 @@ private static class DataProviderMultiplier extends BaseDataIterator {
/**
* The data providers that are used as multiplicand
* in this multiplication, if it represents in an
* {@code ((a * b) * c)} multiplication the {@code (ab * b)}
* {@code ((a * b) * c)} multiplication the {@code (ab * c)}
* or the {@code (a * b)} part or otherwise {@code null}.
* Outside the constructor it is only used for the final cleanup,
*/
Expand Down Expand Up @@ -722,6 +727,11 @@ private static class DataProviderMultiplier extends BaseDataIterator {
*/
private final int estimatedNumIterations;

/**
* The amount how many data providers are processed by this data provider multiplier.
*/
private final int processedDataProviders;

/**
* Creates a new data provider multiplier that handles two sets of plain data providers as factors.
* If the sizes of the providers in at least one of the sets can be estimated,
Expand Down Expand Up @@ -751,6 +761,8 @@ public DataProviderMultiplier(IRunSupervisor supervisor, SpockExecutionContext c
? UNKNOWN_ITERATIONS
: estimatedMultiplierIterations * estimatedMultiplicandIterations;

processedDataProviders = multiplierProviders.length + multiplicandProviders.length;

if ((estimatedMultiplierIterations != UNKNOWN_ITERATIONS)
&& ((estimatedMultiplicandIterations == UNKNOWN_ITERATIONS) || (estimatedMultiplicandIterations > estimatedMultiplierIterations))) {
// multiplier is not unknown and multiplicand is unknown or larger,
Expand Down Expand Up @@ -798,6 +810,8 @@ public DataProviderMultiplier(IRunSupervisor supervisor, SpockExecutionContext c
? UNKNOWN_ITERATIONS
: estimatedMultiplierIterations * estimatedMultiplicandIterations;

processedDataProviders = multiplierProvider.getProcessedDataProviders() + multiplicandProviders.length;

if ((estimatedMultiplierIterations != UNKNOWN_ITERATIONS)
&& ((estimatedMultiplicandIterations == UNKNOWN_ITERATIONS) || (estimatedMultiplicandIterations > estimatedMultiplierIterations))) {
// multiplier is not unknown and multiplicand is unknown or larger,
Expand Down Expand Up @@ -929,6 +943,15 @@ public List<String> getDataVariableNames() {
return dataVariableNames;
}

/**
* Returns how many data providers are processed by this data provider multiplier.
*
* @return how many data providers are processed by this data provider multiplier
*/
public int getProcessedDataProviders() {
return processedDataProviders;
}

private Iterator<?>[] createIterators(Object[] dataProviders, List<DataProviderInfo> dataProviderInfos) {
if (context.getErrorInfoCollector().hasErrors()) {
return null;
Expand Down
32 changes: 32 additions & 0 deletions spock-specs/src/test/groovy/org/spockframework/smoke/parameterization/DataProviders.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,38 @@ where: a << b
]
}

@Issue('https://github.com/spockframework/spock/issues/2074')
def 'multi-assignments can be combined'() {
when:
def results = runner.runSpecBody '''
def 'a feature (#a #b #c #d #e #f)'() {
expect:
true

where:
[a, b] << [['a1', 'b1'], ['a2', 'b2']]
combined:
[c, d] << [['c1', 'd1'], ['c2', 'd2']]
combined:
[e, f] << [['e1', 'f1'], ['e2', 'f2']]
}
'''

then:
results.testsStartedCount == 1 + (2 * 2 * 2)
results.testEvents().started().list().testDescriptor.displayName == [
'a feature (#a #b #c #d #e #f)',
'a feature (a1 b1 c1 d1 e1 f1)',
'a feature (a1 b1 c1 d1 e2 f2)',
'a feature (a1 b1 c2 d2 e1 f1)',
'a feature (a1 b1 c2 d2 e2 f2)',
'a feature (a2 b2 c1 d1 e1 f1)',
'a feature (a2 b2 c1 d1 e2 f2)',
'a feature (a2 b2 c2 d2 e1 f1)',
'a feature (a2 b2 c2 d2 e2 f2)'
]
}

static class MyIterator implements Iterator {
def elems = [1, 2, 3]

Expand Down
Loading