1 files changed, 36 insertions, 0 deletions
diff --git a/spec/frontend/__helpers__/matchers/to_have_sprite_icon.js b/spec/frontend/__helpers__/matchers/to_have_sprite_icon.js
new file mode 100644
index 00000000000..bce9d93bea8
--- /dev/null
+++ b/spec/frontend/__helpers__/matchers/to_have_sprite_icon.js
@@ -0,0 +1,36 @@
+export const toHaveSpriteIcon = (element, iconName) => {
+  if (!iconName) {
+    throw new Error('toHaveSpriteIcon is missing iconName argument!');
+  }
+
+  if (!(element instanceof HTMLElement)) {
+    throw new Error(`${element} is not a DOM element!`);
+  }
+
+  const iconReferences = [].slice.apply(element.querySelectorAll('svg use'));
+  const matchingIcon = iconReferences.find(
+    (reference) => reference.parentNode.getAttribute('data-testid') === `${iconName}-icon`,
+  );
+
+  const pass = Boolean(matchingIcon);
+
+  let message;
+  if (pass) {
+    message = `${element.outerHTML} contains the sprite icon "${iconName}"!`;
+  } else {
+    message = `${element.outerHTML} does not contain the sprite icon "${iconName}"!`;
+
+    const existingIcons = iconReferences.map((reference) => {
+      const iconUrl = reference.getAttribute('href');
+      return `"${iconUrl.replace(/^.+#/, '')}"`;
+    });
+    if (existingIcons.length > 0) {
+      message += ` (only found ${existingIcons.join(',')})`;
+    }
+  }
+
+  return {
+    pass,
+    message: () => message,
+  };
+};