updated tests

Author: ChadKluck

application-infrastructure/README-Application-Structure.md

@@ -141,14 +141,6 @@ All (non secret) configuration files and methods safe for repositories and used
 
 Shared methods that serve as tools, helpers, and utilities can be stored in the `utils` directory. These methods should be independent of Configurations, controllers, views, and models here. As your organization develops methods that are constantly re-used, they should probably be deployed as a Lambda Layer.
 
-### Tests directory
-
-`src/tests/`
-
-The `tests` directory can be used to store your tests written using Chai or other testing framework.
-
-There is a sample-data directory in models to store data that can be used for mocking requests, or conducting tests against.
-
 ### Package JSON file
 
 `src/package.json`
@@ -238,12 +230,40 @@ Why you might do this:
 - Easier to implement shared header or query string parameters (such as `format=json` if your endpoint requires such things)
 - Easier to provide limits, pagination, and unique error code handling for the endpoints.
 
-### Static Data Directory
+#### Static Data Directory
 
-`src/models/static/`
+`src/models/static-data/`
 
-The `models/static` directory contains supplemental static data that can be used for mapping and enhancing data returned by your application.
+The `models/static-data` directory contains supplemental static data that can be used for mapping and enhancing data returned by your application.
 
-Any data that isn't dynamic can be stored and used as labels, mappings, enhancements, etc.
+Any data that isn't dynamic can be stored and used as labels, mappings, enhancements, valid parameter lists, etc.
 
 For example, suppose data from an outside system returns coded location information. For example, `US-CHI` for Chicago. You can store a JSON object with the code mappings so that your API web service can return a fully formatted, human readable location.
