Engine/Source/Programs/WebTests/README.md

WebTests
--------------------

This is a collection of tests for web features like http, websocket, ssl etc.

# Running the Tests

## Run the WebServer(NOTE: This WebServer is created for TEST PURPOSE ONLY, it's not production ready!!!):
	In ./WebServer folder:
		> runserver.bat
	Or if you use docker:
		> dockerbuildandrun.bat

## Run the tests from VS:
	Set `WebTests` as the startup project and set Solution Configuration to a `Development`.
	If running tests on other devices, pass in the ip as command line args, after extra args AT THE END, like: "--extra-args --web_server_ip=your.pc.ip.address"
	Compile and debug

# Adding new test case in WebServer:
	Add/change the code in ./WebServer code, most likely in httptests/urls.py and httptests/views.py, and save. Code will be reloaded if the web server is running
	When using docker, also need to run dockerbuildandrun.bat
	For more info about how to code in django, check https://docs.djangoproject.com/en/
Added new test project WebTests; Added http test cases; Add the onlinetests web server created using django. #jira UE-182678 [REVIEW] [at]alejandro.aguilar [at]michael.kirzinger [at]stephen.ma #rb [at]stephen.ma [CL 25631147 by lorry li in ue5-main branch] 2023-05-25 17:56:06 -04:00			`WebTests`
			`--------------------`

			`This is a collection of tests for web features like http, websocket, ssl etc.`

			`# Running the Tests`

			`## Run the WebServer(NOTE: This WebServer is created for TEST PURPOSE ONLY, it's not production ready!!!):`
			`In ./WebServer folder:`
			`> runserver.bat`
			`Or if you use docker:`
			`> dockerbuildandrun.bat`

			`## Run the tests from VS:`
			Set `WebTests` as the startup project and set Solution Configuration to a `Development`.
Updated the WebTests doc since UE5 integrated with new tests param; Use sections for http methods tests. [REVIEW] [at]michael.atchison [at]michael.kirzinger [at]stephen.ma [at]rafa.lecina #rb [at]michael.atchison [CL 25773734 by lorry li in ue5-main branch] 2023-06-02 16:59:56 -04:00			`If running tests on other devices, pass in the ip as command line args, after extra args AT THE END, like: "--extra-args --web_server_ip=your.pc.ip.address"`
Added new test project WebTests; Added http test cases; Add the onlinetests web server created using django. #jira UE-182678 [REVIEW] [at]alejandro.aguilar [at]michael.kirzinger [at]stephen.ma #rb [at]stephen.ma [CL 25631147 by lorry li in ue5-main branch] 2023-05-25 17:56:06 -04:00			`Compile and debug`

			`# Adding new test case in WebServer:`
			`Add/change the code in ./WebServer code, most likely in httptests/urls.py and httptests/views.py, and save. Code will be reloaded if the web server is running`
			`When using docker, also need to run dockerbuildandrun.bat`
			`For more info about how to code in django, check https://docs.djangoproject.com/en/`