Needs unit testing

[bvisness]

Just wanted to open up the discussion about how unit testing should be implemented for Handmade Math. We could use a full C++ unit testing framework like Google Test, or maybe just roll our own thing with asserts.

I personally would lean toward a full framework for ease of running multiple tests and nice test output. Plus, it would likely be easier to get up and running with Travis CI or some other automated tool, if we decide to go that route.

[StrangeZak]

I think for right now just having our own unit thing right now would be fine as i really dont have the money to setup a Travis of Jenkins server for automated build tests. Although i do think Travis or Jenkins would be the way to go for this.

[StrangeZak]

Wait is Travis CL free now ?

[bvisness]

Travis CI is free for open-source projects, and I'd be happy to set it up once we get tests running locally. I think later today I will take a stab at using Google Test and will let you know how it goes.

[kiljacken]

Travis is free for open source (maybe just github) projects afaik.

On Thu, 25 Aug 2016 at 18:57 Zak Strange notifications@github.com wrote:

Wait is Travis CL free now ?

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
#21 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAMxqYE_ZBznZukaNwOIr7gq32o9d5yEks5qjclhgaJpZM4JtJ6-
.

[StrangeZak]

Yeah, im not really the guy to ask to write a unit test. So if any of you guys are good at it i would love if you could try to do it first, once we have that id be more than happy to setup Travis CL, because we really need a unit test, so were sure we dont break peoples code when we upgrade, heh.

[bvisness]

Making some good headway on this! If you are interested you can check out the unit-tests branch of my fork.

[StrangeZak]

I do all my builds on Windows as a build.bat files so eventually ill just convert the make file to batch script but random question what are we gaining by using the google api thing

[bvisness]

We're gaining easy-to-create tests where individual asserts won't end the program, and very helpful formatting to help track down the source of errors. (Plus, it's a format that Travis should be happy with.)

Example output:

[==========] Running 1 test from 1 test case.
[----------] Global test environment set-up.
[----------] 1 test from Initialization
[ RUN      ] Initialization.Vectors
../test/hmm_test.cpp:34: Failure
      Expected: v3i.Elements[2]
      Which is: 3
To be equal to: 4.0f
      Which is: 4
[  FAILED  ] Initialization.Vectors (1 ms)
[----------] 1 test from Initialization (1 ms total)

[----------] Global test environment tear-down
[==========] 1 test from 1 test case ran. (1 ms total)
[  PASSED  ] 0 tests.
[  FAILED  ] 1 test, listed below:
[  FAILED  ] Initialization.Vectors

[StrangeZak]

Awesome just didn't wanna bloat the project with a library, we didn't need but this seems fine as it won't even be used in HandmadeMath

[bvisness]

Yeah for sure. Maybe someone can make a handmade test framework for us :)

[StrangeZak]

Or, that could be a awesome side-project for us to work on when HandmadeMath is stable and faster than GLM

[StrangeZak]

Whats the status on the unit test ?

[bvisness]

1300 lines later, almost done writing them. Found a couple confirmed bugs and a few other issues (which I will make Github issues for.) Just have to write tests for HMM_Orthographic, HMM_Projection, and HMM_LookAt and we'll be good to go.

[bvisness]

(The tests are a little verbose in spots, but I'm just cranking them out and I can look into removing redundant code once everything works.)

[StrangeZak]

Awesome were finding bugs this is great :D After some testing of the next major version i thing we can finally call this "stable"

[StrangeZak]

Cant wait to squash these bugs

[bvisness]

I'll try to finish up the tests tonight.

[StrangeZak]

Thanks for writing the unit test :)

[bvisness]

Tests are up! Sadly it looks like there are some merge conflicts that will need resolving, but they shouldn't be too bad since most of the changes are new code anyway.

I'm going to go through and make issues for the stuff I found along the way. Once those are resolved I can try configuring Travis.

[StrangeZak]

Awesome, with LOTS of bugs found now and a unit test i think we on to a proper version 1.0

[StrangeZak]

Ill squash out a few of these bugs this after noon after i get ready, a lot of these seem like easy fixes i can do in an hour or two. So you can focus on just getting the unit tests to merge in.

[bvisness]

I'll merge and re-push so that conflicts will be resolved.

[StrangeZak]

Im writing a quick opengl visual test bed right now we can run some tests against also