+
+Another example is validating passed parameters. Suppose your application accepts a query string parameter for color coded data where there is a limited number of options and they stay relatively static. `['RED', 'BLUE', 'YELLOW', 'ORANGE', 'GREEN']` You store these as a separate file in static data and then import into your validation script to validate that the value passed from the client matches one of the accepted values.
+
+#### Sample Data Directory
+
+`src/models/sample-data`
+
+The `models/sample-data` directory contains sample data that represents data is returned from Endpoints and Data Access Objects. They can be used during testing and early prototyping. 
+
+For example, you could create a unit test that passes the data from a sample data file into a view and compares it to the expected output contained within a test-data file (See [Test Data](#test-data-directory)).
+
+#### Test Data Directory
+
+`src/models/test-data`
+
+The `models/test-data` directory contains test data that represents data used for testing.
+
+For example, you could create a unit test that passes the data from a sample data file into a view and compares it to the expected output contained within a test-data file. (See [Sample Data](#sample-data-directory)).
+
+### Tests directory
+
+`src/tests/`
+
+The `tests` directory can be used to store your tests written using Mocha or other testing framework.
+
+You can utilize sample and test data from the models directory for mocking and comparing results.
+
+For example, you can read in a sample data file (written in JSON or JavaScript) and pass it to a method. You can then compare the output using a test data file. (See [Sample Data](#sample-data-directory) and [Test Data](#test-data-directory))

application-infrastructure/src/config/validations.js

@@ -1,4 +1,4 @@
-const { statusCodes } = require("../models/static/index.js");
+const { statusCodes } = require("../models/static-data/index.js");
 const { tools: {DebugAndLog} } = require("@63klabs/cache-data");
 
 const referrers = [
@@ -20,7 +20,7 @@ const isStringOfNumbers = (value) => {
 // used in the organizationCode route handler to validate the organizationCode parameter
 const statusCodePathParameter = (code) => {
 	if (!Array.isArray(statusCodes) || statusCodes.length < 1) {
-		DebugAndLog.error("No status codes found in the application's static data folder '/data'!");
+		DebugAndLog.error("No status codes found in the application's static data folder '/models/static-data'!");
 		return false;
 	}
 	if (!code) return false;
@@ -29,14 +29,19 @@ const statusCodePathParameter = (code) => {
 	return statusCodes.some((statusCode) => statusCode.code === code);
 };
 
-const idPathParameter = (gameId) => {
-	if (!gameId) return false;
-	if (!isString(gameId)) return false;
-	if (!isStringOfNumbers(gameId)) return false; // demonstrates isStringOfNumbers() but next check does further inspection.
-	// check if the gameId is a valid number between 0 and 14 (inclusive)
-	const idNumber = parseInt(gameId, 10);
+const idPathParameter = (id) => {
+	if (!id) return false;
+	if (!isString(id)) return false;
+	// separate id by -
+	const [char, gid] = id.split("-");
+	if (!char || !gid) return false;
+	if (!isStringOfNumbers(gid)) return false;
+	// check if char is a letter
+	if (!char.match(/[A-Z]/)) return false;
+	// check if number is a number within range
+	const idNumber = parseInt(gid, 10);
 	if (isNaN(idNumber)) return false; // not a number
-	if (idNumber < 0 || idNumber > 14) return false;
+	if (idNumber < 1 || idNumber > 15) return false;
 	return true;
 };
 

application-infrastructure/src/models/index.js

@@ -1,5 +1,5 @@
 const ExampleDao = require("./Example.dao");
-const statusCodes = require("./static/statusCodes");
+const statusCodes = require("./static-data/statusCodes");
 
 module.exports = {
 	ExampleDao,

application-infrastructure/src/models/sample-data/games.sample.data.json renamed to application-infrastructure/src/models/sample-data/example.dao.sample.json

@@ -0,0 +1,23 @@
+{
+  "count": 15,
+  "items": [
+    { "game_id": "G-1", "display_name": "Falken's Maze" },
+    { "game_id": "G-2", "display_name": "Black Jack" },
+    { "game_id": "G-3", "display_name": "Gin Rummy" },
+    { "game_id": "G-4", "display_name": "Hearts" },
+    { "game_id": "G-5", "display_name": "Bridge" },
+    { "game_id": "G-6", "display_name": "Checkers" },
+    { "game_id": "G-7", "display_name": "Chess" },
+    { "game_id": "G-8", "display_name": "Poker" },
+    { "game_id": "G-9", "display_name": "Fighter Combat" },
+    { "game_id": "G-10", "display_name": "Guerrilla Engagement" },
+    { "game_id": "G-11", "display_name": "Desert Warfare" },
+    { "game_id": "G-12", "display_name": "Air-To-Ground Actions" },
+    { "game_id": "G-13", "display_name": "Theaterwide Tactical Warfare" },
+    {
+      "game_id": "G-14",
+      "display_name": "Theaterwide Biotoxic and Chemical Warfare"
+    },
+    { "game_id": "G-15", "display_name": "Global Thermonuclear War" }
+  ]
+}

application-infrastructure/src/models/static/index.js renamed to application-infrastructure/src/models/static-data/index.js

@@ -8,6 +8,7 @@ import { readFile } from 'fs/promises';
 import { expect } from "chai";
 
 import validations from '../config/validations.js';
+import { view as exampleView } from '../views/example.view.js';
 
 
 console.log(`Testing Against Node version ${tools.nodeVerMajor} (${tools.nodeVer})`);
@@ -37,7 +38,7 @@ describe('Test validations from config/validations.js', () => {
 
 		before(async () => {
 			try {
-				const filePath = path.join(__dirname, '..', 'models', 'static', 'statusCodes.json');
+				const filePath = path.join(__dirname, '..', 'models', 'static-data', 'statusCodes.json');
 				const fileContent = await readFile(filePath, 'utf8');
 				statusCodes = JSON.parse(fileContent);
 			} catch (error) {
@@ -82,27 +83,76 @@ describe('Test validations from config/validations.js', () => {
 		});
 	});
 
-	describe('validations.parameters.pathParameters.gamePrimaryId', () => {
+	describe('validations.parameters.pathParameters.id', () => {
 		it('should validate a valid game ID', () => {
-			const gamePrimaryId = '6';
-			expect(validations.parameters.pathParameters.id(gamePrimaryId)).to.be.true;
+			const id = 'G-6';
+			expect(validations.parameters.pathParameters.id(id)).to.be.true;
 		});
 
 		it('should reject an invalid game ID', () => {
-			const gamePrimaryId = 'invalid_game_id';
-			expect(validations.parameters.pathParameters.id(gamePrimaryId)).to.be.false;
+			const id = 'invalid_game_id';
+			expect(validations.parameters.pathParameters.id(id)).to.be.false;
 		});
 
 		it('should reject an invalid game ID based on negative value', () => {
-			const gamePrimaryId = '-1';
-			expect(validations.parameters.pathParameters.id(gamePrimaryId)).to.be.false;
+			const id = '-1';
+			expect(validations.parameters.pathParameters.id(id)).to.be.false;
 		});
 
 		it('should reject an invalid game ID based on length (too long)', () => {
-			const gamePrimaryId = '102';
-			expect(validations.parameters.pathParameters.id(gamePrimaryId)).to.be.false;
+			const id = '102';
+			expect(validations.parameters.pathParameters.id(id)).to.be.false;
+		});
+
+		it('should reject an invalid game ID based on length (too short)', () => {
+			const id = 'G-';
+			expect(validations.parameters.pathParameters.id(id)).to.be.false;
 		});
 
 	})
 });
 
+
+/* ****************************************************************************
+ * Views
+ */
+
+describe('Test views/example.view.js', () => {
+	let sampleData;
+	let expectedData;
+
+	before(async () => {
+		try {
+			// Load input sample data
+			const sampleFilePath = path.join(__dirname, '..', 'models', 'sample-data', 'example.dao.sample.json');
+			const sampleFileContent = await readFile(sampleFilePath, 'utf8');
+			sampleData = JSON.parse(sampleFileContent);
+			
+			// Load expected output data
+			const expectedFilePath = path.join(__dirname, '..', 'models', 'test-data', 'example.view.output.json');
+			const expectedFileContent = await readFile(expectedFilePath, 'utf8');
+			expectedData = JSON.parse(expectedFileContent);
+		} catch (error) {
+			console.error('Error loading test data files:', error);
+			throw error;
+		}
+	});
+
+	describe('view function', () => {
+		it('should transform example data correctly', () => {
+			// Process the sample data through the view
+			const result = exampleView(sampleData);
+
+			// Check that the structure is maintained
+			expect(result).to.have.property('items').that.is.an('array');
+			expect(result).to.have.property('count', expectedData.count);
+			expect(result.items).to.have.lengthOf(expectedData.items.length);
+
+			// Check each example's transformed data against expected data
+			for (let i = 0; i < expectedData.items.length; i++) {
+				expect(result.items[i]).to.deep.include(expectedData.items[i]);
+			}
+		});
+
+	});
+});

application-infrastructure/src/models/static/statusCodes.json renamed to application-infrastructure/src/models/static-data/statusCodes.json

@@ -19,7 +19,7 @@ const filter = (dataItem = null) => {
 }
 
 // For this data we want to assign an index to each item in the view, so we can track it
-let index = -1;
+let index = 0;
 
 /**
  * Generic transformer
@@ -29,8 +29,8 @@ let index = -1;
 const transform = (data) => {
 
 	const returnData = {
-		id: index++,
-		display: data
+		game_id: `G-${++index}`,
+		display_name: data
 	};
 
 	return returnData;
@@ -43,7 +43,6 @@ const transform = (data) => {
  */
 exports.view = (resultsFromSvc) => {
 	const viewTimer = new Timer(`Timer: ${logIdentifier}`, true);
-	DebugAndLog.debug(`View: ${logIdentifier}`, data);
 
 	// if data then data else empty array
 	const dataArray = Array.isArray(resultsFromSvc?.gamechoices) ? resultsFromSvc?.gamechoices : [];
@@ -53,7 +52,7 @@ exports.view = (resultsFromSvc) => {
 	// which is more efficient especially for large datasets, 
 	// But for clarity we will keep them separate here.
 
-	// filter out the data
+	// filter the data
 	const filteredArray = dataArray.filter((item) => filter(item));
 
 	// transform the data