flight_path_calculator

What is this project?

This project is able to take HTTP POST input such as [["IND", "EWR"], ["SFO", "ATL"], ["GSO", "IND"], ["ATL", "GSO"]] on the endpoint /calculate and returns the flight path SFO -> ATL -> GSO -> IND -> EWR and initial departure and final arrival airport ["SFO", "EWR"].

Continuous Integration Configuration

Github Actions is configured on this repo for 3 jobs:

• build: this will run go build ./... and ensure it passes.
• test: this will run go test ./... and ensure it passes.
• lint: this will run golangci-lint -v --color=always run ./... and ensure it passes.

To view actions in this repo go here.

How to use this project

Requirements

• go 1.19.5
• go mod tidy
• golangci-lint

Testing

go test ./...

Linting

golangci-lint -v --color=always run ./...

Running the project

• go run ./...
• curl -X POST "localhost:8080/calculate" -d '[["IND", "EWR"], ["EWR", "JFK"]]'
• will return something like this:

  {
    "CalculateResult": [
      "IND",
      "JFK"
    ],
    "FinalDepartureAirport": "IND",
    "FinalArrivalAirport": "JFK",
    "Path": "IND - EWR - JFK",
    "ErrorInformation": ""
  }

• CalculateResult is the result desired specifically by PROMPT.md
• FinalDepartureAirport is the initial departure airport.
• FinalArrivalAirport is the final arrival airport.
• Path is the entire path from first departure to final arrival airport, in order.
• ErrorInformation is unused and is unwrapped and return in a 400 BAD REQUEST body if it exists.

Benchmarks

• need to install benchstat and benchcmp for benchmark diffs/comparisons
• go get golang.org/x/perf/cmd/benchstat
• go install golang.org/x/perf/cmd/benchstat
• go get golang.org/x/perf/cmd/benchcmp
• go install golang.org/x/perf/cmd/benchcmp
• go test -bench=. -benchtime=500ms ./...
• results:

go test -bench=. -benchtime=500ms ./... 
?       github.com/SophisticaSean/flight_path_calculator        [no test files]
SLC - JFK - SFO - ABS
First departure: SLC
Last arrival: ABS

First departure: 
Last arrival: 
PASS
ok      github.com/SophisticaSean/flight_path_calculator/internal/controllers   0.003s
goos: linux
goarch: amd64
pkg: github.com/SophisticaSean/flight_path_calculator/internal/models
cpu: AMD Ryzen 9 5950X 16-Core Processor            
BenchmarkLinkedList10Flights-32           133962              4464 ns/op
BenchmarkLinkedList100Flights-32             582            999663 ns/op
BenchmarkLinkedList1000Flights-32            583           1024012 ns/op
BenchmarkNaiveImpl10Flights-32            623413               886.0 ns/op
BenchmarkNaive100Flights-32                18184             33355 ns/op
BenchmarkNaive1000Flights-32                 194           2971799 ns/op
PASS
ok      github.com/SophisticaSean/flight_path_calculator/internal/models        4.401s

Code Coverage

To compute the above code coverage locally, use go test --cover ./...

With 17 unit tests, we have the following coverage:

  go test --cover ./...
  ?       github.com/SophisticaSean/flight_path_calculator        [no test files]
  ok      github.com/SophisticaSean/flight_path_calculator/internal/controllers   (cached)        coverage: 72.0% of statements
  ok      github.com/SophisticaSean/flight_path_calculator/internal/models        (cached)        coverage: 94.2% of statements

• 94.2% coverage on models: 94.2% coverage on models is satisfactory, the uncovered code is difficult to induce a failure for.
• 72.0% coverage on controllers: To increase coverage on controllers, we'd have to implement an interface around models/flightoutputs to induce json serialization errors. The effort to get that increased coverage isn't always worth the extra work it requires, so I'm happy with the coverage on controllers as it stands.