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

[DE-673] Metadata endpoints tests #101

Merged
merged 13 commits into from
Feb 1, 2024
Merged

[DE-673] Metadata endpoints tests #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
ba09d1a
[DE-671] Metafields tests
maciej-nedza Jan 26, 2024
15991dd
Merge branch 'main' of github.com:maxio-com/ab-java-sdk into metafiel…
maciej-nedza Jan 26, 2024
d9f40d9
Merge branch 'main' of github.com:maxio-com/ab-java-sdk into metafiel…
maciej-nedza Jan 26, 2024
f7a5485
[DE-671] Metafields tests updates
maciej-nedza Jan 26, 2024
df8c392
[DE-671] Disable test using global error template
maciej-nedza Jan 29, 2024
7535296
[DE-671] Disable the other test
maciej-nedza Jan 29, 2024
61204fd
[DE-673] Create and update metadata tests
maciej-nedza Jan 30, 2024
2fa8355
[DE-673] List and Delete metadata tests
maciej-nedza Jan 31, 2024
e9d0f58
Merge branch 'main' of github.com:maxio-com/ab-java-sdk into metadata…
maciej-nedza Jan 31, 2024
0ea421e
[DE-673] Metadata tests refactor
maciej-nedza Feb 1, 2024
3827300
Merge branch 'main' of github.com:maxio-com/ab-java-sdk into metadata…
maciej-nedza Feb 1, 2024
8f86884
[DE-673] Fixes after docs update
maciej-nedza Feb 1, 2024
1c10a14
Merge branch 'main' into metadata-tests
maciej-nedza Feb 1, 2024
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
262 changes: 262 additions & 0 deletions ...io/advancedbilling/controllers/customfields/CustomFieldsControllerCreateMetadataTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,262 @@
package com.maxio.advancedbilling.controllers.customfields;

import com.maxio.advancedbilling.TestClient;
import com.maxio.advancedbilling.controllers.CustomFieldsController;
import com.maxio.advancedbilling.exceptions.ApiException;
import com.maxio.advancedbilling.models.CreateMetadata;
import com.maxio.advancedbilling.models.CreateMetadataRequest;
import com.maxio.advancedbilling.models.CreateMetafield;
import com.maxio.advancedbilling.models.CreateMetafieldsRequest;
import com.maxio.advancedbilling.models.ListMetafieldsInput;
import com.maxio.advancedbilling.models.Metadata;
import com.maxio.advancedbilling.models.Metafield;
import com.maxio.advancedbilling.models.MetafieldInput;
import com.maxio.advancedbilling.models.ResourceType;
import com.maxio.advancedbilling.models.containers.CreateMetafieldsRequestMetafields;
import com.maxio.advancedbilling.utils.TestTeardown;
import com.maxio.advancedbilling.utils.assertions.CommonAssertions;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.EnumSource;
import org.junit.jupiter.params.provider.MethodSource;

import java.io.IOException;
import java.util.List;
import java.util.stream.Stream;

import static com.maxio.advancedbilling.utils.assertions.CommonAssertions.assertNotFound;
import static com.maxio.advancedbilling.utils.assertions.CommonAssertions.assertUnauthorized;
import static org.apache.commons.lang3.RandomStringUtils.randomNumeric;
import static org.assertj.core.api.Assertions.assertThat;

