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

Jump to bottom

GH-82 TransportContext: merge and key iterator #85

Merged
merged 2 commits into from
Aug 13, 2024
Merged

GH-82 TransportContext: merge and key iterator #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d81c4ea
GH-82 TransportContext: merge and key iterator
szysas Apr 22, 2024
0d78208
fix
szysas Jul 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions coap-core/src/main/java/com/mbed/coap/packet/CoapRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,6 +279,11 @@ public <T> Builder addContext(TransportContext.Key<T> key, T value) {
return this;
}

public <T> Builder addContext(TransportContext context) {
transContext = transContext.with(context);
return this;
}

public Builder address(InetSocketAddress address) {
this.peerAddress = address;
return this;
Expand Down
45 changes: 27 additions & 18 deletions coap-core/src/main/java/com/mbed/coap/transport/TransportContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (C) 2022-2023 java-coap contributors (https://github.com/open-coap/java-coap)
* Copyright (C) 2022-2024 java-coap contributors (https://github.com/open-coap/java-coap)
* SPDX-License-Identifier: Apache-2.0
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -17,7 +17,9 @@

import static java.util.Objects.requireNonNull;
import java.time.Duration;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;

public final class TransportContext {

Expand Down Expand Up @@ -66,6 +68,17 @@ public <T> TransportContext with(Key<T> key, T value) {
return new TransportContext(requireNonNull(key), requireNonNull(value), this);
}

public TransportContext with(TransportContext otherCtx) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should add some javadoc to explain that :
If a key exists in both contexts, the otherCtx value will be used.

if (otherCtx.equals(EMPTY)) {
return this;
}
TransportContext mergedContext = this.with(otherCtx.key, otherCtx.value);
if (otherCtx.next == null) {
return mergedContext;
}
return mergedContext.with(otherCtx.next);
}

@Override
public boolean equals(Object o) {
if (this == o) {
Expand All @@ -83,28 +96,24 @@ public int hashCode() {
return Objects.hash(key, value, next);
}

public Set<Key<?>> keys() {
Set<Key<?>> keys = new HashSet<>();
addKey(keys);
return keys;
}

private void addKey(Set<Key<?>> keys) {
keys.add(key);
if (next != null) {
next.addKey(keys);
}
}

public static final class Key<T> {
private final T defaultValue;

public Key(T defaultValue) {
this.defaultValue = defaultValue;
}

@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Key<?> key = (Key<?>) o;
return Objects.equals(defaultValue, key.defaultValue);
}

@Override
public int hashCode() {
return Objects.hash(defaultValue);
}
}
}
5 changes: 4 additions & 1 deletion coap-core/src/test/java/com/mbed/coap/packet/CoapRequestTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import static com.mbed.coap.packet.MediaTypes.CT_APPLICATION_JSON;
import static com.mbed.coap.packet.Opaque.EMPTY;
import static com.mbed.coap.packet.Opaque.decodeHex;
import static com.mbed.coap.transport.TransportContext.NON_CONFIRMABLE;
import static com.mbed.coap.transport.TransportContext.RESPONSE_TIMEOUT;
import static java.time.Duration.ofSeconds;
import static org.junit.jupiter.api.Assertions.assertEquals;
Expand Down Expand Up @@ -96,11 +97,13 @@ void shouldModifyTransportContext() {

// when
CoapRequest request2 = request.modify()
.addContext(DUMMY_KEY, "test")
.addContext(NON_CONFIRMABLE, true)
.addContext(TransportContext.of(DUMMY_KEY, "test"))
.build();

// then
assertEquals("test", request2.getTransContext(DUMMY_KEY));
assertEquals(true, request2.getTransContext(NON_CONFIRMABLE));
}

@Test
Expand Down
57 changes: 54 additions & 3 deletions coap-core/src/test/java/com/mbed/coap/transport/TransportContextTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (C) 2022-2023 java-coap contributors (https://github.com/open-coap/java-coap)
* Copyright (C) 2022-2024 java-coap contributors (https://github.com/open-coap/java-coap)
* SPDX-License-Identifier: Apache-2.0
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -15,7 +15,10 @@
*/
package com.mbed.coap.transport;

import static com.mbed.coap.transport.TransportContext.EMPTY;
import static org.assertj.core.util.Sets.set;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import nl.jqno.equalsverifier.EqualsVerifier;
import nl.jqno.equalsverifier.Warning;
Expand All @@ -26,6 +29,7 @@ public class TransportContextTest {

private TransportContext.Key<String> DUMMY_KEY = new TransportContext.Key<>(null);
private TransportContext.Key<String> DUMMY_KEY2 = new TransportContext.Key<>("na");
private TransportContext.Key<String> DUMMY_KEY3 = new TransportContext.Key<>(null);

@Test
void test() {
Expand All @@ -38,21 +42,68 @@ void test() {
assertEquals("afds", trans.get(DUMMY_KEY2));
}

@Test
void merge() {
TransportContext ctx1 = TransportContext.of(DUMMY_KEY, "111");
TransportContext ctx2 = TransportContext.of(DUMMY_KEY2, "222");

TransportContext ctx3 = ctx1.with(ctx2);

assertEquals("111", ctx3.get(DUMMY_KEY));
assertEquals("222", ctx3.get(DUMMY_KEY2));
assertEquals(set(DUMMY_KEY, DUMMY_KEY2), ctx3.keys());
}

@Test
void mergeWithEmpty() {
TransportContext ctx1 = TransportContext.of(DUMMY_KEY, "111");

assertEquals(ctx1, ctx1.with(EMPTY));
assertEquals(ctx1, EMPTY.with(ctx1));
assertEquals(set(DUMMY_KEY), ctx1.keys());
}

@Test
void mergeAndOverWrite() {
TransportContext ctx1 = TransportContext.of(DUMMY_KEY, "111").with(DUMMY_KEY2, "222");
TransportContext ctx2 = TransportContext.of(DUMMY_KEY, "aaa").with(DUMMY_KEY3, "333");

TransportContext ctx3 = ctx1.with(ctx2);

assertEquals("aaa", ctx3.get(DUMMY_KEY));
assertEquals("222", ctx3.get(DUMMY_KEY2));
assertEquals("333", ctx3.get(DUMMY_KEY3));

assertEquals(set(DUMMY_KEY, DUMMY_KEY2, DUMMY_KEY3), ctx3.keys());
}

@Test
void empty() {
TransportContext trans = TransportContext.EMPTY;
TransportContext trans = EMPTY;
assertNull(trans.get(DUMMY_KEY));
assertEquals("default-val", trans.getOrDefault(DUMMY_KEY2, "default-val"));
assertEquals("na", trans.get(DUMMY_KEY2));

assertEquals(EMPTY, EMPTY.with(EMPTY));
}

@Test
public void equalsAndHashTest() throws Exception {
EqualsVerifier.forClass(TransportContext.class)
.suppress(Warning.NONFINAL_FIELDS)
.usingGetClass()
.withPrefabValues(TransportContext.class, TransportContext.EMPTY, TransportContext.of(TransportContext.NON_CONFIRMABLE, true))
.withPrefabValues(TransportContext.class, EMPTY, TransportContext.of(TransportContext.NON_CONFIRMABLE, true))
.verify();
}

@Test
public void equalsAndHashKeys() {
assertEquals(DUMMY_KEY, DUMMY_KEY);

assertNotEquals(DUMMY_KEY, DUMMY_KEY2);
assertNotEquals(DUMMY_KEY, DUMMY_KEY3);

assertNotEquals(new TransportContext.Key<String>(null), new TransportContext.Key<String>(null));
}

}