https://github.com/dmuth/procedural-webserver

A webserver written in GoLang which serves up procedurally generated content.
https://github.com/dmuth/procedural-webserver

Last synced: about 1 year ago
JSON representation

A webserver written in GoLang which serves up procedurally generated content.

• Host: GitHub
• URL: https://github.com/dmuth/procedural-webserver
• Owner: dmuth
• License: other
• Created: 2013-06-04T05:42:22.000Z (about 13 years ago)
• Default Branch: main
• Last Pushed: 2020-09-03T22:22:09.000Z (almost 6 years ago)
• Last Synced: 2024-06-19T16:46:08.810Z (almost 2 years ago)
• Language: Go
• Homepage:
• Size: 50.8 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
## Procedural Webserver

A webserver written in Google Go which serves up procedurally generated content.

I built this for a webcrawler which I am working on--I did not want to test 

it out by hamming the same set of websites over and over (as I am sure the

owners would not appreciate that) so I instead wrote this webserver to serve 

up content which is generated procedurally.  That way, I can hammer it with my 

web crawler yet still get unique pages generated with little memory usage.

### Installation

- Make sure your golib is set up properly: `export GOLIB=$HOME/golib`

- Make sure the bin directory is in your path: `PATH=$PATH:$GOLIB/bin`

- To install just the package:

    - `go get -v github.com/dmuth/procedural-webserver`

- To install the CLI:

    - `go get -v github.com/dmuth/procedural-webserver/procedural-webserver-cli`

### Usage from the command line

`$GOLIB/bin/procedural-webserver-cli`

This wil start a webserver listening on at http://localhost:8080/

#### Syntax

    procedural-webserver-cli --debug-level level --num-links-min n --num-links-max n --num-images-min n --num-images-max n --port portnum --seed string

        -port=8080: Port to listen on

        -debug-level="info": Set the debug level

        -num-links-min=1: Minimum number of links per page

        -num-links-max=10: Maximum number of links per page

        -num-images-min=1: Minimum number of images per page

        -num-images-max=10: Maximum number of images per page

        -seed="test_seed": Seed to use for random values

#### From another app

To use this in your app, you'd want Go code that looks like this:

    import server "github.com/dmuth/procedural-webserver"

    func main() {

        server_object := server.NewServer(port, NumLinksMin, NumLinksMax, NumImagesMin, NumImagesMax, Seed)

        go server_object.Start() // Start the webserver

        // do stuff

        server_object.Stop() // Stop the webserver

    }

- NumLinksMin: Min number of links. (actual number of created images is somewhere between min and max)

- NumLinksMax: Max number of links listed on each generated page. (links bring up more procedurally generated content)

- NumImagesMin: Min number of images. (actual number of created images is somewhere between min and max)

- NumImagesMax: Max number of images listed on each generated page. (they're not really images)

- Seed: Our base seed. If not specified, a default is used.  If specified, this changes the content of 

all pages. If you understand how Minecraft world seeds work, this is the same concept.

    

### Query parameters

The following query parameters will have effects on the page that is generated:

- code=num - This will force the websever to return a specific HTTP code.  

    `code=404` will return a 404, for example.

- delay=num How long to delay loading a page for.  Useful for simulating network lag

    - Example times: 

        - 100ms

        - 2s

        - 5m

        - 1h (Yes, this is an hour.  Google Go doesn't care. But Curl might!)

 

### Running the tests

    go test -v github.com/dmuth/procedural-webserver

You should see results like this:

    === RUN TestStringN

    --- PASS: TestStringN (0.00 seconds)

    === RUN TestStringLowerN

    --- PASS: TestStringLowerN (0.00 seconds)

    === RUN TestRandomIntn

    --- PASS: TestRandomIntn (0.00 seconds)

    === RUN TestServer

    --- PASS: TestServer (0.00 seconds)

    PASS

    ok      github.com/dmuth/procedural-webserver   0.031s

### TODO list for The Future

- Optimizations under heavy load

- Generate a random title for each page

- Add support for making page links include a 404 code a certain percentage of the time

- Add support for making page links ionclude a 3xx code a ceratin percentage of the time

### Comments and complaints!

Send them to me, Douglas Muth: http://www.dmuth.org/contact

Filing a bug here is fine, too!

Either way, I'd love to know if you're using this webserver, and find it helpful.