Skip to content

feat: support DSP correct state in deprovisioning #5040

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

Merged
merged 1 commit into from
Jun 16, 2025
Merged

feat: support DSP correct state in deprovisioning #5040

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 11 additions & 3 deletions ...nsferprocess/transform/type/v2024/from/JsonObjectFromTransferProcessV2024Transformer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public JsonObjectFromTransferProcessV2024Transformer(JsonBuilderFactory jsonBuil
var builder = jsonBuilderFactory.createObjectBuilder()
.add(ID, transferProcess.getId())
.add(TYPE, forNamespace(DSPACE_TYPE_TRANSFER_PROCESS_TERM))
.add(forNamespace(DSPACE_PROPERTY_STATE_TERM), createId(jsonBuilderFactory, state(transferProcess.getState(), context)));
.add(forNamespace(DSPACE_PROPERTY_STATE_TERM), createId(jsonBuilderFactory, state(transferProcess.getState(), transferProcess.getErrorDetail(), context)));

if (transferProcess.getType() == TransferProcess.Type.PROVIDER) {
builder.add(forNamespace(DSPACE_PROPERTY_PROVIDER_PID_TERM), createId(jsonBuilderFactory, transferProcess.getId()));
Expand All @@ -68,7 +68,7 @@ public JsonObjectFromTransferProcessV2024Transformer(JsonBuilderFactory jsonBuil
return builder.build();
}

private String state(Integer state, TransformerContext context) {
private String state(Integer state, String errorDetails, TransformerContext context) {
var transferProcessState = TransferProcessStates.from(state);
if (transferProcessState == null) {
context.problem()
Expand All @@ -84,8 +84,16 @@ private String state(Integer state, TransformerContext context) {
case STARTING, STARTED -> forNamespace(DSPACE_VALUE_TRANSFER_STATE_STARTED_TERM);
case SUSPENDING, SUSPENDED, SUSPENDING_REQUESTED, RESUMING, RESUMED ->
forNamespace(DSPACE_VALUE_TRANSFER_STATE_SUSPENDED_TERM);
case COMPLETING, COMPLETING_REQUESTED, COMPLETED, DEPROVISIONING, DEPROVISIONING_REQUESTED, DEPROVISIONED ->
case COMPLETING, COMPLETING_REQUESTED, COMPLETED ->
forNamespace(DSPACE_VALUE_TRANSFER_STATE_COMPLETED_TERM);

case DEPROVISIONING, DEPROVISIONING_REQUESTED, DEPROVISIONED -> {
if (errorDetails != null) {
yield forNamespace(DSPACE_VALUE_TRANSFER_STATE_TERMINATED_TERM);
} else {
yield forNamespace(DSPACE_VALUE_TRANSFER_STATE_COMPLETED_TERM);
}
}
case TERMINATING, TERMINATING_REQUESTED, TERMINATED ->
forNamespace(DSPACE_VALUE_TRANSFER_STATE_TERMINATED_TERM);
default -> {
Expand Down
42 changes: 23 additions & 19 deletions ...ansferprocess/transform/v2024/from/JsonObjectFromTransferProcessV2024TransformerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ void transformTransferProcessConsumer() {

@ParameterizedTest
@ArgumentsSource(Status.class)
void transform_status(TransferProcessStates inputState, String expectedDspState) {
void transform_status(TransferProcessStates inputState, String expectedDspState, String errorDetail) {
var dataAddress = DataAddress.Builder.newInstance()
.keyName("dataAddressId")
.property("type", "TestValueProperty")
Expand All @@ -151,6 +151,7 @@ void transform_status(TransferProcessStates inputState, String expectedDspState)
.dataDestination(dataAddress)
.state(inputState.code())
.contentDataAddress(dataAddress)
.errorDetail(errorDetail)
.build();

var result = transformer.transform(transferProcess, context);
Expand All @@ -166,24 +167,27 @@ public static class Status implements ArgumentsProvider {
@Override
public Stream<? extends Arguments> provideArguments(ExtensionContext context) {
return Stream.of(
arguments(REQUESTING, toIri(DSPACE_VALUE_TRANSFER_STATE_REQUESTED_TERM)),
arguments(REQUESTED, toIri(DSPACE_VALUE_TRANSFER_STATE_REQUESTED_TERM)),
arguments(STARTING, toIri(DSPACE_VALUE_TRANSFER_STATE_STARTED_TERM)),
arguments(STARTED, toIri(DSPACE_VALUE_TRANSFER_STATE_STARTED_TERM)),
arguments(SUSPENDING, toIri(DSPACE_VALUE_TRANSFER_STATE_SUSPENDED_TERM)),
arguments(SUSPENDING_REQUESTED, toIri(DSPACE_VALUE_TRANSFER_STATE_SUSPENDED_TERM)),
arguments(SUSPENDED, toIri(DSPACE_VALUE_TRANSFER_STATE_SUSPENDED_TERM)),
arguments(RESUMING, toIri(DSPACE_VALUE_TRANSFER_STATE_SUSPENDED_TERM)),
arguments(RESUMED, toIri(DSPACE_VALUE_TRANSFER_STATE_SUSPENDED_TERM)),
arguments(COMPLETING, toIri(DSPACE_VALUE_TRANSFER_STATE_COMPLETED_TERM)),
arguments(COMPLETING_REQUESTED, toIri(DSPACE_VALUE_TRANSFER_STATE_COMPLETED_TERM)),
arguments(COMPLETED, toIri(DSPACE_VALUE_TRANSFER_STATE_COMPLETED_TERM)),
arguments(DEPROVISIONING, toIri(DSPACE_VALUE_TRANSFER_STATE_COMPLETED_TERM)),
arguments(DEPROVISIONING_REQUESTED, toIri(DSPACE_VALUE_TRANSFER_STATE_COMPLETED_TERM)),
arguments(DEPROVISIONED, toIri(DSPACE_VALUE_TRANSFER_STATE_COMPLETED_TERM)),
arguments(TERMINATING, toIri(DSPACE_VALUE_TRANSFER_STATE_TERMINATED_TERM)),
arguments(TERMINATING_REQUESTED, toIri(DSPACE_VALUE_TRANSFER_STATE_TERMINATED_TERM)),
arguments(TERMINATED, toIri(DSPACE_VALUE_TRANSFER_STATE_TERMINATED_TERM))
arguments(REQUESTING, toIri(DSPACE_VALUE_TRANSFER_STATE_REQUESTED_TERM), null),
arguments(REQUESTED, toIri(DSPACE_VALUE_TRANSFER_STATE_REQUESTED_TERM), null),
arguments(STARTING, toIri(DSPACE_VALUE_TRANSFER_STATE_STARTED_TERM), null),
arguments(STARTED, toIri(DSPACE_VALUE_TRANSFER_STATE_STARTED_TERM), null),
arguments(SUSPENDING, toIri(DSPACE_VALUE_TRANSFER_STATE_SUSPENDED_TERM), null),
arguments(SUSPENDING_REQUESTED, toIri(DSPACE_VALUE_TRANSFER_STATE_SUSPENDED_TERM), null),
arguments(SUSPENDED, toIri(DSPACE_VALUE_TRANSFER_STATE_SUSPENDED_TERM), null),
arguments(RESUMING, toIri(DSPACE_VALUE_TRANSFER_STATE_SUSPENDED_TERM), null),
arguments(RESUMED, toIri(DSPACE_VALUE_TRANSFER_STATE_SUSPENDED_TERM), null),
arguments(COMPLETING, toIri(DSPACE_VALUE_TRANSFER_STATE_COMPLETED_TERM), null),
arguments(COMPLETING_REQUESTED, toIri(DSPACE_VALUE_TRANSFER_STATE_COMPLETED_TERM), null),
arguments(COMPLETED, toIri(DSPACE_VALUE_TRANSFER_STATE_COMPLETED_TERM), null),
arguments(DEPROVISIONING, toIri(DSPACE_VALUE_TRANSFER_STATE_COMPLETED_TERM), null),
arguments(DEPROVISIONING_REQUESTED, toIri(DSPACE_VALUE_TRANSFER_STATE_COMPLETED_TERM), null),
arguments(DEPROVISIONED, toIri(DSPACE_VALUE_TRANSFER_STATE_COMPLETED_TERM), null),
arguments(DEPROVISIONING, toIri(DSPACE_VALUE_TRANSFER_STATE_TERMINATED_TERM), "error`"),
arguments(DEPROVISIONING_REQUESTED, toIri(DSPACE_VALUE_TRANSFER_STATE_TERMINATED_TERM), "error"),
arguments(DEPROVISIONED, toIri(DSPACE_VALUE_TRANSFER_STATE_TERMINATED_TERM), "error"),
arguments(TERMINATING, toIri(DSPACE_VALUE_TRANSFER_STATE_TERMINATED_TERM), null),
arguments(TERMINATING_REQUESTED, toIri(DSPACE_VALUE_TRANSFER_STATE_TERMINATED_TERM), null),
arguments(TERMINATED, toIri(DSPACE_VALUE_TRANSFER_STATE_TERMINATED_TERM), null)
);
}
}
Expand Down
3 changes: 3 additions & 0 deletions .../main/java/org/eclipse/edc/connector/controlplane/transfer/spi/types/TransferProcess.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,14 +308,17 @@ public boolean canBeCompleted() {
}

public void transitionCompleting() {
this.errorDetail = null;
transition(COMPLETING, state -> canBeCompleted());
}

public void transitionCompletingRequested() {
this.errorDetail = null;
transition(COMPLETING_REQUESTED, state -> canBeCompleted());
}

public void transitionCompleted() {
this.errorDetail = null;
transition(COMPLETED, COMPLETED, COMPLETING, COMPLETING_REQUESTED, STARTED);
}

Expand Down
10 changes: 6 additions & 4 deletions ...t/java/org/eclipse/edc/connector/controlplane/transfer/spi/types/TransferProcessTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,13 +107,14 @@ void verifyConsumerTransitions() {

process.transitionCompleting();
process.transitionCompleted();

assertThat(process.getErrorDetail()).isNull();

process.transitionDeprovisioning();
process.transitionDeprovisioned();
}

@ParameterizedTest
@EnumSource(value = TransferProcessStates.class, mode = INCLUDE, names = { "STARTING", "SUSPENDED" })
@EnumSource(value = TransferProcessStates.class, mode = INCLUDE, names = {"STARTING", "SUSPENDED"})
void shouldNotSetDataPlaneIdOnStart_whenTransferIsConsumer(TransferProcessStates fromState) {
var process = TransferProcess.Builder.newInstance()
.id(UUID.randomUUID().toString()).type(CONSUMER)
Expand Down Expand Up @@ -145,6 +146,7 @@ void verifyProviderTransitions() {
process.transitionCompleting();
process.transitionCompleted();


process.transitionDeprovisioning();
process.transitionDeprovisioned();
}
Expand All @@ -153,7 +155,7 @@ void verifyProviderTransitions() {
@EnumSource(
value = TransferProcessStates.class,
mode = EXCLUDE,
names = { "COMPLETED", "TERMINATED", "DEPROVISIONING", "DEPROVISIONING_REQUESTED", "DEPROVISIONED", "RESUMED" }
names = {"COMPLETED", "TERMINATED", "DEPROVISIONING", "DEPROVISIONING_REQUESTED", "DEPROVISIONED", "RESUMED"}
)
void verifyTerminating_validStates(TransferProcessStates state) {
var transferProcess = TransferProcess.Builder.newInstance()
Expand All @@ -167,7 +169,7 @@ void verifyTerminating_validStates(TransferProcessStates state) {
}

@ParameterizedTest
@EnumSource(value = TransferProcessStates.class, mode = INCLUDE, names = { "COMPLETED", "TERMINATED" })
@EnumSource(value = TransferProcessStates.class, mode = INCLUDE, names = {"COMPLETED", "TERMINATED"})
void verifyTerminating_invalidStates(TransferProcessStates state) {
var process = TransferProcess.Builder.newInstance()
.id(UUID.randomUUID().toString())
Expand Down
4 changes: 1 addition & 3 deletions ...s/compatibility-test-runner/src/test/java/org/eclipse/edc/tck/dsp/CompatibilityTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@

public interface CompatibilityTests {

// TODO Those remaining failures are due the fact that EDC consider the DEPROVISIONED state completed while the TCK expects terminated.
List<String> ALLOWED_FAILURES = List.of(
"TP:01-01", "TP:01-03", "TP:01-05");
List<String> ALLOWED_FAILURES = List.of();

}
4 changes: 2 additions & 2 deletions ...s/protocol-tck/tck-extension/src/main/java/org/eclipse/edc/tck/dsp/data/DataAssembly.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ private static void recordProvider01TransferSequences(StepRecorder<TransferProce
recorder.record("ATP0102", TransferProcess::transitionStarting);
recorder.record("ATP0103", TransferProcess::transitionStarting);
recorder.record("ATP0104", TransferProcess::transitionStarting);
recorder.record("ATP0105", TransferProcess::transitionTerminating);
recorder.record("ATP0105", tp -> tp.transitionTerminating("error"));

}

Expand Down Expand Up @@ -282,7 +282,7 @@ private static void recordConsumer03TransferSequences(StepRecorder<TransferProce

public static List<Trigger<TransferProcess>> createTransferProcessTriggers() {
return List.of(
createTransferTrigger(TransferProcessStarted.class, "ATP0101", TransferProcess::transitionTerminating),
createTransferTrigger(TransferProcessStarted.class, "ATP0101", tp -> tp.transitionTerminating("error")),
createTransferTrigger(TransferProcessStarted.class, "ATP0102", TransferProcess::transitionCompleting),
createTransferTrigger(TransferProcessStarted.class, "ATP0103", (process) -> process.transitionSuspending("suspending")),
createTransferTrigger(TransferProcessSuspended.class, "ATP0103", (process) -> process.transitionTerminating("terminating")),
Expand Down