public class CustomFieldsControllerCreateMetadataTest {

private static CustomFieldsTestsUtils.Resources resources;
private static final CustomFieldsController CUSTOM_FIELDS_CONTROLLER =
TestClient.createClient().getCustomFieldsController();

@BeforeAll
static void setup() throws IOException, ApiException {
resources = new CustomFieldsTestsUtils.Resources();
}

@AfterAll
static void teardown() throws IOException, ApiException {
TestTeardown testTeardown = new TestTeardown();
testTeardown.deleteMetafields();
testTeardown.deleteCustomer(resources.getCustomer());
}

@ParameterizedTest
@EnumSource(ResourceType.class)
void shouldCreateMetadata(ResourceType resourceType) throws IOException, ApiException {
// given
String textMetafieldName = "text-" + randomNumeric(7);
String radioMetafieldName = "radio-" + randomNumeric(7);
List<String> radioEnum = List.of("radio-option-1", "radio-option-2");
String dropdownMetafieldName = "dropdown-" + randomNumeric(7);
List<String> dropdownEnum = List.of("dropdown-option-1", "dropdown-option-2");
int resourceId = resources.getIdForResourceType(resourceType);

CreateMetafieldsRequest createMetafieldsRequest =
new CreateMetafieldsRequest(
CreateMetafieldsRequestMetafields.fromListOfCreateMetafield(
List.of(
new CreateMetafield.Builder()
.name(textMetafieldName)
.build(),
new CreateMetafield.Builder()
.name(radioMetafieldName)
.inputType(MetafieldInput.RADIO)
.mEnum(radioEnum)
.build(),
new CreateMetafield.Builder()
.name(dropdownMetafieldName)
.inputType(MetafieldInput.DROPDOWN)
.mEnum(dropdownEnum)
.build()
)
));

CreateMetadataRequest createMetadataRequest =
new CreateMetadataRequest(
List.of(
new CreateMetadata(textMetafieldName, "text"),
new CreateMetadata(radioMetafieldName, "radio-option-2"),
new CreateMetadata(dropdownMetafieldName, "dropdown-option-1")

)
);
// when
List<Metafield> metafields = CUSTOM_FIELDS_CONTROLLER.createMetafields(resourceType, createMetafieldsRequest);
List<Metadata> metadata = CUSTOM_FIELDS_CONTROLLER.createMetadata(resourceType, resourceId, createMetadataRequest);

// then
assertThat(metadata.size()).isEqualTo(3);

assertThat(metadata.get(0).getId()).isNotNull();
assertThat(metadata.get(0).getName()).isEqualTo(textMetafieldName);
assertThat(metadata.get(0).getValue()).isEqualTo("text");
assertThat(metadata.get(0).getResourceId()).isEqualTo(resourceId);
assertThat(metadata.get(0).getMetafieldId()).isEqualTo(metafields.get(0).getId());
assertThat(metadata.get(0).getDeletedAt()).isNull();

assertThat(metadata.get(1).getId()).isNotNull();
assertThat(metadata.get(1).getName()).isEqualTo(radioMetafieldName);
assertThat(metadata.get(1).getValue()).isEqualTo("radio-option-2");
assertThat(metadata.get(1).getResourceId()).isEqualTo(resourceId);
assertThat(metadata.get(1).getMetafieldId()).isEqualTo(metafields.get(1).getId());
assertThat(metadata.get(1).getDeletedAt()).isNull();

assertThat(metadata.get(2).getId()).isNotNull();
assertThat(metadata.get(2).getName()).isEqualTo(dropdownMetafieldName);
assertThat(metadata.get(2).getValue()).isEqualTo("dropdown-option-1");
assertThat(metadata.get(2).getResourceId()).isEqualTo(resourceId);
assertThat(metadata.get(2).getMetafieldId()).isEqualTo(metafields.get(2).getId());
assertThat(metadata.get(2).getDeletedAt()).isNull();
}

@ParameterizedTest
@EnumSource(ResourceType.class)
void shouldCreateAdHocMetadata(ResourceType resourceType) throws IOException, ApiException {
// given
String textMetafieldName = "adhoc-text-" + randomNumeric(7);
int resourceId = resources.getIdForResourceType(resourceType);
CreateMetadataRequest createMetadataRequest =
new CreateMetadataRequest(
List.of(
new CreateMetadata(textMetafieldName, "text")
)
);

// when
List<Metadata> metadata = CUSTOM_FIELDS_CONTROLLER
.createMetadata(resourceType, resourceId, createMetadataRequest);
List<Metafield> metafields = CUSTOM_FIELDS_CONTROLLER.listMetafields(
new ListMetafieldsInput.Builder()
.resourceType(resourceType)
.name(textMetafieldName)
.build()
).getMetafields();

// then
assertThat(metadata.size()).isEqualTo(1);

assertThat(metadata.get(0).getId()).isNotNull();
assertThat(metadata.get(0).getName()).isEqualTo(textMetafieldName);
assertThat(metadata.get(0).getValue()).isEqualTo("text");
assertThat(metadata.get(0).getResourceId()).isEqualTo(resourceId);
assertThat(metadata.get(0).getMetafieldId()).isNotNull();
assertThat(metadata.get(0).getDeletedAt()).isNull();

assertThat(metafields.size()).isEqualTo(1);
assertThat(metadata.get(0).getName()).isEqualTo(textMetafieldName);
assertThat(metadata.get(0).getMetafieldId()).isEqualTo(metafields.get(0).getId());
}

@ParameterizedTest
@EnumSource(ResourceType.class)
void shouldNotCreateMetadataWhenValueIsTooBig(ResourceType resourceType) throws IOException, ApiException {
// given
String textMetafieldName = "adhoc-text-" + randomNumeric(7);
CreateMetadataRequest createMetadataRequest =
new CreateMetadataRequest(
List.of(
new CreateMetadata(textMetafieldName, "abcde".repeat(500))
)
);

// when
List<Metadata> metadata = CUSTOM_FIELDS_CONTROLLER
.createMetadata(resourceType, resources.getIdForResourceType(resourceType), createMetadataRequest);

// then
assertThat(metadata.size()).isEqualTo(1);
assertEmptyMetadata(metadata.get(0), textMetafieldName);
}

@ParameterizedTest
@EnumSource(ResourceType.class)
void shouldNotCreateMetadataWhenValueNotInEnum(ResourceType resourceType) throws IOException, ApiException {
// given
List<String> radioEnum = List.of("radio-option-1", "radio-option-2");
String radioMetafieldName = "radio-" + randomNumeric(7);
CreateMetafieldsRequest createMetafieldsRequest =
new CreateMetafieldsRequest(
CreateMetafieldsRequestMetafields.fromCreateMetafield(
new CreateMetafield.Builder()
.name(radioMetafieldName)
.inputType(MetafieldInput.RADIO)
.mEnum(radioEnum)
.build()
));
CreateMetadataRequest createMetadataRequest =
new CreateMetadataRequest(
List.of(
new CreateMetadata(radioMetafieldName, "abcde")
)
);

// when
CUSTOM_FIELDS_CONTROLLER.createMetafields(resourceType, createMetafieldsRequest);
List<Metadata> metadata = CUSTOM_FIELDS_CONTROLLER
.createMetadata(resourceType, resources.getIdForResourceType(resourceType), createMetadataRequest);

// then
assertThat(metadata.size()).isEqualTo(1);
assertEmptyMetadata(metadata.get(0), radioMetafieldName);
}

@ParameterizedTest
@MethodSource("argsForShouldReturn422WhenCreatingMetafieldsWithInvalidData")
void shouldReturn422WhenCreatingMetadataWithInvalidData(CreateMetadataRequest request,
String expectedError) {
// when - then
CommonAssertions.assertThatSingleErrorResponse(
() -> CUSTOM_FIELDS_CONTROLLER.createMetadata(ResourceType.SUBSCRIPTIONS,
resources.getSubscription().getId(), request))
.isUnprocessableEntity()
.hasErrorMessage(expectedError);
}

private static Stream<Arguments> argsForShouldReturn422WhenCreatingMetafieldsWithInvalidData() {
return Stream.of(
Arguments.of(
null, "The root key 'metadata' is required"
),
Arguments.of(
new CreateMetadataRequest(List.of(new CreateMetadata())),
"'name' must be present to create or update metafields"
),
Arguments.of(
new CreateMetadataRequest(List.of(new CreateMetadata("", null))),
"'name' must be present to create or update metafields"
)
);
}

@ParameterizedTest
@EnumSource(ResourceType.class)
void shouldNotCreateMetadataForNonExistentResource(ResourceType resourceType) {
assertNotFound(() -> CUSTOM_FIELDS_CONTROLLER.createMetadata(resourceType, 123, null));
}

@Test
void shouldNotCreateMetadataWhenProvidingInvalidCredentials() {
assertUnauthorized(() -> TestClient.createInvalidCredentialsClient().getCustomFieldsController()
.createMetadata(ResourceType.SUBSCRIPTIONS, 123, null));
}

private void assertEmptyMetadata(Metadata metadata, String name) {
assertThat(metadata.getName()).isEqualTo(name);
assertThat(metadata.getId()).isNull();
assertThat(metadata.getMetafieldId()).isNull();
assertThat(metadata.getValue()).isNull();
assertThat(metadata.getResourceId()).isNull();
assertThat(metadata.getDeletedAt()).isNull();
}

}
125 changes: 125 additions & 0 deletions ...io/advancedbilling/controllers/customfields/CustomFieldsControllerDeleteMetadataTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
package com.maxio.advancedbilling.controllers.customfields;

