Skip to content

Commit a471761

Browse files
committed
refactor: rename ConsumerVersionSelectors annotation so it does not clash with the model class
1 parent 8335063 commit a471761

File tree

5 files changed

+13
-14
lines changed

5 files changed

+13
-14
lines changed

provider/junit/src/test/groovy/au/com/dius/pact/provider/junit/loader/PactBrokerLoaderSpec.groovy

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ package au.com.dius.pact.provider.junit.loader
33
import au.com.dius.pact.core.model.Pact
44
import au.com.dius.pact.core.model.PactBrokerSource
55
import au.com.dius.pact.core.model.PactReader
6-
import au.com.dius.pact.core.pactbroker.ConsumerVersionSelector
76
import au.com.dius.pact.core.pactbroker.ConsumerVersionSelectors
87
import au.com.dius.pact.core.pactbroker.IPactBrokerClient
98
import au.com.dius.pact.core.pactbroker.InvalidHalResponse
@@ -14,6 +13,7 @@ import au.com.dius.pact.core.support.expressions.ExpressionParser
1413
import au.com.dius.pact.core.support.expressions.SystemPropertyResolver
1514
import au.com.dius.pact.core.support.expressions.ValueResolver
1615
import au.com.dius.pact.provider.junitsupport.loader.IConsumerVersionSelectors
16+
import au.com.dius.pact.provider.junitsupport.loader.PactBrokerConsumerVersionSelectors
1717
import au.com.dius.pact.provider.junitsupport.loader.SelectorBuilder
1818
import au.com.dius.pact.provider.junitsupport.loader.VersionSelector
1919
import au.com.dius.pact.provider.junitsupport.loader.NoPactsFoundException
@@ -1568,36 +1568,36 @@ class PactBrokerLoaderSpec extends Specification {
15681568
}
15691569

15701570
static class IncorrectTypesOnSelectorMethod {
1571-
@au.com.dius.pact.provider.junitsupport.loader.ConsumerVersionSelectors
1571+
@PactBrokerConsumerVersionSelectors
15721572
void consumerVersionSelectors(int i) {}
15731573
}
15741574

15751575
static class IncorrectTypesOnSelectorMethod2 {
1576-
@au.com.dius.pact.provider.junitsupport.loader.ConsumerVersionSelectors
1576+
@PactBrokerConsumerVersionSelectors
15771577
int consumerVersionSelectors() { 0 }
15781578
}
15791579

15801580
static class IncorrectScopeOnSelectorMethod {
1581-
@au.com.dius.pact.provider.junitsupport.loader.ConsumerVersionSelectors
1581+
@PactBrokerConsumerVersionSelectors
15821582
private SelectorBuilder consumerVersionSelectors() { null }
15831583
}
15841584

15851585
static class CorrectSelectorMethod implements IConsumerVersionSelectors {
1586-
@au.com.dius.pact.provider.junitsupport.loader.ConsumerVersionSelectors
1586+
@PactBrokerConsumerVersionSelectors
15871587
SelectorBuilder consumerVersionSelectors() {
15881588
new SelectorBuilder().environment('CorrectSelectorMethod')
15891589
}
15901590
}
15911591

15921592
static class CorrectSelectorMethod2 {
1593-
@au.com.dius.pact.provider.junitsupport.loader.ConsumerVersionSelectors
1593+
@PactBrokerConsumerVersionSelectors
15941594
List<ConsumerVersionSelectors> consumerVersionSelectors() {
15951595
new SelectorBuilder().environment('CorrectSelectorMethod2').build()
15961596
}
15971597
}
15981598

15991599
static class CorrectSelectorMethod3 {
1600-
@au.com.dius.pact.provider.junitsupport.loader.ConsumerVersionSelectors
1600+
@PactBrokerConsumerVersionSelectors
16011601
static List<ConsumerVersionSelectors> consumerVersionSelectors() {
16021602
new SelectorBuilder().environment('CorrectSelectorMethod3').build()
16031603
}

provider/junit5/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -123,13 +123,13 @@ If you are using a Pact broker to host your Pact files, you can select the Pacts
123123
There are a few ways to do this.
124124

125125
### Using an annotated method with a builder
126-
You can add a static method to your test class annotated with `au.com.dius.pact.provider.junitsupport.loader.ConsumerVersionSelectors`
126+
You can add a static method to your test class annotated with `au.com.dius.pact.provider.junitsupport.loader.PactBrokerConsumerVersionSelectors`
127127
which returns a `SelectorBuilder`. The builder will allow you to specify the selectors to use in a type-safe manner.
128128

129129
For example:
130130

131131
```java
132-
@au.com.dius.pact.provider.junitsupport.loader.ConsumerVersionSelectors
132+
@au.com.dius.pact.provider.junitsupport.loader.PactBrokerConsumerVersionSelectors
133133
static SelectorBuilder consumerVersionSelectors() {
134134
// Select Pacts for consumers deployed to production with branch 'FEAT-123'
135135
return new SelectorBuilder()
@@ -141,7 +141,7 @@ For example:
141141
Or for example where the branch is set with the `BRANCH_NAME` environment variable:
142142

143143
```java
144-
@au.com.dius.pact.provider.junitsupport.loader.ConsumerVersionSelectors
144+
@au.com.dius.pact.provider.junitsupport.loader.PactBrokerConsumerVersionSelectors
145145
static SelectorBuilder consumerVersionSelectors() {
146146
// Select Pacts for consumers deployed to production with branch from CI build
147147
return new SelectorBuilder()

provider/src/main/java/au/com/dius/pact/provider/junitsupport/loader/IConsumerVersionSelectors.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ public interface IConsumerVersionSelectors {
77
/**
88
* Return the consumer version selectors to use in the test
99
*/
10-
@au.com.dius.pact.provider.junitsupport.loader.ConsumerVersionSelectors
10+
@PactBrokerConsumerVersionSelectors
1111
SelectorBuilder consumerVersionSelectors();
1212
}

provider/src/main/java/au/com/dius/pact/provider/junitsupport/loader/ConsumerVersionSelectors.java renamed to provider/src/main/java/au/com/dius/pact/provider/junitsupport/loader/PactBrokerConsumerVersionSelectors.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@
88
@Retention(RetentionPolicy.RUNTIME)
99
@Target(ElementType.METHOD)
1010
@Inherited
11-
public @interface ConsumerVersionSelectors { }
11+
public @interface PactBrokerConsumerVersionSelectors { }

provider/src/main/kotlin/au/com/dius/pact/provider/junitsupport/loader/PactBrokerLoader.kt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ import java.net.URISyntaxException
2828
import kotlin.reflect.KCallable
2929
import kotlin.reflect.KClass
3030
import kotlin.reflect.KParameter
31-
import kotlin.reflect.KType
3231
import kotlin.reflect.KVisibility
3332
import kotlin.reflect.full.findAnnotation
3433
import kotlin.reflect.full.isSubtypeOf
@@ -376,7 +375,7 @@ open class PactBrokerLoader(
376375
fun testClassHasSelectorsMethod(testClass: Class<*>?): KCallable<*>? {
377376
val projectedType = SelectorBuilder::class.starProjectedType
378377
return testClass?.kotlin?.members?.firstOrNull { method ->
379-
method.findAnnotation<au.com.dius.pact.provider.junitsupport.loader.ConsumerVersionSelectors>() != null
378+
method.findAnnotation<PactBrokerConsumerVersionSelectors>() != null
380379
&& (
381380
// static method
382381
method.parameters.isEmpty()

0 commit comments

Comments
 (0)