lingwei.kong/hawkbit
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Fix MgmtBaseEntity deserialization (#1633)

Browse Source 
Before REST refactoring MgmtBaseEntity was able to deserialize fields
like createdBy. After refactoring, with READ_ONLY access it was dropped
and these fields become null. While this could be a good change, it is
not backward compatible (is that needed) and most importantly will lead
to the fact that Feign client won't be able to access that
data. So, at least for now, I return deserialization back

Signed-off-by: Marinov Avgustin <Avgustin.Marinov@bosch.com>
This commit is contained in:
Avgustin Marinov
2024-02-09 12:51:02 +02:00
committed by GitHub
parent 0c14e6e05d
commit 669f50a4f7
4 changed files with 47 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/json/model/MgmtBaseEntity.java
View File

@@ -12,6 +12,7 @@ package org.eclipse.hawkbit.mgmt.json.model;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.ToString;
import org.springframework.hateoas.Link;
import org.springframework.hateoas.RepresentationModel;
@@ -23,24 +24,25 @@ import com.fasterxml.jackson.annotation.JsonProperty;
*/
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public abstract class MgmtBaseEntity extends RepresentationModel<MgmtBaseEntity> {
@JsonProperty(access = JsonProperty.Access.READ_ONLY)
@JsonProperty
@Schema(description = "Entity was originally created by (User, AMQP-Controller, anonymous etc.)",
accessMode = Schema.AccessMode.READ_WRITE, example = "bumlux")
accessMode = Schema.AccessMode.READ_ONLY, example = "bumlux")
private String createdBy;
@JsonProperty(access = JsonProperty.Access.READ_ONLY)
@JsonProperty
@Schema(description = "Entity was originally created at (timestamp UTC in milliseconds)",
accessMode = Schema.AccessMode.READ_ONLY, example = "1691065905897")
private Long createdAt;
@JsonProperty(access = JsonProperty.Access.READ_ONLY)
@JsonProperty
@Schema(description = "Entity was last modified by (User, AMQP-Controller, anonymous etc.)",
accessMode = Schema.AccessMode.READ_ONLY, example = "bumlux")
private String lastModifiedBy;
@JsonProperty(access = JsonProperty.Access.READ_ONLY)
@JsonProperty
@Schema(description = "Entity was last modified at (timestamp UTC in milliseconds)",
accessMode = Schema.AccessMode.READ_ONLY, example = "1691065906407")
private Long lastModifiedAt;

2
hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/json/model/MgmtNamedEntity.java
View File

@@ -13,12 +13,14 @@ import com.fasterxml.jackson.annotation.JsonProperty;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.ToString;
/**
* A json annotated rest model for NamedEntity to RESTful API representation.
*/
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
public abstract class MgmtNamedEntity extends MgmtBaseEntity {
@JsonProperty(required = true)

1
hawkbit-rest/hawkbit-mgmt-api/src/main/java/org/eclipse/hawkbit/mgmt/json/model/target/MgmtTarget.java
View File

@@ -20,6 +20,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;
*/
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)
@JsonInclude(Include.NON_NULL)
@JsonIgnoreProperties(ignoreUnknown = true)
@Schema(description = """

37
hawkbit-rest/hawkbit-mgmt-api/src/test/java/org/eclipse/hawkbit/mgmt/json/model/AuditFieldSerializationTest.java Normal file
View File

@@ -0,0 +1,37 @@
/**
* Copyright (c) 2024 Contributors to the Eclipse Foundation
*
* This program and the accompanying materials are made
* available under the terms of the Eclipse Public License 2.0
* which is available at https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.hawkbit.mgmt.json.model;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import io.qameta.allure.Feature;
import io.qameta.allure.Story;
import org.eclipse.hawkbit.mgmt.json.model.target.MgmtTarget;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
@Feature("Unit Tests - Management API")
@Story("Serialization")
public class AuditFieldSerializationTest {
@Test
public void assertAuditingFields() throws JsonProcessingException {
final MgmtTarget mgmtTarget = new MgmtTarget();
mgmtTarget.setCreatedBy("user");
mgmtTarget.setCreatedAt(System.currentTimeMillis() - 1_000_000);
mgmtTarget.setLastModifiedBy("user2");
mgmtTarget.setLastModifiedAt(System.currentTimeMillis());
final ObjectMapper objectMapper = new ObjectMapper();
final String serialized = objectMapper.writeValueAsString(mgmtTarget);
final MgmtTarget mgmtTargetDeserialization = objectMapper.readValue(serialized, MgmtTarget.class);
assertThat(mgmtTargetDeserialization).isEqualTo(mgmtTarget);
}
}