import com.maxio.advancedbilling.TestClient;
import com.maxio.advancedbilling.controllers.CustomFieldsController;
import com.maxio.advancedbilling.exceptions.ApiException;
import com.maxio.advancedbilling.models.CreateMetadata;
import com.maxio.advancedbilling.models.CreateMetadataRequest;
import com.maxio.advancedbilling.models.ListMetadataForResourceTypeInput;
import com.maxio.advancedbilling.models.Metadata;
import com.maxio.advancedbilling.models.ResourceType;

import com.maxio.advancedbilling.utils.TestTeardown;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.EnumSource;

import java.io.IOException;
import java.util.List;

import static com.maxio.advancedbilling.utils.assertions.CommonAssertions.assertNotFound;
import static com.maxio.advancedbilling.utils.assertions.CommonAssertions.assertUnauthorized;
import static org.apache.commons.lang3.RandomStringUtils.randomNumeric;
import static org.assertj.core.api.Assertions.assertThat;

public class CustomFieldsControllerDeleteMetadataTest {

private static CustomFieldsTestsUtils.Resources resources;
private static final CustomFieldsController CUSTOM_FIELDS_CONTROLLER =
TestClient.createClient().getCustomFieldsController();

@BeforeAll
static void setup() throws IOException, ApiException {
resources = new CustomFieldsTestsUtils.Resources();
}

@AfterAll
static void teardown() throws IOException, ApiException {
TestTeardown testTeardown = new TestTeardown();
testTeardown.deleteMetafields();
testTeardown.deleteCustomer(resources.getCustomer());
}

@ParameterizedTest
@EnumSource(ResourceType.class)
void shouldDeleteSingleMetadata(ResourceType resourceType) throws IOException, ApiException {
// given
String textMetafieldName = "text-to-delete-" + randomNumeric(7);
int resourceId = resources.getIdForResourceType(resourceType);

CreateMetadataRequest createMetadataRequest =
new CreateMetadataRequest(
List.of(
new CreateMetadata(textMetafieldName, "text")
)
);

// when
CUSTOM_FIELDS_CONTROLLER.createMetadata(resourceType, resourceId, createMetadataRequest);
CUSTOM_FIELDS_CONTROLLER.deleteMetadata(resourceType, resourceId, textMetafieldName, null);

// then
List<Metadata> metadata = CUSTOM_FIELDS_CONTROLLER.listMetadataForResourceType(new ListMetadataForResourceTypeInput.Builder()
.resourceType(resourceType)
.resourceIds(List.of(resourceId))
.build()
).getMetadata();
assertThat(metadata).isEmpty();
}

@ParameterizedTest
@EnumSource(ResourceType.class)
void shouldDeleteMultipleMetadata(ResourceType resourceType) throws IOException, ApiException {
// given
String metafieldName1 = "metafield-delete-" + randomNumeric(7);
String metafieldName2 = "metafield-delete-" + randomNumeric(7);
String metafieldName3 = "metafield-" + randomNumeric(7);

int resourceId = resources.getIdForResourceType(resourceType);

CreateMetadataRequest createMetadataRequest =
new CreateMetadataRequest(
List.of(
new CreateMetadata(metafieldName1, "text1"),
new CreateMetadata(metafieldName2, "text2"),
new CreateMetadata(metafieldName3, "text3")
)
);

// when
CUSTOM_FIELDS_CONTROLLER.createMetadata(resourceType, resourceId, createMetadataRequest);
CUSTOM_FIELDS_CONTROLLER.deleteMetadata(resourceType, resourceId, null, List.of(metafieldName1, metafieldName2));

// then
List<Metadata> metadata = CUSTOM_FIELDS_CONTROLLER.listMetadataForResourceType(new ListMetadataForResourceTypeInput.Builder()
.resourceType(resourceType)
.resourceIds(List.of(resourceId))
.build()
).getMetadata();
assertThat(metadata.size()).isEqualTo(1);
assertThat(metadata.get(0).getName()).isEqualTo(metafieldName3);
assertThat(metadata.get(0).getValue()).isEqualTo("text3");
}

@ParameterizedTest
@EnumSource(ResourceType.class)
void shouldNotDeleteNonExistentMetadata(ResourceType resourceType) {
assertNotFound(() -> CUSTOM_FIELDS_CONTROLLER.deleteMetadata(resourceType, resources.getIdForResourceType(resourceType),
"123", null));
}

@ParameterizedTest
@EnumSource(ResourceType.class)
void shouldNotDeleteMetadataForNonExistentResource(ResourceType resourceType) {
assertNotFound(() -> CUSTOM_FIELDS_CONTROLLER.deleteMetadata(resourceType, 123, null, null));
}

@Test
void shouldNotDeleteMetadataWhenProvidingInvalidCredentials() {
assertUnauthorized(() -> TestClient.createInvalidCredentialsClient().getCustomFieldsController()
.deleteMetadata(ResourceType.SUBSCRIPTIONS, 123, null, null));
}

}
Loading
Loading