1. /**
  2. * Compares API responses for testing.
  3. *
  4. * @param {Array<Object>} expectedResponses - Array of expected API responses. Each object should have a 'data' property containing the expected data.
  5. * @param {Array<Object>} actualResponses - Array of actual API responses. Each object should have a 'data' property containing the actual data.
  6. * @param {string} [key='data'] - The key in the response object containing the data to compare. Defaults to 'data'.
  7. * @returns {Promise<Array<string>>} - A promise that resolves to an array of strings, each representing a comparison error. Returns an empty array if all responses match.
  8. */
  9. async function compareApiResponses(expectedResponses, actualResponses, key = 'data') {
  10. const errors = [];
  12. if (!expectedResponses || !actualResponses) {
  13. return errors; // Return empty array if either input is missing
  14. }
  16. const expectedData = expectedResponses.map(resp => resp[key]);
  17. const actualData = actualResponses.map(resp => resp[key]);
  19. if(expectedData.length !== actualData.length){
  20. errors.push("Arrays have different lengths: expected " + expectedData.length + ", actual " + actualData.length);
  21. return errors;
  22. }
  25. for (let i = 0; i < expectedData.length; i++) {
  26. if (typeof expectedData[i] === 'object' && typeof actualData[i] === 'object') {
  27. if (!deepCompare(expectedData[i], actualData[i])) {
  28. errors.push(`Index ${i}: Expected ${JSON.stringify(expectedData[i])}, but got ${JSON.stringify(actualData[i])}`);
  29. }
  30. } else if (expectedData[i] !== actualData[i]) {
  31. errors.push(`Index ${i}: Expected ${expectedData[i]}, but got ${actualData[i]}`);
  32. }
  33. }
  35. return errors;
  37. function deepCompare(obj1, obj2) {
  38. if (typeof obj1 !== 'object' || typeof obj2 !== 'object' || obj1 === null || obj2 === null) {
  39. return obj1 === obj2; // handle primitive types and null
  40. }
  42. const keys1 = Object.keys(obj1);
  43. const keys2 = Object.keys(obj2);
  45. if (keys1.length !== keys2.length) {
  46. return false;
  47. }
  49. for (const key of keys1) {
  50. if (!obj2.hasOwnProperty(key) || !deepCompare(obj1[key], obj2[key])) {
  51. return false;
  52. }
  53. }
  55. return true;
  56. }
  57. }

Add your comment