https://github.com/nikole-dunixi/ball-clock-simulator
A simulation written in Go that tracks the position of physical balls within registers to represent time
https://github.com/nikole-dunixi/ball-clock-simulator
aws-lambda ballclock clock golang simulation
Last synced: about 2 months ago
JSON representation
A simulation written in Go that tracks the position of physical balls within registers to represent time
- Host: GitHub
- URL: https://github.com/nikole-dunixi/ball-clock-simulator
- Owner: nikole-dunixi
- Created: 2018-08-19T03:29:12.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2023-09-07T05:10:59.000Z (almost 3 years ago)
- Last Synced: 2025-07-20T15:36:54.012Z (11 months ago)
- Topics: aws-lambda, ballclock, clock, golang, simulation
- Language: Go
- Homepage:
- Size: 387 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Support: support/BallClockSimulator.go
Awesome Lists containing this project
README
# Ball Clock Simulator
For requirements refer to the [PDF](Rakuten-BallClockAssignment.pdf). I had never heard of a Ball Clock before this, I found [this video](https://youtu.be/F7K6GIBWPQw) helpful to understanding what a Ball Clock was and how it worked.
## Roadmap
There is a lot that can be done to improve this. I didn't fully understand the assignment, nor did I have a good grasp on some of the Go interior workings. I've given myself the following homework:
- [ ] Find a Go code profiler
- [ ] Understand how Slices work (See [Issue #1](https://github.com/paul-nelson-baker/ball-clock-simulator/issues/1))
- [ ] Reapproach my algorithms, potentially from the ground up, with the lessons learned to see if we can make all calls sub-second speed
## Installation
You have to have:
- [Go](https://golang.org/dl/) installed to you machine
- [Dep](https://github.com/golang/dep) installed
- retrieve this and initialize the codebase:
```
go get github.com/paul-nelson-baker/ball-clock-simulator
cd ~/go/src/github.com/paul-nelson-baker/ball-clock-simulator
dep ensure
```
## Executing the main application
You can run the convenience scripts provided:
- `test-tdd.sh`
- This will run unit tests for the codebase
- `run-cli-simulation.sh`
- This will start the interactive application
## Executing as an AWS Lambda
Since IaaS and FaaS are relatively simple for small projects, and [Go Build supports build tags](https://dave.cheney.net/2013/10/12/how-to-use-conditional-compilation-with-the-go-build-tool) we can use the same codebase to run our CLI application as a REST endpoint. Compilation branching isn't usually advisable unless you're specifically doing it to support multiple platforms. In this case it's a simple way to include a secondary main method for AWS.
This requires the following installed and available on your terminal PATH:
- [aws-sam-cli](https://github.com/awslabs/aws-sam-cli) so we can run as an AWS Lambda with API Gateway locally
- [curl](https://curl.haxx.se/) to make REST requests
- [jq](https://stedolan.github.io/jq/) so we can pretty-print the output to the console
Once you have all requirements met, open two separate terminals.
- In the first terminal run: `run-aws-simulation.sh`
- This will start SAM-CLI and bind the API to default port 3000
- In the second terminal run: `test-aws-curls.sh`
- This will run all unit tests first
- Then it will curl the endpoint for data with the given inputs
- Mode 1 with 30 Balls
- Mode 1 with 45 Balls
- Mode 2 with 30 Balls and 325 iterations
Note: If you wish to deploy this to an AWS environment, you must include a `CodeUri` as part of the cloud-formation template. This must point to a valid artifact in S3. This requires either manually uploading a file or creating a devops build/test/deploy pipeline, which is currently outside the scope of this project.