Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wultra/powerauth-js-test-client

Client library for PowerAuth Server RESTful API to support JavaScript integration tests with PowerAuth Server
https://github.com/wultra/powerauth-js-test-client

integration-testing javascript mobile powerauth react-native typescript

Last synced: 20 days ago
JSON representation

Client library for PowerAuth Server RESTful API to support JavaScript integration tests with PowerAuth Server

Awesome Lists containing this project

README 

        
# PowerAuth Test Client for JavaScript



[![npm](https://img.shields.io/npm/v/powerauth-js-test-client)](https://www.npmjs.com/package/powerauth-js-test-client) ![license](https://img.shields.io/github/license/wultra/powerauth-js-test-client) ![released](https://img.shields.io/github/release-date/wultra/powerauth-js-test-client)



This library provides client written in TypeScript that allows you to conenct directly to the [PowerAuth Server's RESTful API](https://github.com/wultra/powerauth-server/blob/develop/docs/WebServices-Methods.md). This is useful for various integration testing purposes for projects that needs to test the functionality against real [PowerAuth Server](https://github.com/wultra/powerauth-server).



This library shold not be used in production application. You usually don't have direct access to PowerAuth Server in production.



## Installation



Install the package via `npm` as a development dependency:



```

npm i powerauth-js-test-client -D

``` 



## Configuration



The basic configuration is easy:



```typescript

import { Config, PowerAuthTestServer } from 'powerauth-js-test-client'



async function prepareTestServer(): Promise {

    const server = new PowerAuthTestServer({ connection: { baseUrl: "http://localhost:8080/powerauth-java-server"}})

    await server.connect()

    return server

}

```



For more details, check documentation for `Config` interface. You can also check `tests/config/config.ts` file to see how this library is preparing configuration for its own tests.



## Usage



### `ActivationHelper` class



The `ActivationHelper` class simplifies regular tasks with activation creation. To create a propper instance of this object you need to have implementation that provides PowerAuth mobile SDK functionality. In this example, we'll use our [react-native wrapper](https://github.com/wultra/react-native-powerauth-mobile-sdk) as such provider:



```typescript

import { ActivationHelper, PowerAuthTestServer } from 'powerauth-js-test-client'

import { PowerAuth, PowerAuthActivation, PowerAuthAuthentication, PowerAuthCreateActivationResult } from 'react-native-powerauth-mobile-sdk'



type RNActivationHelper = ActivationHelper



const PA_SERVER_URL = "http://localhost:8080/powerauth-java-server"

const PA_ENROLLMENT = "http://localhost:8080/enrollment-server"

const PA_INSTANCE = 'your-app-instance-id'



export interface CustomActivationHelperPrepareData extends ActivationHelperPrepareData {

    instanceId?: string

}



/**

 * Function create instnace of activation helper typed with RN wrapper objects.

 */

async function getActivationHelper(): Promise {

    const cfg = { connection: { baseUrl: PA_SERVER_URL}}

    const helper: RNActivationHelper = await ActivationHelper.createWithConfig(cfg)

    helper.createSdk = async (appSetup, prepareData) => {

        // Prepare instanceId. We're using custom data in prepare interface to keep instance id.

        const instanceId = (prepareData as CustomActivationHelperPrepareData).instanceId ?? PA_INSTANCE

        const sdk = new PowerAuth(instanceId)

        if (await sdk.isConfigured()) {

            await sdk.deconfigure() // depending on whether you expect config changes

        }

        const unsecure = PA_ENROLLMENT.startsWith('http://')

        await sdk.configure(appSetup.appKey, appSetup.appSecret, appSetup.masterServerPublicKey, PA_ENROLLMENT, unsecure)

        return sdk

    }

    helper.prepareStep = async (helper, activation, prepareData) => {

        if (!prepareData) throw new Error('Missing prepare data object')

        if (!prepareData.password) throw new Error('Missing password in prepare data object')

        const sdk = await helper.getPowerAuthSdk()

        const deviceName = 'Test device'

        const activationData = PowerAuthActivation.createWithActivationCode(activation.activationCode!, deviceName)

        // Create activation

        const result = await sdk.createActivation(activationData)

        // Commit activation locally

        const auth = new PowerAuthAuthentication()

        auth.usePossession = true

        auth.userPassword = prepareData.password

        auth.useBiometry = prepareData.useBiometry ?? false

        if (auth.useBiometry) {

            auth.biometryMessage = "Enable biometry"

        }

        await sdk.commitActivation(auth)

        return result

    }

    return helper

}



/**

 * Function prepare activation to active state.

 */

async function prepareActivationWithHelper(prepareData: CustomActivationHelperPrepareData): Promise {

    const config = { connection: { baseUrl: PA_SERVER_URL }}

    const helper = await createActivationHelper(config, prepareData)

    await helper.createActivation(helper.userId, prepareData)

    return helper

}

```



Once the activation helper is created, then you can use it in tests. For example:



```typescript

describe('Manage PowerAuth applications', () => {



    let activationHelper: RNActivationHelper



    beforeEach(async () => {

        activationHelper = await prepareActivationWithHelper({ password: "1234" })

    })



    afterEach(async () => {

        await activationHelper.cleanup()

    })



    test('Test activation block and unblock', async () => {

        await activationHelper.blockActivation('TEST-REASON')

        const status = await activationHelper.getActivationStatus()

        expect(status).toBe(ActivationStatus.BLOCKED)

    })

})

```



### `PowerAuthTestServer` class



The `PowerAuthTestServer` class provides subset of PowerAuth Server RESTful API that allows you to manupulate activations. You can construct this object on your own, or simply use `activationHelper.server` property to access helper's own instance. You can check documentation for this class for more details.



## License



All sources are licensed using Apache 2.0 license, you can use them with no restriction. If you are using PowerAuth 2.0, please let us know. We will be happy to share and promote your project.



## Contact



If you need any assistance, do not hesitate to drop us a line at [[email protected]](mailto:[email protected]).



### Security Disclosure



If you believe you have identified a security vulnerability with PowerAuth, you should report it as soon as possible via email to [[email protected]](mailto:[email protected]). Please do not post it to a public issue tracker.