te-automation-test

Introduction

This repository contains a simplified version of one aspect of the TextExpander server. It runs as an Express Node application that exposes one endpoint for retrieving data. It is assumed that you have a UNIX-like environment capable of running Node.

Please read through the following instructions to understand what is expected and how to set up the system.

Assignment

1. Produce a set of acceptance tests that validate this endpoint. It is up to you how you choose to create these tests, but it is expected that you document how your tests can be executed. The environment is configured to use the Jest testing framework (and a sample test is provided).
2. If you encounter any bugs while writing your tests, please provide a writeup of the issues, including reproducible steps.
3. Provide a writeup of the thinking behind what you chose to test and what avenues you would test if you had more time or other test tools.
4. Return a zip file of this repo with your edits and the writeup. The zip file should contain everything needed to run the tests you've created (or instructions on what additional configuration is needed).

Notes

• Most of the code is written in TypeScript, but using JavaScript is fine if you are more comfortable with that.
• Do not worry about unit testing any of the code, the focus here is on acceptance tests that exercise the endpoint itself.
• Limit yourself to 2-4 hours on this project. Use the writeup to address areas you weren't able to cover.

The Endpoint

GET http://localhost:3000/snippetGroup/[SnippetGroupID]/snippets

In TextExpander, the product is arranged as a set of snippets that are organized into snippet groups. Individual users are members of particular snippet groups. The purpose of this endpoint is to return the data for the set of snippets belonging to a snippet group, provided the calling user (via the Authorization header) is a member of that snippet group.

Data

This example uses a dummy in-memory database with a very small set of records. Within that data set, the following options should result in a successful call.

• SnippetGroupID: 7988ca09-87dc-426e-9a9c-9524ce47fe13
• Valid Authorization header: eohuFKr_Y9DjWFyUUrZL3oDonMDMuboAKZqwgf13XLX
  • This corresponds to user 23dN9jRn2TRjqD5Zb in the database.
• Note that there is a second user (23dN9jRn2TRjqD5Zc) in the database that uses Authorization header xjf-TQ5aaPf_RVBVmfxYbPRZYBTVLuQzIwoGxUG0WX-. This user does not have access to this snippet group.

Code

The primary code of interest in the project is app/routes/index.ts which defines the endpoint and then calls through to modules/snippets/snippetMethodsBase.ts.

Setup

These instuctions will help you set up your environment.

1. Clone the repository to your system

2. Install nvm (Node Version Manager)

   curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

3. Install Node 14.19.1

   nvm install 14.19.1

4. Install npm packages

   npm install

5. Use the npm commands listed below to either run the server or run the Jest tests. Both of these commands will populate the database from the ./data folder.

Available npm commands

start

• Runs the Express server

test

• Runs the Jest tests