Snyk code review exercise (Golang)

A web server that provides a basic HTTP API for querying the dependency tree of an npm package.

Prerequisites

• Golang >= 1.24
• GNU Make
• (Optionally) Docker

Getting Started

For convenience, a Makefile is provided to perform different tasks. For more details, run:

make help

Running Go program

make run

Running in a Docker container

make docker-run

API

The server will now be running on an available port (defaulting to 8080).

The server contains two endpoints

• /healthcheck
• /package/{packageName}/{packageVersion}

Here is an example that uses curl and jq to fetch the dependencies for [email protected]

curl -s http://localhost:8080/package/react/16.13.0 | jq .

Formatting

The code is formatted using golangci-lint, you can run this via:

make fmt

Linting

The code is linted using golangci-lint, you can run this via:

make lint

Testing

You can run the unit-tests with this command:

make test

Additionally, you can run the integration-tests with this command:

make test-int