https://github.com/stavares843/echo-server-test

Echo server
https://github.com/stavares843/echo-server-test

Last synced: about 2 months ago
JSON representation

Echo server

• Host: GitHub
• URL: https://github.com/stavares843/echo-server-test
• Owner: stavares843
• Created: 2024-10-25T12:00:58.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-10-27T23:48:10.000Z (3 months ago)
• Last Synced: 2024-10-28T02:24:17.404Z (3 months ago)
• Language: Python
• Homepage:
• Size: 8.38 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# echo-server-test

[![Unit Tests](https://github.com/stavares843/echo-server-test/actions/workflows/unit-tests.yml/badge.svg?branch=main)](https://github.com/stavares843/echo-server-test/actions/workflows/unit-tests.yml)

[![Build, Sign Windows App and Run Tests](https://github.com/stavares843/echo-server-test/actions/workflows/windows-app.yml/badge.svg)](https://github.com/stavares843/echo-server-test/actions/workflows/windows-app.yml)

This adds a server that listens for incoming requests. Whenever we send it an HTTP request, will respond by sending back the request path, headers, and so forth.

# OS used: macOS (I used macOS 13)

# Requirements to run the `echo_server.py` locally: 

- have Python3 installed

- cd to this repo

- execute `python3 echo_server.py`

If you wanna use Windows, you can just double-click on the `echo_server.py` instead. I used Windows 11.

https://github.com/user-attachments/assets/5afa235d-6564-43f0-bcee-f31441e71d94

The server is written in Python and listens on port 8080.

Requests:

- GET request, it echoes back the requested path and the headers.

- POST request, it echoes back any data additional to the headers.

Once it’s running, you can send requests to it, like typing http://localhost:8080/test in the browser or executing a curl to test it.

Example







https://github.com/user-attachments/assets/ce3b2b29-43ec-4fc2-9362-126292dd5069

# OS used: Windows 11

# Requirements to compile the binary

- have Python3 installed

- install the `installer` module - `pip install pyinstaller`

- cd to this repo

- execute `pyinstaller --onefile echo_server.py` - this will this will create a `dist` folder where you find the `echo_server.exe`

## Tests

We have 2 tests - the ones that are performed (`test_server.py`) on the source code (`echo_server.py`) and the ones (`test_server_exe.py`) that are performed directly on the executable 

# Requirements to run the tests locally on the source code: (macOS - I used macOS 13)

- have Python3 installed

- have `requests` module - `pip install requests`

- cd to this repo

- execute `python3 -m unittest discover -s . -p "test_server.py"`

# Requirements to run the tests locally on the executable itself: (Windows 11)

- cd to this repo

- execute the following command: `start-process echo_server` (this repo already has a signed executable with this name)

- execute the following command: `python test_server_exe.py`

In the below video, you notice first the .exe is not running so trying to execute the tests will fail as expected

After starting the process and running the tests, works properly 🎉

https://github.com/user-attachments/assets/35dfe65c-216c-4bec-bf95-7ffb42c20086