testdouble/testdrivennode

Test Driven Node.js Precompiler for Codemash 2014

testdrivennode

Test Driven Node.js Precompiler for Codemash 2014

Getting started

1. Install Node.js
2. Clone this repo, change into the project directory, and run npm install
3. To run the server, open a new terminal and nodemon app.js
4. To run the unit tests, run npm test
5. To run all tests, run npm run-script test-all
6. To re-run the tests each time a file changes, open a new terminal and nodemon --exec npm test

API

• POST /games #create - starts the game.
• GET /games/:id #show - game state
• PUT /games/:id #update - used once per game to place the ships
• POST /games/:gameId/shots #create - this is how the user ends a turn

JSON Structure

Game

{
  status: ("setup" | "inprogress" | "won" | "lost"),
  turn: ("yours" | "opponents"),
  primaryGrid:
      [
        [{state:"none", ship: "ship"}, {state:"hit", ship:"ship"}, {state:"none", ship:"ship"}],
        [{state:"miss"}, {state:"miss"}, {state:"miss"}],
        [{state:"none"}, {state:"none"}, {state:"none"}]
      ]
  trackingGrid:
      [
...
      ]
}

Shot

{
  x: 0,
  y: 1,
  hit: [true | false],
  sunk: ["none sunk" | [shipType]]
}

Frontend

The frontend JavaScript, HTML, and CSS located in /public are generated. Visit this repo to make changes.

testdrivennode's Issues

Game Winning

Need to check to see if player or opponent has sunk all ships.

Mocking Time w/ Sinon?

Any value in this? Could use the Sinon fakes for maybe capturing date and time that matches are completed?

Create Game

• 2 players
• shots
• control placement phase vs combat phase

Storing Results

Store something to show off promises. (Needed to mock mongo.)

Travis Fails Because e2e Specs Require Dev Server

Unsure if we want to spend the time creating a more typical test server setup for this exercise. Putting this in here in case somebody else has the time.

Create API

For resources:

• /games/:id - games
  • POST /games #create - this starts the game. Assume the same JSON structure as #5?
  • GET /games/:id #show - game state (see #5)
  • PUT /games/:id #update - This will be used once to place the ships. Having a dedicated grid route feels like overkill.
• /games/:gameId/shots - shots
  • POST /games/:gameId/shots #create - This is how the user ends a turn. Maybe with something like a request of { x: 0, y: 1 } and a response of { x: 0, y: 1, hit: [true | false], sunk: ["none sunk" | [shipType]] }

Game State Response

/games/:id

{
  status: ("setup" | "inprogress" | "won" | "lost")
  turn: ("yours" | "opponents")
  grids:
  {
    primary: {
      [
        0: ["ship", "hit", "ship"] 
        1: ["empty", "miss", "empty"] 
        2: ["empty", "empty", "empty"]
      ]
    },
    tracking: 
      [
        0: ["empty", "hit", "empty"] 
        1: ["empty", "hit", "empty"] 
        2: ["empty", "empty", "miss"]
      ]
  }
}

Create Display

Usable by web frontend or console.