WebGL stub for unit tests #4827

pjcozzi · 2017-01-09T13:30:33Z

Fixes #4281. Future work is #4817.

See the updated Testing Guide:

This PR includes some test cleanup, but any additional cleanup is not in the scope of this PR.

Expect some random failures on CI that we'll sort out...have seen just one so far.

TODO

Merge into 3d-tiles branch and friends
Any outstanding TODOs in the code
LabelCollection CV test, Fix LabelCollection CV bounding sphere test #4816

…cases

markerikson · 2017-01-21T19:26:10Z

Out of curiosity, could this be used in application-level unit tests for code that uses Cesium as well?

pjcozzi · 2017-01-21T20:28:58Z

@markerikson yes, the app's tests would just pass in the WebGL stub when constructing Cesium's Viewer. The app could also use the custom Jasmine matchers as well depending on how tightly integrated you want to be.

lilleyse

Looks really nice overall with some good cleanup in some specs.

lilleyse · 2017-01-23T20:00:16Z

Specs/Renderer/CubeMapSpec.js

        cubeMap = new CubeMap({
-            context : context,
+            context : cxt,


Is the abbreviation to avoid overlap with the var context at the top?

lilleyse · 2017-01-23T20:02:57Z

Specs/Renderer/CubeMapSpec.js

-        expect(context.readPixels()).toEqual([0, 0, 255, 255]);
+            fragmentShader : fs,
+            uniformMap : uniformMap
+        }).contextToRender([0, 0, 255, 255]);


Is this test actually checking that there are mipmaps present? Beyond the scope of this PR?

Yes, beyond the scope. Update #4817 if you want, but it could be too WebGL implementation-specific to bother.

lilleyse · 2017-01-23T20:30:50Z

Specs/Renderer/ShaderProgramSpec.js

            context : context,
            vertexShaderSource : vs,
            fragmentShaderSource : fs
        });
+        sp.destroy();


For this and below why destroy the shader program here?

lilleyse · 2017-01-23T20:32:30Z

Specs/Renderer/ShaderProgramSpec.js

