Test framework, testcases, and update README on testing

timdream · Oct 18, 2012 · b7bdf43 · b7bdf43
1 parent a29bfab
commit b7bdf43
Show file tree

Hide file tree

Showing 10 changed files with 614 additions and 0 deletions.
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,6 @@
+[submodule "test/qunit"]
+	path = test/qunit
+	url = git://github.com/jquery/qunit.git
+[submodule "test/sinon"]
+	path = test/sinon
+	url = git://github.com/cjohansen/Sinon.JS.git
diff --git a/README.md b/README.md
@@ -32,3 +32,18 @@ You can
 
 - Use the token to request data from Google's server directly from the client-side web app in the browser (with JSON-P or CORS), for example, [this is how HTML Word Cloud does it](https://github.com/timdream/wordcloud/blob/master/jquery.getcontent.js#L124).
 - Send the token to your own server, verify it with Google to associate a Google account with a user session on your site. [Documentation here](https://developers.google.com/accounts/docs/OAuth2Login#validatingtoken).
+
+## Testing
+
+To run tests, first you would need to pull the required QUnit and Sinon.JS library by running
+
+    git submodule init
+    git submodule update
+
+Then, start a localhost HTTP server, for example,
+
+    python -m SimpleHTTPServer
+
+Point your browser to [http://127-0-0-1.org.uk:8009/test/](http://127-0-0-1.org.uk:8009/test/) to start testing. You will need to disable popup blocker to properly run the interactive testcases.
+
+You will find all the information you need to write testcases on the [QUnit](http://qunitjs.com) and [Sinon.JS](http://sinonjs.org) website. All code submission are expected to accompany with testcases.
diff --git a/test/index.html b/test/index.html
@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <title>google-oauth2-web-client tests</title>
+  <link rel="stylesheet" href="qunit/qunit/qunit.css">
+</head>
+<body>
+  <div id="qunit"></div>
+  <script src="qunit/qunit/qunit.js"></script>
+
+  <!-- sinon -->
+  <script src="sinon/lib/sinon.js"></script>
+  <script src="sinon/lib/sinon/spy.js"></script>
+
+  <!-- script to test -->
+  <script src="../src/google-oauth2.js"></script>
+
+  <!-- testinit -->
+  <script src="testinit.js"></script>
+
+  <!-- test scripts -->
+  <script src="unit/basics.js"></script>
+  <script src="unit/initiation.js"></script>
+  <script src="integration/interactive.js"></script>
+  <script src="integration/immediate.js"></script>
+</body>
+</html>
diff --git a/test/integration/immediate.js b/test/integration/immediate.js
@@ -0,0 +1,47 @@
+'use strict';
+
+module('Immediate login integration');
+
+test('successful login should trigger onlogin callback', function () {
+  var client_id = localhost_client_id;
+
+  var returnValue = window.GO2.init({
+      client_id: client_id,
+      scope: localhost_scope,
+      redirect_uri: localhost_redirect_uri
+    });
+  equal(returnValue, true, 'init() returns true.');
+
+  window.GO2.login(false, true);
+
+  stop();
+
+  window.GO2.onlogin = function (token) {
+    window.GO2.onlogin = null;
+    ok(!!token, 'Got token from onlogin: ' + token);
+
+    start();
+  };
+});
+
+test('when logged in, GO2.getAccessToken() should return the token', function () {
+  var token = window.GO2.getAccessToken();
+  ok(!!token, 'Pass with token:' + token);
+});
+
+test('GO2.logout() should trigger onlogout callback', function () {
+  stop();
+
+  window.GO2.onlogout = function () {
+    window.GO2.onlogout = null;
+    ok(true, 'Passed!');
+
+    start();
+  };
+  window.GO2.logout();
+});
+
+test('when logged out, GO2.getAccessToken() should not return the token', function () {
+  var token = window.GO2.getAccessToken();
+  ok(!token, 'Not getting token.');
+});
diff --git a/test/integration/interactive.js b/test/integration/interactive.js
@@ -0,0 +1,46 @@
+'use strict';
+
+module('Interactive login integration');
+
+test('successful login should trigger onlogin callback', function () {
+  var client_id = localhost_client_id;
+
+  var returnValue = window.GO2.init({
+      client_id: client_id,
+      scope: localhost_scope,
+      redirect_uri: localhost_redirect_uri
+    });
+  equal(returnValue, true, 'init() returns true.');
+
+  window.GO2.login();
+
+  stop();
+  window.GO2.onlogin = function (token) {
+    window.GO2.onlogin = null;
+    ok(!!token, 'Got token from onlogin: ' + token);
+
+    start();
+  };
+});
+
+test('when logged in, GO2.getAccessToken() should return the token', function () {
+  var token = window.GO2.getAccessToken();
+  ok(!!token, 'Pass with token:' + token);
+});
+
+test('GO2.logout() should trigger onlogout callback', function () {
+  stop();
+
+  window.GO2.onlogout = function () {
+    window.GO2.onlogout = null;
+    ok(true, 'Passed!');
+
+    start();
+  };
+  window.GO2.logout();
+});
+
+test('when logged out, GO2.getAccessToken() should not return the token', function () {
+  var token = window.GO2.getAccessToken();
+  ok(!token, 'Not getting token.');
+});
diff --git a/test/qunit b/test/qunit
diff --git a/test/sinon b/test/sinon
diff --git a/test/testinit.js b/test/testinit.js
@@ -0,0 +1,38 @@
+'use strict';
+
+var localhost_client_id = '519733320959.apps.googleusercontent.com';
+var localhost_scope = ['https://www.googleapis.com/auth/userinfo.profile',
+  'https://www.googleapis.com/auth/userinfo.email'];
+var localhost_redirect_uri = 'http://127-0-0-1.org.uk:8009/test/';
+
+// The fake one allows Google to show an error page without log us in automatically
+var fake_client_id = 'not-valid.apps.googleusercontent.com';
+
+var apiUrl = 'https://accounts.google.com/o/oauth2/auth';
+var defaultScope = 'https://www.googleapis.com/auth/plus.me';
+
+function splitUrlArgs(urlArgs) {
+  var urlArgKeys = [];
+  var urlArgValues = [];
+
+  urlArgs.split('&').forEach(function (keyValue) {
+    var kv = keyValue.split('=');
+    urlArgKeys.push(kv.shift());
+    urlArgValues.push(decodeURIComponent(kv.join('')));
+  });
+
+  return {
+    keys: urlArgKeys,
+    values: urlArgValues
+  };
+}
+
+test('Testing environment test', function () {
+  var win = window.open('');
+  equal(typeof win, 'object', 'Popup blocker is not in-effect');
+  if (win && win.close)
+    win.close();
+
+  equal(window.location.href.substr(0, localhost_redirect_uri.length), localhost_redirect_uri,
+        'Integration will work; test is running on presumed URL.');
+});
diff --git a/test/unit/basics.js b/test/unit/basics.js
@@ -0,0 +1,23 @@
+'use strict';
+
+module('Basics');
+
+test('GO2 object exists', function () {
+  equal(typeof window.GO2, 'object', 'Passed!');
+});
+
+test('GO2.init function exists', function () {
+  equal(typeof window.GO2.init, 'function', 'Passed!');
+});
+
+test('GO2.login function exists', function () {
+  equal(typeof window.GO2.login, 'function', 'Passed!');
+});
+
+test('GO2.logout function exists', function () {
+  equal(typeof window.GO2.logout, 'function', 'Passed!');
+});
+
+test('GO2.getAccessToken function exists', function () {
+  equal(typeof window.GO2.getAccessToken, 'function', 'Passed!');
+});