/* globals sinon */ "use strict"; /* import-globals-from utils.js */ load("utils.js"); NormandyTestUtils.init({ add_task }); const { decorate_task } = NormandyTestUtils; decorate_task(withMockApiServer(), async function test_get({ serverUrl }) { // Test that NormandyApi can fetch from the test server. const response = await NormandyApi.get(`${serverUrl}/api/v1/`); const data = await response.json(); equal( data["recipe-signed"], "/api/v1/recipe/signed/", "Expected data in response" ); }); decorate_task( withMockApiServer(), async function test_getApiUrl({ serverUrl }) { const apiBase = `${serverUrl}/api/v1`; // Test that NormandyApi can use the self-describing API's index const recipeListUrl = await NormandyApi.getApiUrl("extension-list"); equal( recipeListUrl, `${apiBase}/extension/`, "Can retrieve extension-list URL from API" ); } ); decorate_task( withMockApiServer(), async function test_getApiUrlSlashes({ serverUrl, mockPreferences }) { const fakeResponse = new MockResponse( JSON.stringify({ "test-endpoint": `${serverUrl}/test/` }) ); const mockGet = sinon .stub(NormandyApi, "get") .callsFake(async () => fakeResponse); // without slash { NormandyApi.clearIndexCache(); mockPreferences.set("app.normandy.api_url", `${serverUrl}/api/v1`); const endpoint = await NormandyApi.getApiUrl("test-endpoint"); equal(endpoint, `${serverUrl}/test/`); ok( mockGet.calledWithExactly(`${serverUrl}/api/v1/`), "trailing slash was added" ); mockGet.resetHistory(); } // with slash { NormandyApi.clearIndexCache(); mockPreferences.set("app.normandy.api_url", `${serverUrl}/api/v1/`); const endpoint = await NormandyApi.getApiUrl("test-endpoint"); equal(endpoint, `${serverUrl}/test/`); ok( mockGet.calledWithExactly(`${serverUrl}/api/v1/`), "existing trailing slash was preserved" ); mockGet.resetHistory(); } NormandyApi.clearIndexCache(); mockGet.restore(); } ); // Test validation errors due to validation throwing an exception (e.g. when // parameters passed to validation are malformed). decorate_task( withMockApiServer(), async function test_validateSignedObject_validation_error() { // Mock the x5u URL const getStub = sinon.stub(NormandyApi, "get").callsFake(async url => { ok(url.endsWith("x5u/"), "the only request should be to fetch the x5u"); return new MockResponse("certchain"); }); const signedObject = { a: 1, b: 2 }; const signature = { signature: "invalidsignature", x5u: "http://localhost/x5u/", }; // Validation should fail due to a malformed x5u and signature. try { await NormandyApi.verifyObjectSignature( signedObject, signature, "object" ); ok(false, "validateSignedObject did not throw for a validation error"); } catch (err) { ok( err instanceof NormandyApi.InvalidSignatureError, "Error is an InvalidSignatureError" ); ok(/signature/.test(err), "Error is due to a validation error"); } getStub.restore(); } ); // Test validation errors due to validation returning false (e.g. when parameters // passed to validation are correctly formed, but not valid for the data). decorate_task( withMockApiServer("invalid_recipe_signature_api"), async function test_verifySignedObject_invalid_signature() { // Get the test recipe and signature from the mock server. const recipesUrl = await NormandyApi.getApiUrl("recipe-signed"); const recipeResponse = await NormandyApi.get(recipesUrl); const recipes = await recipeResponse.json(); equal(recipes.length, 1, "Test data has one recipe"); const [{ recipe, signature }] = recipes; try { await NormandyApi.verifyObjectSignature(recipe, signature, "recipe"); ok(false, "verifyObjectSignature did not throw for an invalid signature"); } catch (err) { ok( err instanceof NormandyApi.InvalidSignatureError, "Error is an InvalidSignatureError" ); ok(/signature/.test(err), "Error is due to an invalid signature"); } } ); decorate_task(withMockApiServer(), async function test_classifyClient() { const classification = await NormandyApi.classifyClient(); Assert.deepEqual(classification, { country: "US", request_time: new Date("2017-02-22T17:43:24.657841Z"), }); }); decorate_task(withMockApiServer(), async function test_fetchExtensionDetails() { const extensionDetails = await NormandyApi.fetchExtensionDetails(1); deepEqual(extensionDetails, { id: 1, name: "Normandy Fixture", xpi: "http://example.com/browser/toolkit/components/normandy/test/browser/fixtures/normandy.xpi", extension_id: "normandydriver@example.com", version: "1.0", hash: "ade1c14196ec4fe0aa0a6ba40ac433d7c8d1ec985581a8a94d43dc58991b5171", hash_algorithm: "sha256", }); }); decorate_task( withScriptServer("query_server.sjs"), async function test_getTestServer({ serverUrl }) { // Test that NormandyApi can fetch from the test server. const response = await NormandyApi.get(serverUrl); const data = await response.json(); Assert.deepEqual( data, { queryString: {}, body: {} }, "NormandyApi returned incorrect server data." ); } ); decorate_task( withScriptServer("query_server.sjs"), async function test_getQueryString({ serverUrl }) { // Test that NormandyApi can send query string parameters to the test server. const response = await NormandyApi.get(serverUrl, { foo: "bar", baz: "biff", }); const data = await response.json(); Assert.deepEqual( data, { queryString: { foo: "bar", baz: "biff" }, body: {} }, "NormandyApi sent an incorrect query string." ); } ); // Test that no credentials are sent, even if the cookie store contains them. decorate_task( withScriptServer("cookie_server.sjs"), async function test_sendsNoCredentials({ serverUrl }) { // This test uses cookie_server.sjs, which responds to all requests with a // response that sets a cookie. // send a request, to store a cookie in the cookie store await fetch(serverUrl); // A normal request should send that cookie const cookieExpectedDeferred = Promise.withResolvers(); function cookieExpectedObserver(aSubject, aTopic, aData) { equal( aTopic, "http-on-modify-request", "Only the expected topic should be observed" ); let httpChannel = aSubject.QueryInterface(Ci.nsIHttpChannel); equal( httpChannel.getRequestHeader("Cookie"), "type=chocolate-chip", "The header should be sent" ); Services.obs.removeObserver( cookieExpectedObserver, "http-on-modify-request" ); cookieExpectedDeferred.resolve(); } Services.obs.addObserver(cookieExpectedObserver, "http-on-modify-request"); await fetch(serverUrl); await cookieExpectedDeferred.promise; // A request through the NormandyApi method should not send that cookie const cookieNotExpectedDeferred = Promise.withResolvers(); function cookieNotExpectedObserver(aSubject, aTopic, aData) { equal( aTopic, "http-on-modify-request", "Only the expected topic should be observed" ); let httpChannel = aSubject.QueryInterface(Ci.nsIHttpChannel); Assert.throws( () => httpChannel.getRequestHeader("Cookie"), /NS_ERROR_NOT_AVAILABLE/, "The cookie header should not be sent" ); Services.obs.removeObserver( cookieNotExpectedObserver, "http-on-modify-request" ); cookieNotExpectedDeferred.resolve(); } Services.obs.addObserver( cookieNotExpectedObserver, "http-on-modify-request" ); await NormandyApi.get(serverUrl); await cookieNotExpectedDeferred.promise; } );