Test bundle, Documentation & Codi 🐶 Update #1707

RobAndrewHurst · 2024-11-13T05:23:09Z

Description

Implemented a comprehensive test bundle system to enhance test reusability across different environments. This update includes:

Test Bundle Features

Created reusable workspace assets for cross-environment testing
Did a review and optimization of the majority of existing test suites. (Some still need to be revisted and reworked.)
Standardized test configurations for better maintainability

Codi 🐶 v0.0.47 Updates

Enhanced test output control with --quiet flag
- Streamlines output by displaying only test failures
- Reduces noise in CI/CD pipelines
- Backward compatible with existing test configurations

GitHub Issue

Resolves #1440

Type of Change

✅ New feature (non-breaking change which adds functionality)
- Test bundle system
- Enhanced output control
✅ Documentation
- Updated test configuration guides
✅ Testing
- Improved test organization
- Enhanced cross-environment compatibility
- Optimized test asset reusability

RobAndrewHurst · 2024-11-14T06:24:48Z

esbuild.config.mjs

@@ -4,13 +4,14 @@ import * as esbuild from 'esbuild'
 const isDev = process.env.NODE_ENV !== 'DEVELOPMENT';

 const buildOptions = {
-    entryPoints: ['./lib/mapp.mjs', './lib/ui.mjs'],
+    entryPoints: isDev ? ['./lib/mapp.mjs', './lib/ui.mjs'] : ['./lib/mapp.mjs', './lib/ui.mjs', './tests/_mapp.test.mjs'],


We bundle the test assets if we are in DEVELOPMENT mode. We can discuss if we want this all the time or in other certain situations.

RobAndrewHurst · 2024-11-14T06:25:19Z

package.json

@@ -11,7 +11,7 @@
  "scripts": {
    "test": "codi tests",
    "_build": "node esbuild.config.mjs",
-    "browser-sync": "npx browser-sync start --proxy localhost:3000 --port 3001 --ui-port 3002 --files public/js/lib/**/* --no-open --no-notify",
+    "browser-sync": "npx browser-sync start --proxy localhost:3000 --port 3001 --ui-port 3002 --files public/js/**/* --no-open --no-notify",


Browser sync will now reload for either changes to lib or tests

RobAndrewHurst · 2024-11-14T06:28:40Z

public/views/_test.html

+            if (integrity) {
+                results = await codi.runWebTests(testFiles);
+            } else {
+                results = await codi.runWebTestFunction(_mappTest.coreTest);


This webTestFunction might be better used on each test function in the test bundle to try aid parallel testing in the future.

RobAndrewHurst · 2024-11-14T06:29:51Z

tests/_mapp.test.mjs

+import { formatTest } from './lib/layer/format/_format.test.mjs';
+import { ui_locations } from './lib/ui/locations/_locations.test.mjs';
+
+self._mappTest = {


This is the test bundle entry point that self assigns just like mapp

RobAndrewHurst · 2024-11-14T06:30:22Z

tests/assets/layers/cluster/layer.json

@@ -0,0 +1,67 @@
+{


Example of saving away a configuration, which can be imported from the bundled test library.

RobAndrewHurst · 2024-11-14T06:31:08Z

tests/lib/layer/format/mvt.test.mjs

-                    }
-                }
-            }
+import mvt_layer_default from '../../../assets/layers/mvt/layer.json';


Example of importing the asset. This will be applied more as I continue the re-review and structure of current tests

RobAndrewHurst · 2024-11-14T06:32:21Z

tests/lib/mapview/allfeatures.test.mjs

-            //TODO
-        });
-    });
+    // await codi.describe('TODO: Mapview: allfeaturesTest', async () => {


Keeping these TODO's in the test base so I can get to the asap

RobAndrewHurst · 2024-11-14T06:32:53Z

tests/lib/ui/Tabview.test.mjs