@@ -538,6 +533,10 @@ defineSuite([
    });

    it('fails to link', function() {
+        if (webglStub) {
+            return; // WebGL Stub does not return vertex attribute and uniforms in the shader


Comment doesn't really apply to this case and the two above.

lilleyse · 2017-01-23T21:02:26Z

Specs/Scene/MaterialSpec.js

-        expect(pixel).toEqual([0, 255, 0, 255]);
+        renderMaterial(material1, false, function(rgba) {
+            expect(rgba).toEqual([0, 255, 0, 255]);
+        });


All these callbacks just check the color, could the expected color be sent to renderMaterial instead?

lilleyse · 2017-01-23T21:44:21Z

Specs/getWebGLStub.js

+        stub.vertexAttrib4f = noop;
+        stub.vertexAttrib4fv = noop;
+        stub.vertexAttribPointer = noop;
+        stub.viewport = noop;


I didn't look closely - does this include WebGL2 functions?

No, that is part of #4817.

lilleyse · 2017-01-23T21:45:10Z

Specs/getWebGLStub.js

+
+    function getStubWarning() {
+        //>>includeStart('debug', pragmas.debug);
+        throw new DeveloperError('A stub for this get/is function is not defined.  Can it use getStub() or does it need a new one?');


Is this warning message a TODO?

This is for if we start using get* WebGL functions that we are not currently using, we may may need to implement a custom stub for them. I would rather throw this exception so we know to make the change then try to fly by with undefined, 0, false, {}, etc.

lilleyse · 2017-01-23T21:53:44Z

Documentation/Contributors/TestingGuide/README.md

+```javascript
+expect(context).toReadPixels([0, 0, 0, 255]);
+
+expect(context).notToReadPixels([0, 0, 0, 0]);


Should be [0, 0, 0, 255]

lilleyse · 2017-01-23T21:54:06Z

Specs/Renderer/CubeMapSpec.js

-        ClearCommand.ALL.execute(context);
-        expect(context.readPixels()).toEqual([0, 0, 0, 0]);
+        ClearCommand.ALL.execute(cxt);
+        expect(cxt).toReadPixels([0, 0, 0, 0]);


A few places expect [0, 0, 0, 0] instead of [0, 0, 0, 255]. Is there a reason for the discrepancy?

Yes, ClearCommand.ALL clears alpha to 0.0.

It is because alpha : true is used when creating the context.

I cleaned this up in this PR; when I first wrote the tests....6 years ago...for some reason I had the tests default to alpha : true even though Cesium did not (or maybe it did, then I set it to false because I heard it made browser compositing faster). Anyway, I think these are all correct.

lilleyse · 2017-01-23T21:54:56Z

Specs/Renderer/DrawSpec.js

@@ -775,7 +820,7 @@ defineSuite([
        // I believe different GL implementations are allowed to AA
        // in different ways (or at least that is what we see in practice),
        // so verify it at least rendered something.
-        expect(context.readPixels()).not.toEqual([0, 0, 0, 0]);
+        expect(context).notToReadPixels([0, 0, 0, 0]);


[0, 0, 0, 255]

lilleyse · 2017-01-23T22:01:13Z

There are several places where the vertex shader is sent in as attribute vec4 position; void main() { gl_PointSize = 1.0; gl_Position = position; } despite being the default.

lilleyse · 2017-01-23T22:01:33Z

test-webgl-stub should be added to the BuildGuide

pjcozzi · 2017-01-27T12:07:11Z

There are several places where the vertex shader is sent in as attribute vec4 position; void main() { gl_PointSize = 1.0; gl_Position = position; } despite being the default.

Do you mean that the default value for gl_PointSize is 1.0? Are you sure? I don't see this in the ES 2.0 and GLSL specs:

pjcozzi · 2017-01-27T12:50:30Z

Thanks for the review, updated.

pjcozzi · 2017-01-27T12:54:16Z

@lilleyse for when you merge this into 3d-tiles (which can be before or after this goes into master; up to you), here are my notes on how to update the unit tests:

Search/replace

expect(scene.renderForSpecs()).toEqual( ---> expect(scene).toRender(
expect(scene.renderForSpecs()).not.toEqual( ---> expect(scene).notToRender(

Search and replace by hand

renderForSpecs
pickForSpecs
scene.pick(new Cartesian2(0, 0))
expect(context.readPixels()).toEqual([
expect(context).toReadPixels([

There will also be some other less general cases.

Make sure to test in the browser and at the command-line, both with and without using the WebGL stub.

lilleyse · 2017-01-27T14:42:27Z

Do you mean that the default value for gl_PointSize is 1.0? Are you sure? I don't see this in the ES 2.0 and GLSL specs:

Yeah you can disregard my comment. I was referring to the fact that those vertex shaders are identical to the default vertex shader in addDefaultMatchers:expectContextToRender, but those tests don't go through contextToRender.

lilleyse · 2017-01-27T14:52:37Z

In ShadowMapSpec there are still some areas that call

expect({
    scene : scene,
    primeShadowMap : true
});

rather than calling renderAndExpect.

lilleyse · 2017-01-27T15:05:28Z

Besides that everything looks solid.

pjcozzi · 2017-01-27T17:13:24Z

Thanks, updated.

lilleyse · 2017-01-27T17:22:30Z

One last thing - this seems worthy of updating CHANGES.md

pjcozzi · 2017-01-27T19:34:20Z

Whoops, added to master: https://github.com/AnalyticalGraphicsInc/cesium/blob/master/CHANGES.md

lilleyse · 2017-01-27T20:14:27Z

Ok. Merging now.

I'll get to the 3d-tiles changes.

pjcozzi added 30 commits December 1, 2016 13:20

Start of expectRenderForSpecs and friends

c0f8776

Start of webglstub parameter

4912f49

Start of WebGL stub

1b16385

Remove unused code

c1f320c

WIP WebGL stubs. Viewer/Sandcastle run and SceneSpec passes.

9c54cb3

Pass through webglStub query parameter

547d126

Improve stub expect functions

580f379

Update Scene tests to new expectation stubs

95feba7

Update Model tests to use scene stub

8a220bd

Merge remote-tracking branch 'origin/master' into webgl-mock-for-tests

a75b7b9

Replace custom Scene expectation functions with custom Jasmine matchers

49b13ad

Update Model and Scene specs to use new custom Jasmine matchers

70e20ef

Merge remote-tracking branch 'origin/master' into webgl-mock-for-tests

2737775

Update DebugModelMatrixPrimitive specs to use WebGL stub

c21e1d9

Rename toPick to toPickAndCall to match toRenderAndCall

aac0794

Pass in time as part of the actual, not expected, value

f6077b8

Update Billboard, Label, and Point collection tests to use WebGL stub

fda3a20

Update moon and sky tests

461104f

Update shadow map tests to use WebGL stubs

42cd0d6

Make toRender and toRenderAndCall consistent

e1d1def

Update more tests to use new WebGL stubs

1bf523e

Merge remote-tracking branch 'origin/master' into webgl-mock-for-tests

6ca7cc7

Fix JSHint warnings

f8e7ffa

Fix custom matchers so scene.render and scene.pick are called in all …

08d3768

…cases

Update Primitive, Polyline, and Apperance tests to use WebGL stub

f23ef60

Fix PrimitiveCollection picking tests

caeb229

New toPickPrimitive custom matcher

72b8783

Convert the rest of the tests in Scene to use the WebGL stub

cf9bb81

Remove old pickForSpecs

b31303b

Added toDrillPickAndCall custom matcher

fd224b9

Merge remote-tracking branch 'origin/master' into webgl-mock-for-tests

7ef5df6

lilleyse reviewed Jan 23, 2017

View reviewed changes

Cleanup

3e33ad5

This was referenced Jan 25, 2017

SceneModePicker and PerformanceWatchdog test failures in master #4923

Closed

Test Failure: Core/writeTextToCanvas #4928

Closed

pjcozzi added 4 commits January 27, 2017 06:23

Merge remote-tracking branch 'origin/master' into webgl-mock-for-tests

a588cc3

Update test to use contextToRender

35658d0

Add testing with WebGL stubs to the Build Guide

95592a6

Remove test workaround

f3c37a7

pjcozzi added 3 commits January 27, 2017 07:31

Tweak Testing Guide

bf7518a

Changes based on review

7d433c4

Fix JSHint warnings

ba49da8

Updates based on review

557d6ab

lilleyse merged commit e069f69 into master Jan 27, 2017

lilleyse deleted the webgl-mock-for-tests branch January 27, 2017 20:14

lilleyse mentioned this pull request Jan 31, 2017

3D Tiles - WebGL stubs #4938

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WebGL stub for unit tests #4827

WebGL stub for unit tests #4827

pjcozzi commented Jan 9, 2017 •

edited

markerikson commented Jan 21, 2017

pjcozzi commented Jan 21, 2017

lilleyse left a comment

lilleyse Jan 23, 2017

pjcozzi Jan 27, 2017

lilleyse Jan 23, 2017

pjcozzi Jan 27, 2017

lilleyse Jan 23, 2017

lilleyse Jan 23, 2017

lilleyse Jan 23, 2017

lilleyse Jan 23, 2017

pjcozzi Jan 27, 2017

lilleyse Jan 23, 2017

pjcozzi Jan 27, 2017

lilleyse Jan 23, 2017

lilleyse Jan 23, 2017

pjcozzi Jan 27, 2017

pjcozzi Jan 27, 2017

lilleyse Jan 23, 2017

lilleyse commented Jan 23, 2017

lilleyse commented Jan 23, 2017

pjcozzi commented Jan 27, 2017

pjcozzi commented Jan 27, 2017

pjcozzi commented Jan 27, 2017

lilleyse commented Jan 27, 2017 •

edited

lilleyse commented Jan 27, 2017

lilleyse commented Jan 27, 2017

pjcozzi commented Jan 27, 2017

lilleyse commented Jan 27, 2017

pjcozzi commented Jan 27, 2017

lilleyse commented Jan 27, 2017

WebGL stub for unit tests #4827

WebGL stub for unit tests #4827

Conversation

pjcozzi commented Jan 9, 2017 • edited

markerikson commented Jan 21, 2017

pjcozzi commented Jan 21, 2017

lilleyse left a 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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lilleyse commented Jan 23, 2017

lilleyse commented Jan 23, 2017

pjcozzi commented Jan 27, 2017

pjcozzi commented Jan 27, 2017

pjcozzi commented Jan 27, 2017

lilleyse commented Jan 27, 2017 • edited

lilleyse commented Jan 27, 2017

lilleyse commented Jan 27, 2017

pjcozzi commented Jan 27, 2017

lilleyse commented Jan 27, 2017

pjcozzi commented Jan 27, 2017

lilleyse commented Jan 27, 2017

pjcozzi commented Jan 9, 2017 •

edited

lilleyse commented Jan 27, 2017 •

edited