npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

wdio-meta-tags

v1.0.4

Published

a node/typescript package that allows Testcafe like meta tagging for WDIO and Allure via Mocha

Downloads

762

Readme

Table of Contents

📓 Purpose 📓

Have you ever thought to yourself "Damn I wish that WDIO+Mocha supported using a simple .meta() the way that Testcafe does out of the box. So that way I could use to easily append stuff to an Allure report". Wish granted. This package is basically a wrapper for Mocha that modifies the .it(), .skip(), and .only() methods to support adding "meta"-like tags to tests for more accurate Allure Reports.

ko-fi

📢 Prerequisites 📢

In order to use this package you'll need to install the following:

    A. Git 
    B. NodeJs (v20.11)
    C. Chrome, Firefox and IE browsers latest versions
    D. VS Code
    E. GitBash

It is assumed that you have the following dependencies installed in your project: @types/mocha @types/node @wdio/cli @wdio/local-runner @wdio/mocha-framework @wdio/spec-reporter allure-commandline mocha ts-node typescript @wdio/allure-reporter dotenv

🔌 Installation 🔌

Run the below command on terminal to install the library: npm i wdio-meta-tags or npm install wdio-meta-tags

🧰 Usage 🧰

Test file and usage example:

import { it } from '../../tagHelper';

describe('My Feature Tests', function() {
    it.meta({
        addTag: 'Regression',
        addEpic: 'User Authentication',
        addStory: 'Login Functionality',
        addDescription: { description: 'Testing the login feature', type: 'text' },
        jiraTicketId: 'DP-1234'
    })('should perform a specific task', async function() {
        //test logic
    });
});

This probably goes without saying but you'll also need to update your WDIO config file and add Allure as a reporter and set the framework to Mocha. Additionally, you'll need to create a .env file with the variable WDIO_META_TAGS_JIRA_BASE_URL and then set it to your preferred test management software/url (ex. WDIO_META_TAGS_JIRA_BASE_URL= potato.atlassian.com/browse/). Note that this will override the allure tmsLinkTemplate in your WDIO config file.

🧠 Supported Allure API Commands 🧠

@wdio/allure-reporter documentation can be found here.

  • addLabel(name, value) - assign a custom label to test

  • addFeature(featureName) – assign features to test

  • addStory(storyName) – assign user story to test

  • addSeverity(value) – assign severity to test, accepts one of these values: blocker, - critical, normal, minor, trivial

  • addTag(value) – assign a tag label to test

  • addEpic(value) – assign an epic label to test

  • addOwner(value) – assign an owner label to test

  • addSuite(value) – assign a suite label to test

  • addSubSuite(value) – assign a sub suite label to test

  • addParentSuite(value) – assign a parent suite label to test

  • addIssue(value) – assign issue id to test

  • addAllureId(value) – assign allure test ops id label to test

  • addTestId(value) – assign TMS test id to test

  • addArgument(name, value) - add an additional argument to test

  • addDescription(description, [type]) – add description to test

    • description (String) - description of the test

    • type (String, optional) – description type, text by default. Values ['text', 'html','markdown']

🎸 Report Example 🎸

Report

🗯️ Troubleshooting 🗯️

You may need to download the latest Java SDK if you have problems launching allure.

💫 License 💫

This project is licensed under the MIT License - see the LICENSE file for details.