@@ -3,67 +3,7 @@
 * @function Tabview 
 */
 export async function Tabview() {
-


This need to be re-reviewed

AlexanderGeere

The quiet flag is a nice addition. The testing.md makes sense to me 👍

simon-leech

The integrity tests are not working correctly.

At the start of the integrity test it throws an error that /js/tests/_mapp.test.js does not exist (404).

I also see an error 'Erroringrunning test file' using this path /public/tests/integrity.test.mjs. This is also timing out after 5000ms in the webRunner.

The tests then also say that they have finished way before all the thematics have finished running through the test.

RobAndrewHurst · 2024-11-15T09:39:24Z

The integrity tests are not working correctly.

At the start of the integrity test it throws an error that /js/tests/_mapp.test.js does not exist (404).

I also see an error 'Erroringrunning test file' using this path /public/tests/integrity.test.mjs. This is also timing out after 5000ms in the webRunner.

The tests then also say that they have finished way before all the thematics have finished running through the test.

How are you running the tests?

dbauszus-glx

The nodemon.json references local resources and must be added to ignore. The file and it's content must be referenced in the testing.md to explain the build process.

RobAndrewHurst · 2024-11-15T11:35:26Z

The nodemon.json references local resources and must be added to ignore. The file and it's content must be referenced in the testing.md to explain the build process.

I have updated the documentation and removed nodemon.json and added in an example config into the DEVELOPING docs

Need to see how the tests are called

Waiting on re-review

sonarcloud · 2024-11-15T12:18:35Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

RobAndrewHurst · 2024-11-15T12:22:36Z

After some discussion @simon-leech has pushed a change where the test bundle will happen all the time. This is fine because only on the _test.html view do we call the bundle!

RobAndrewHurst and others added 8 commits November 11, 2024 13:11

Update test bundle

93fe346

Test bundle

47d80d5

Update tests

5440124

update decorate test

6dff52c

Test updates

ecb931d

update tests

3d979a3

Remove incorrect file

df16430

Merge branch 'patch' into test_bundle

b5d0430

RobAndrewHurst requested review from cityremade, dbauszus-glx, AlexanderGeere and simon-leech November 13, 2024 08:51

codi version update and test update

c4c6828

RobAndrewHurst changed the title ~~Test bundle~~ Test bundle, Documentation & Codi 🐶 Update Nov 14, 2024

RobAndrewHurst added 2 commits November 14, 2024 08:19

Update Testing docs and codi bump

78a3595

Merge branch 'patch' into test_bundle

7010d84

RobAndrewHurst marked this pull request as ready for review November 14, 2024 06:20

RobAndrewHurst linked an issue Nov 14, 2024 that may be closed by this pull request

Codi tests documentation and options #1440

Open

RobAndrewHurst commented Nov 14, 2024

View reviewed changes

RobAndrewHurst added Testing Changes relating to existing or new unit tests. Documentation Adding or updating documentation. labels Nov 14, 2024

RobAndrewHurst and others added 2 commits November 14, 2024 08:39

Merge branch 'patch' into test_bundle

537dc0a

Merge branch 'patch' into test_bundle

afea889

AlexanderGeere approved these changes Nov 15, 2024

View reviewed changes

simon-leech previously requested changes Nov 15, 2024

View reviewed changes

dbauszus-glx previously requested changes Nov 15, 2024

View reviewed changes

Update docs and remove nodemon.json

4a8fdfc

RobAndrewHurst requested a review from dbauszus-glx November 15, 2024 11:36

RobAndrewHurst requested a review from simon-leech November 15, 2024 11:36

simon-leech added 2 commits November 15, 2024 12:17

Change Console Log for easier debugging

fd8d324

Always build the test

95effc0

simon-leech approved these changes Nov 15, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Test bundle, Documentation & Codi 🐶 Update #1707

Test bundle, Documentation & Codi 🐶 Update #1707

RobAndrewHurst commented Nov 13, 2024 •

edited

Loading

RobAndrewHurst Nov 14, 2024

RobAndrewHurst Nov 14, 2024

RobAndrewHurst Nov 14, 2024

RobAndrewHurst Nov 14, 2024

RobAndrewHurst Nov 14, 2024

RobAndrewHurst Nov 14, 2024

RobAndrewHurst Nov 14, 2024

RobAndrewHurst Nov 14, 2024

AlexanderGeere left a comment

simon-leech left a comment

RobAndrewHurst commented Nov 15, 2024

dbauszus-glx left a comment

RobAndrewHurst commented Nov 15, 2024

sonarcloud bot commented Nov 15, 2024

RobAndrewHurst commented Nov 15, 2024

Test bundle, Documentation & Codi 🐶 Update #1707

Are you sure you want to change the base?

Test bundle, Documentation & Codi 🐶 Update #1707

Conversation

RobAndrewHurst commented Nov 13, 2024 • edited Loading

Description

Test Bundle Features

Codi 🐶 v0.0.47 Updates

GitHub Issue

Type of Change

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AlexanderGeere left a comment

Choose a reason for hiding this comment

simon-leech left a comment

Choose a reason for hiding this comment

RobAndrewHurst commented Nov 15, 2024

dbauszus-glx left a comment

Choose a reason for hiding this comment

RobAndrewHurst commented Nov 15, 2024

sonarcloud bot commented Nov 15, 2024

Quality Gate passed

RobAndrewHurst commented Nov 15, 2024

RobAndrewHurst commented Nov 13, 2024 •

edited

Loading