NAME

JSTAPd::Manual::API - JSTAPd JavaScript API Reference

BASIC API

The Basic API gives you the tools to run the JavaScript tests. These functions are implemented on the window object. Unless otherwise stated, the functions should be compatible with that of Test::More

tests($testnum);

Declares the number of tests to be run. There is NO done_testing(), as it is very hard to detect how other (possibly asynchronous) code interact and affect the ending of a test.

ok($boolean, $test_name);

is( $got, $expected, $test_name );

isnt( $got, $expected, $test_name );

like( $got, new RegExp('...'), $test_name );

unlike( $got, new RegExp('...'), $test_name );

These are all equivalent of the Test::More counterparts

tap_dump();

Dumps the results up to this point to the console

pop_tap_request(function(request_list){});

The JSTAPd server keeps track of the Ajax requests (other than those that has to do with TAP results), and you can access them via this function. Once you called it, the server will empty the current list, so you won't be able to get the same request information again.

tap_xhr();

Returns a XmlHttpRequest object -- Useful if you are not using any sort of JavaScript frameworks to do the equivalent

tap$( $domid );

Short-hand notation that does the equivalent of

  return document.getElementById($domid);

tap$tag( $tagname );

Short-hand notation that does the equivalent of

  return document.getElementsByTagName($tagname)[0];

jstapDeferred

JSTAPd は結構非同期してますが、これを直列的にテストを実行してくれるしくみです。

cho45 作の jsDeferred を参考にして作ってあります。

JSTAPd の client_script で指定されたスクリプトの、この jstapDeferred の next の中で実行されています。

jstapDeferred.next

基本的な next の使い方で、どんどん次の next にチェインして実行します。

  jstapDeferred.next(function(){
      return 'value';
  }).
  next(function(val){
      is(val, 'value');
  });

next の戻り値に jstapDeferred のインスタンスを指定すると、次の next の直前に割り込む事ができます。

  jstapDeferred.next(function(){
      // 1
      return jstapDeferred.next(function(){
          // 2
      }).
      next(function(){
          // 3
      });
  }).
  next(function(val){
      // 4
  });

jstapDeferred.wait( $time );

指定した msec 待ってから次の next を呼び出します。

  jstapDeferred.wait(1000).
  next(function(val){
      // 1秒後に実行
  });

メッソッドチェーンの間でも使えます

  jstapDeferred.next(function(){}).
  wait(1000).
  next(function(val){
      // 1秒後に実行
  });

jstapDeferred.retry( $retrycount, function(val){}, $option );

callback が値を返すまで $retrycount の回数だけ callback を呼び続けます。 option.wait が指定されると指定された msec 待ってから retry します。

retry しても callback が値を返さなければ次以降のチェーンは実行されません。

  jstapDeferred.retry(10, function(){
      // なにか値を return するまで 10 回繰り返す
  }).
  next(function(val){
      // callback の retry した値が val に入ってる
  });

メッソッドチェーンの間でも使えます

  jstapDeferred.next(function(){
      return 'value';
  }).
  retry(10, function(count, val){
      is(val, 'value');
      // なにか値を return するまで 10 回繰り返す
  }).
  next(function(val){
      // callback の retry した値が val に入ってる
  });

jstapDeferred.xhr( $options );

$options の内容で XHR を実行して r.readyState == 4 になったら、 次のチェーンに進みます。

    jstapDeferred.xhr({
        method: 'GET',
        uri: '/foo/var',
        cache: false
    }).
    next(function(req){
        is(req.readyState, 4);
        like(req.responseText, new RegExp('.'));
    });

メッソッドチェーンの間でも使えます

jstapDeferred.pop_request( $options );

jstapDeferred 組み込みの pop_tap_request

    jstapDeferred.pop_request({
        retry: 100, // 100 回リトライ
        wait: 100  // リトライは 100 msec おき
    }).
    next(function(req_list){
        // pop_tap_request の callback に渡される引数が req_list に入る
    });

メッソッドチェーンの間でも使えます

jstapDeferred.wait_dequeue()

ok(), is(), like() などは非同期的に server に結果を送っているので、 server にこれらの結果を送り終わるまで wait してくれる為の物です。

  jstapDeferred.next(function(){
      ok(1);
  }).
  wait_dequeue().
  next(function(){
      // 上の ok(1) は、すでにサーバで処理された後
  });

jQuery PLUGIN

JSTAPd provides a set of tools that integrates with jQuery for easier testing. These are not enabled by default, so you must specify that you want it in your tests:

    use JSTAPd::Suite;

    sub include_ex {
        return (
             # whatever URL that holds your jquery file
            'http://blahblah/jquery.min.js',

            # "magic" that enables jQuery <-> JSTAPd integration
            \'jquery-jstapd.js',
        )
    }

    # XXX これってこんな感じにできないのかしら
    sub include_ex {
        return (
            with_jquery($path_to_jquery)
        )
    }

$(selector).is_visible(num)

The test passes if the number of visible elements that match selector matches num

If the selector returns multiple elements, then only the first one is used.

$(selector).isnt_visible()

The test passes if none of the elements that match selector is visible.

If the selector returns multiple elements, then only the first one is used.

$(selector).is_text(val)

The test passes if the text() value of the element specified by selector matches val.

If the selector returns multiple elements, then only the first one is used.

$(selector).isnt_text(val)

The test passes if the text() value of the element specified by selector does NOT match val.

If the selector returns multiple elements, then only the first one is used.

$(selector).like_text(regexp)

The test passes if the text() value of the element specified by selector matches regexp. regexp must be a RegExp object.

If the selector returns multiple elements, then only the first one is used.

$(selector).unlike_text(regexp)

The test passes if the text() value of the element specified by selector does NOT match regexp. regexp must be a RegExp object.

If the selector returns multiple elements, then only the first one is used.

$(selector).is_formval(val)

The test passes if the form component's value of the element specified by selector matches val.

If the selector returns multiple elements, then only the first one is used.

$(selector).isnt_formval(val)

The test passes if the form component's value of the element specified by selector does NOT match val.

If the selector returns multiple elements, then only the first one is used.

$(selector).like_formval(regexp)

The test passes if the form component's value of the element specified by selector matches regex. regexp must be a RegExp object

If the selector returns multiple elements, then only the first one is used.

$(selector).unlike_formval(regexp))

The test passes if the form component's value of the element specified by selector does NOT match regex. regexp must be a RegExp object

If the selector returns multiple elements, then only the first one is used.