Skip to content

Add tests for nested global fields and API version header #160

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
reeshika-h merged 3 commits into from
Jul 2, 2025
Merged

Add tests for nested global fields and API version header #160

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
efa71dd
Add tests for nested global fields and API version header
reeshika-h Jul 1, 2025
d6553ae
Enhance GlobalField to manage API version in request headers. Added a…
reeshika-h Jul 1, 2025
c3a81c4
enhance GlobalField to handle api_version in headers and add tests fo…
reeshika-h Jul 2, 2025
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
111 changes: 111 additions & 0 deletions src/test/java/com/contentstack/cms/stack/GlobalFieldAPITest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,31 @@
package com.contentstack.cms.stack;

import java.io.IOException;
import java.util.HashMap;

import com.contentstack.cms.TestClient;
import com.contentstack.cms.Utils;
import com.contentstack.cms.core.Util;

import okhttp3.Request;

import org.json.simple.JSONObject;
import org.junit.jupiter.api.*;

import com.contentstack.cms.Contentstack;
import com.google.gson.JsonObject;

import okhttp3.ResponseBody;
import retrofit2.Response;

@Tag("unit")
@TestInstance(TestInstance.Lifecycle.PER_CLASS)
class GlobalFieldAPITest {

public static GlobalField globalField;
protected static String API_KEY = TestClient.API_KEY;
protected static String MANAGEMENT_TOKEN = TestClient.MANAGEMENT_TOKEN;
protected static String AUTHTOKEN = TestClient.AUTHTOKEN;
protected static String globalFieldUid = "global_field_1";
protected static String globalFieldUid2 = "nested_global_field";
protected static Stack stack;
Expand Down Expand Up @@ -327,4 +339,103 @@ void testExportNestedGlobalField() {
// Assertions.assertNull(request.url().encodedQuery());
// }


@Test
void testApiVersionHeaderIsSet() {
HashMap<String, Object> headers = new HashMap<>();
headers.put(Util.API_KEY, API_KEY);
headers.put(Util.AUTHORIZATION, MANAGEMENT_TOKEN);
String apiVersion = "3.2";
Stack stack = new Contentstack.Builder().setAuthtoken(AUTHTOKEN).build().stack(headers);
GlobalField gfWithApiVersion = new GlobalField(stack.client, stack.headers, "feature");
gfWithApiVersion.addHeader("api_version", apiVersion);
Request request = gfWithApiVersion.fetch().request();
Assertions.assertEquals(apiVersion, request.header("api_version"));
}

// --- Nested Global Field Test Suite ---
@Nested
@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
class NestedGlobalFieldTests {
GlobalField nestedGlobalField;
String nestedUid = "nested_global_field";
String apiVersion = "3.2";

@BeforeEach
void setupNested() {
HashMap<String, Object> headers = new HashMap<>();
headers.put(Util.API_KEY, API_KEY);
headers.put(Util.AUTHORIZATION, MANAGEMENT_TOKEN);
Stack stack = new Contentstack.Builder().setAuthtoken(AUTHTOKEN).build().stack(headers);
nestedGlobalField = new GlobalField(stack.client, stack.headers, nestedUid);
nestedGlobalField.addHeader("api_version", apiVersion);
}

@Test
@Order(1)
void testCreateNestedGlobalField() throws IOException {
JSONObject requestBody = Utils.readJson("globalfield/nested_global_field.json");
Request request = nestedGlobalField.create(requestBody).request();
Assertions.assertEquals("https://api.contentstack.io/v3/global_fields", request.url().toString());
Assertions.assertEquals("/v3/global_fields", request.url().encodedPath());
Assertions.assertEquals("https", request.url().scheme());
Assertions.assertEquals("POST", request.method());
Assertions.assertEquals(apiVersion, request.header("api_version"));
Response<ResponseBody> response = nestedGlobalField.create(requestBody).execute();
Assertions.assertEquals(201, response.code());
}

@Test
@Order(2)
void testGetNestedGlobalField() throws IOException{
nestedGlobalField.addParam("include_global_fields", true);
nestedGlobalField.addParam("include_validation_keys", true);
Request request = nestedGlobalField.fetch().request();
Assertions.assertEquals("https://api.contentstack.io/v3/global_fields/" + nestedUid + "?include_global_fields=true&include_validation_keys=true", request.url().toString());
Assertions.assertEquals("https", request.url().scheme());
Assertions.assertEquals("GET", request.method());
Assertions.assertEquals(apiVersion, request.header("api_version"));
Response<ResponseBody> response = nestedGlobalField.fetch().execute();
Assertions.assertEquals(200, response.code());
JsonObject responseBody = Utils.toJson(response).getAsJsonObject();
JsonObject globalField = responseBody.getAsJsonObject("global_field");
Assertions.assertEquals("Nested Global Field", globalField.get("title").getAsString());
Assertions.assertTrue(globalField.has("referred_global_fields"));
Assertions.assertTrue(globalField.has("validation_keys"));
}

@Test
@Order(3)
void testUpdateNestedGlobalField() throws IOException {
JSONObject requestBody = Utils.readJson("globalfield/nested_global_field_update1.json");
Request request = nestedGlobalField.update(requestBody).request();
Assertions.assertEquals("https://api.contentstack.io/v3/global_fields/" + nestedUid, request.url().toString());
Assertions.assertEquals("/v3/global_fields/" + nestedUid, request.url().encodedPath());
Assertions.assertEquals("https", request.url().scheme());
Assertions.assertEquals("PUT", request.method());
Assertions.assertEquals(apiVersion, request.header("api_version"));
Response<ResponseBody> response = nestedGlobalField.update(requestBody).execute();
Assertions.assertEquals(200, response.code());
JsonObject responseBody = Utils.toJson(response).getAsJsonObject();
JsonObject globalField = responseBody.getAsJsonObject("global_field");
Assertions.assertEquals("Nested Global Field", globalField.get("title").getAsString());

}

@Test
@Order(4)
void testDeleteNestedGlobalField() throws IOException {
Request request = nestedGlobalField.delete().request();
Assertions.assertEquals("https://api.contentstack.io/v3/global_fields/" + nestedUid + "?force=true", request.url().toString());
Assertions.assertEquals("https", request.url().scheme());
Assertions.assertEquals("DELETE", request.method());
Assertions.assertEquals(apiVersion, request.header("api_version"));
Response<ResponseBody> response = nestedGlobalField.delete().execute();
Assertions.assertEquals(200, response.code());
JsonObject responseBody = Utils.toJson(response).getAsJsonObject();
Assertions.assertEquals("Global Field deleted successfully.", responseBody.get("notice").getAsString());
}
}


}
44 changes: 44 additions & 0 deletions src/test/resources/globalfield/nested_global_field.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{
"global_field": {
"title": "Nested Global Field",
"uid": "nested_global_field",
"description": "",
"schema": [
{
"data_type": "text",
"display_name": "Single Line Textbox",
"uid": "single_line",
"field_metadata": {
"description": "",
"default_value": "",
"version": 3
},
"format": "",
"error_messages": {
"format": ""
},
"mandatory": false,
"multiple": false,
"non_localizable": false,
"unique": false,
"indexed": false,
"inbuilt_model": false
},
{
"data_type": "global_field",
"display_name": "SEO",
"reference_to": "seo",
"field_metadata": {
"description": ""
},
"uid": "seo",
"mandatory": false,
"multiple": false,
"non_localizable": false,
"unique": false,
"indexed": false,
"inbuilt_model": false
}
]
}
}
59 changes: 59 additions & 0 deletions src/test/resources/globalfield/nested_global_field_update1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
{
"global_field": {
"title": "Nested Global Field",
"uid": "nested_global_field",
"description": "",
"schema": [
{
"data_type": "text",
"display_name": "Single Line Textbox",
"uid": "single_line",
"field_metadata": {
"description": "",
"default_value": "",
"version": 3
},
"format": "",
"error_messages": {
"format": ""
},
"mandatory": false,
"multiple": false,
"non_localizable": false,
"unique": false,
"indexed": false,
"inbuilt_model": false
},
{
"data_type": "global_field",
"display_name": "SEO",
"reference_to": "seo",
"field_metadata": {
"description": ""
},
"uid": "seo",
"mandatory": false,
"multiple": false,
"non_localizable": false,
"unique": false,
"indexed": false,
"inbuilt_model": false
},
{
"data_type": "global_field",
"display_name": "feature",
"reference_to": "feature",
"field_metadata": {
"description": ""
},
"uid": "feature",
"mandatory": false,
"multiple": false,
"non_localizable": false,
"unique": false,
"indexed": false,
"inbuilt_model": false
}
]
}
}