Show CI status as Favicon on Pipelines, Job and MR pages

3 files changed, 60 insertions, 0 deletions

diff --git a/spec/javascripts/build_spec.js b/spec/javascripts/build_spec.js
index 549c7af8ea8..beee6cb2969 100644
--- a/spec/javascripts/build_spec.js
+++ b/spec/javascripts/build_spec.js
@@ -75,6 +75,7 @@ describe('Build', () => {
         expect(url).toBe(`${BUILD_URL}.json`);
         expect(dataType).toBe('json');
         expect(success).toEqual(jasmine.any(Function));
+        spyOn(gl.utils, 'setCiStatusFavicon').and.callFake(() => {});
 
         success.call(context, { trace_html: '<span>Example</span>', status: 'running' });
 
@@ -83,6 +84,7 @@ describe('Build', () => {
 
       it('removes the spinner', () => {
         const [{ success, context }] = $.ajax.calls.argsFor(0);
+        spyOn(gl.utils, 'setCiStatusFavicon').and.callFake(() => {});
         success.call(context, { trace_html: '<span>Example</span>', status: 'success' });
 
         expect($('.js-build-refresh').length).toBe(0);
diff --git a/spec/javascripts/lib/utils/common_utils_spec.js b/spec/javascripts/lib/utils/common_utils_spec.js
index 5a93d479c1f..03f3c206f44 100644
--- a/spec/javascripts/lib/utils/common_utils_spec.js
+++ b/spec/javascripts/lib/utils/common_utils_spec.js
@@ -310,5 +310,56 @@ require('~/lib/utils/common_utils');
         });
       }, 10000);
     });
+
+    describe('gl.utils.setFavicon', () => {
+      it('should set page favicon to provided favicon', () => {
+        const faviconName = 'custom_favicon';
+        const fakeLink = {
+          setAttribute() {},
+        };
+
+        spyOn(window.document, 'getElementById').and.callFake(() => fakeLink);
+        spyOn(fakeLink, 'setAttribute').and.callFake((attr, val) => {
+          expect(attr).toEqual('href');
+          expect(val.indexOf('/assets/custom_favicon.ico') > -1).toBe(true);
+        });
+        gl.utils.setFavicon(faviconName);
+      });
+    });
+
+    describe('gl.utils.resetFavicon', () => {
+      it('should reset page favicon to tanuki', () => {
+        const fakeLink = {
+          setAttribute() {},
+        };
+
+        spyOn(window.document, 'getElementById').and.callFake(() => fakeLink);
+        spyOn(fakeLink, 'setAttribute').and.callFake((attr, val) => {
+          expect(attr).toEqual('href');
+          expect(val).toMatch(/favicon/);
+        });
+        gl.utils.resetFavicon();
+      });
+    });
+
+    describe('gl.utils.setCiStatusFavicon', () => {
+      it('should set page favicon to CI status favicon based on provided status', () => {
+        const BUILD_URL = `${gl.TEST_HOST}/frontend-fixtures/builds-project/builds/1/status.json`;
+        const FAVICON_PATH = 'ci_favicons/';
+        const FAVICON = 'icon_status_success';
+        const spySetFavicon = spyOn(gl.utils, 'setFavicon').and.stub();
+        const spyResetFavicon = spyOn(gl.utils, 'resetFavicon').and.stub();
+        spyOn($, 'ajax').and.callFake(function (options) {
+          options.success({ icon: FAVICON });
+          expect(spySetFavicon).toHaveBeenCalledWith(FAVICON_PATH + FAVICON);
+          options.success();
+          expect(spyResetFavicon).toHaveBeenCalled();
+          options.error();
+          expect(spyResetFavicon).toHaveBeenCalled();
+        });
+
+        gl.utils.setCiStatusFavicon(BUILD_URL);
+      });
+    });
   });
 })();
diff --git a/spec/javascripts/merge_request_widget_spec.js b/spec/javascripts/merge_request_widget_spec.js
index d5193b41c33..88dae8c3e06 100644
--- a/spec/javascripts/merge_request_widget_spec.js
+++ b/spec/javascripts/merge_request_widget_spec.js
@@ -142,18 +142,21 @@ require('~/lib/utils/datetime_utility');
       it('should call showCIStatus even if a notification should not be displayed', function() {
         var spy;
         spy = spyOn(this["class"], 'showCIStatus').and.stub();
+        spyOn(gl.utils, 'setCiStatusFavicon').and.callFake(() => {});
         this["class"].getCIStatus(false);
         return expect(spy).toHaveBeenCalledWith(this.ciStatusData.status);
       });
       it('should call showCIStatus when a notification should be displayed', function() {
         var spy;
         spy = spyOn(this["class"], 'showCIStatus').and.stub();
+        spyOn(gl.utils, 'setCiStatusFavicon').and.callFake(() => {});
         this["class"].getCIStatus(true);
         return expect(spy).toHaveBeenCalledWith(this.ciStatusData.status);
       });
       it('should call showCICoverage when the coverage rate is set', function() {
         var spy;
         spy = spyOn(this["class"], 'showCICoverage').and.stub();
+        spyOn(gl.utils, 'setCiStatusFavicon').and.callFake(() => {});
         this["class"].getCIStatus(false);
         return expect(spy).toHaveBeenCalledWith(this.ciStatusData.coverage);
       });
@@ -161,12 +164,14 @@ require('~/lib/utils/datetime_utility');
         var spy;
         this.ciStatusData.coverage = null;
         spy = spyOn(this["class"], 'showCICoverage').and.stub();
+        spyOn(gl.utils, 'setCiStatusFavicon').and.callFake(() => {});
         this["class"].getCIStatus(false);
         return expect(spy).not.toHaveBeenCalled();
       });
       it('should not display a notification on the first check after the widget has been created', function() {
         var spy;
         spy = spyOn(window, 'notify');
+        spyOn(gl.utils, 'setCiStatusFavicon').and.callFake(() => {});
         this["class"] = new window.gl.MergeRequestWidget(this.opts);
         this["class"].getCIStatus(true);
         return expect(spy).not.toHaveBeenCalled();
@@ -174,6 +179,7 @@ require('~/lib/utils/datetime_utility');
       it('should update the pipeline URL when the pipeline changes', function() {
         var spy;
         spy = spyOn(this["class"], 'updatePipelineUrls').and.stub();
+        spyOn(gl.utils, 'setCiStatusFavicon').and.callFake(() => {});
         this["class"].getCIStatus(false);
         this.ciStatusData.pipeline += 1;
         this["class"].getCIStatus(false);
@@ -182,6 +188,7 @@ require('~/lib/utils/datetime_utility');
       it('should update the commit URL when the sha changes', function() {
         var spy;
         spy = spyOn(this["class"], 'updateCommitUrls').and.stub();
+        spyOn(gl.utils, 'setCiStatusFavicon').and.callFake(() => {});
         this["class"].getCIStatus(false);
         this.ciStatusData.sha = "9b50b99a";
         this["class"].getCIStatus(false);