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

mgwdev-spfx-utfx

v0.0.5

Published

Library to help You out with unit testing

Downloads

19

Readme

mgwdev-spfx-utfx

Link to the repo

This library will help You with writing unit tests for SPFx solutions. There are three supported configuration You can use

  1. integration - which uses credentials provided in config to connect with SharePoint and uses the connection to communicate with SharePoint whenever context.spHttpClient is used.
  2. integrationWithFileGeneration - same as 1) but also generated file with responses in provided path (second argument of MockHttpClientFactory.setupContextFromConfig).
  3. isolated - tests will not communicate with Your tenant. Only data provided in file will be used.

How to use it

The scenario I had in mind is following. You write Your test in integraation mode Write the logic Test passess Switch to isolated mode You have Your unit test!

Installation

npm install mgwdev-spfx-utfx --save-dev

Simpliest setup

Here is the simpliest possible test You can write. Of course You can inject context anywhere You will need web part or extension context.

/// <reference types="jest" />

import { assert } from "chai";
import { MockHttpClientFactory, TestConfiguration, IMockSPHttpClient } from "mgwdev-spfx-utfx";

jest.mock("@microsoft/sp-http", () => {
    return {
        SPHttpClient: {
            configurations: {
                v1: 1
            }
        }
    }
});
let context;
describe("Test UTFX", () => {
    beforeAll(() => {
        let mockHttpClientFactory = new MockHttpClientFactory();
        context = mockHttpClientFactory.setupContextFromConfig({
            authenticationConfiguration: {
              username: "admin@<tenant_name>.onmicrosoft.com",
              password: "<password>", 
              online: true
            },
            siteUrl : "https://<tenant_name>.sharepoint.com",
            runConfiguration: TestConfiguration.integrationWithFileGeneration
        }, "./tests/responses/Web.json");
        return context.spHttpClient.init();
    });
    test("getWebInfo (absolute)", async () => {
        let response = await context.spHttpClient.get("https://<tenant_name>.sharepoint.com/sites/tea-point/_api/web?$select=Title");
        let result = await response.json();
        assert.equal(result.Title, "Tea Point - English");
    });
    test("getWebInfo (relative)", async () => {
        let response = await context.spHttpClient.get("/sites/tea-point/_api/web?$select=Title");
        let result = await response.json();
        assert.equal(result.Title, "Tea Point - English");
    });
    afterAll(async() => {
        await context.spHttpClient.dispose();
    });
});