427286 - add xpcshell-based unit test framework for js-ctypes

Status: RESOLVED FIXED

(Core :: js-ctypes, defect)

Description

[Fredrik Larsson (:nossralf)]

We need a unit test framework for js-ctypes since it's something that is supposed to "just work". It's still early in the development cycle, so adding it now will make future development easier since it can be test-driven.

Comment 1

[Fredrik Larsson (:nossralf)]

Attachment: unit test framework WIP

This is a start. It adds a tests/ directory in the root of the js-ctypes directory structure which there are a couple of things:

* unit/ 
A directory for unit tests, the same old story.

* libtest/
A directory in which there is an implementation of a shared library (js-ctypes-test) that's used by the unit tests. It's very bare at the moment, but the mechanics work; when it's built it's copied to dist/lib and dist/bin where it's (supposedly) always visible in the system's library path. (Relies on stuff defined in nscore.h, so xpcom is a dependency. Exported functions have to be visible, unless they're NS_EXPORT'ed they're hidden in the DLL.)

Note: DLL naming is different on Win and Linux at least (the OS X name is either the same as on Linux or a separate case). The unit test must open the library with a platform-specific name. In this WIP it only opens libjs-ctypes-test.so.

Comment 2

[Fredrik Larsson (:nossralf)]

OK, that's testlib/ not libtest/. Meh.

Comment 3

[Fredrik Larsson (:nossralf)]

Attachment: same WIP with a couple of renames

This is functionally the same, but I renamed everything called testlib to js-ctypes-test since that makes more sense.

Comment 4

[Mark Finkle (:mfinkle) (use needinfo?)]

Comment on attachment 313841 [details] [diff] [review]
same WIP with a couple of renames

I had to tweak the makefile a bit and correct the the calls in the JS test file (call type is before return type). I also added a bit of code to the test JS file to handle library naming conventions of different platforms.

Works great - thanks

Comment 5

[Fredrik Larsson (:nossralf)]

Cool, yeah, I forgot to update the patch with the proper declare() order.

Also, I have it in extensions/js-ctypes which probably isn't the intended location. (Should it be under modules/ or where do you keep it in your tree? I never did quite get that bit.)

Comment 6

[Mark Finkle (:mfinkle) (use needinfo?)]

(In reply to comment #5)

> Also, I have it in extensions/js-ctypes which probably isn't the intended
> location. (Should it be under modules/ or where do you keep it in your tree? I
> never did quite get that bit.)
> 

I just changed the makefiles to work from the toolkit/components/js-ctypes location. Since I hope to get js-ctypes in the tree, that seemed like a good location.

Comment 7

[Fredrik Larsson (:nossralf)]

(In reply to comment #6)
> I just changed the makefiles to work from the toolkit/components/js-ctypes
> location. Since I hope to get js-ctypes in the tree, that seemed like a good
> location.

Makes sense.