3.3 Checking Development Tests

The purpose of this section is to go back over all the tests performed in each cycle of development and ensure that the project still passes the tests.

However, there is one new addition since the development tests: the addition of automated tests which allow for some of the tests to be done by the code itself so as to be able to test the majority of the key functions individually without having to call the functions in an isolated state. These tests are written on a module by module basis and do not cover the entire code base - such as the server module which is too complicated to automate tests for without building the module around the tests in the first place - therefore I have added a "type of test" section which specifies whether or not the tests are automated with a test program or done manually by myself.

Cycle 1

Test

Instructions

Expected Result

Type of Test

Result

Passed?

Run the webportal on localhost.

Webportal launches and some text is displayed.

Manual

As expected, although contains additional features than just text.

Deploy the web-portal by git pushing to Github.

Vercel should automatically detect the changes and deploy the new version.

Manual

As expected

Run the node program

Output some kind of welcome message.

Manual

As expected, then proceeds to run the rest of the node software.

Download the node program by clicking the download button on the website.

The Node program should be downloaded to the test computer

Manual

As expected

Cycle 2

Test

Instructions

Expected Result

Type of Test

Result

Passed?

Run "v --version" in the terminal.

Output of "V" then some version number and a hash of that update.

Manual

"V 0.3.1 5c716af"

Run "yarn start" in the node package's source folder.

The node software to be compiled and ran.

Manual

As expected

Run "yarn build" in the node package's source folder.

The node software to be compiled, zipped and put into the webportal's public folder.

Manual

As expected

Same as test 2.

Node software outputs a welcome message.

Manual

As expected

Same as test 2.

Node's web api should launch leading to "http://localhost:8000" displaying a welcome message.

Manual

As expected

Navigate to "https://monochain.network/download"

Be shown download instructions.

Manual

As expected

Download and unzip the node software.

Should download and unzip to an executable file.

Manual

As expected

Run the downloaded node software on an arm based macOS device.

Should run as tested in test 4 and 5.

Manual

As expected

Cycle 3

Test

Instructions

Expected Result

Type of Test

Result

Passed?

Create a new configuration file using "create_configuration()"

Outputs a log to the console confirming the operation is commencing and a config file should be generated.

Automated

As Expected

Load the new config file using "load_config()"

Config file should be loaded and returned.

Automated

As Expected

Load the new config file using "get_config()"

Config file should be loaded and returned.

Automated

As Expected

[Additional Test] Save and then load a configuration.

The data saved and then loaded back in should be exactly the same.

Automated

As Expected

Test 1

const test_config_path = "./test_config.json"

fn test_config_creation() {
	println("[Testing - Configuration] Running test: config_creation")
	config := configuration.create_configuration(test_config_path)
	assert true // if code gets to this point, the value has to be a valid configuration
}

Test 2

const test_config_path = "./test_config.json"

fn test_config_load() {
	println("[Testing - Configuration] Running test: config_load")
	config := configuration.load_config(test_config_path)
	assert true // if code gets to this point, the value has to be a valid configuration
}

Test 3

fn test_get_config() {
	get_config := configuration.get_config()
	assert true
}

Test 4

const test_config_path = "./test_config.json"

fn test_config_save_then_load() {
	println("[Testing - Configuration] Running test: config_save_then_load")
	config := configuration.create_configuration(test_config_path)
	configuration.save_config(config, 0, test_config_path)
	loaded_config := configuration.load_config(test_config_path)
	assert config == loaded_config
}

Cycle 4

Test

Instructions

Expected Result

Type of Test

Result

Passed?

Compile for Windows from a MacOS device.

Node program to compile and execute normally.

Manual

Failed, required a version of some header files that is not available for macOS ARM (my laptop)

Compile for Linux from a MacOS device.

Node program to compile and execute normally.

Manual

Failed with various header errors and indetifier errors

Run the Windows version on a non-windows system.

Computer running incorrect program should report some kind of error and close the program.

Manual

Does as expected

Cycle 5

Test

Instructions

Expected Result

Type of Test

Result

Passed?

Generate a key pair.

Keys to be generated and validated successfully without crashing.

Automated

As Expected

Sign some random input data.

A signature to be generated without crashing.

Automated

As Expected

Sign then validate some random input data.

A signature to be generated then validated successfully.

Automated

As Expected

Test 1

pub fn test_gen_keys() {
	println("[testing] Testing Key Pair Generation")
	cryptography.gen_keys()
	// because the gen_keys function hasn't exited yet, we know that the keys are valid
	println("[testing] Key Pair Generation Test Passed")
	assert true
}

Test 2

pub fn test_sign() {
	println("[testing] Testing Signing")
	keys := cryptography.gen_keys()

	println("[testing] Generated a new key pair successfully")
	message := time.utc().str().bytes()

	keys.sign(message)
	println("[testing] Signed a message successfully")
	println("[testing] Signing Test Passed")

	// because the sign function hasn't exited yet, we know that the signature is valid
	assert true
}

Test 3

pub fn test_verify() {
	mut failed := false
	println("[testing] Testing Verification")
	keys := cryptography.gen_keys()

	println("[testing] Generated a new key pair successfully")
	message := time.utc().str().bytes()

	signature := keys.sign(message)
	println("[testing] Signed a message successfully")

	if cryptography.verify(keys.pub_key, message, signature) {
		println("[testing] Verified a signature successfully")
		println("[testing] Verification Test Passed")
		failed = false
	} else {
		println("[testing] Verification failed")
		println("[testing] Verification Test Failed")
		failed = true
	}
	
	assert failed == false
}

Cycle 6

I've changed the reference of the node that will be used in the test from "https://nano.monochain.network" to "http://nano:8000", this won't affect the actual test and just reflects a change of switching from handshaking with a publicly hosted server to using a locally hosted server.

Test

Instructions

Expected Result

Type of Test

Result

Passed?

Send a ping request to "http://nano:8000"

The requester to successfully complete the ping request.

Manual

This had to be completed as a handshake event rather than a ping event but still worked as a proof of connection.

Receive a ping request as "http://nano:8000"

The receiver to successfully receive and process the request.

Manual

Same as above

Cycle 7

Test

Instructions

Expected Result

Type of Test

Result

Passed?

Navigate throughout the website on a desktop/laptop device

The website to stay "intact" with no components becomming hidden or breaking.

Manual

As Expected

Navigate throughout the website on a phone/small device

The website to stay "intact" with no components becomming hidden or breaking.

Manual

All works except for a small section on the download page which goes off the page.

Open the site on desktop device.

The desktop styled navigation bar should appear along the top of the screen.

Manual

As Expected

Open the site on mobile device.

The mobile styled navigation bar should appear with a menu button to open and close the bulk of the contents.

Manual

As Expected

Cycle 8

Test

Instructions

Expected Result

Type of Test

Result

Passed?

Generate a key pair.

The program not to exit, which will happen if the key pair cannot be generated.

Automated

As Expected

Generate a key pair and sign some data.

The program not to exit, which will happen if the key pair cannot be generated or sign the data.

Automated

As Expected

Generate a key pair, sign and then verify some data.

The program not to exit and to verify that the message matches the signature.

Automated

As Expected

Test 1

pub fn test_gen_keys() {
	println("[testing] Testing Key Pair Generation")
	cryptography.gen_keys()
	// because the gen_keys function hasn't exited yet, we know that the keys are valid
	println("[testing] Key Pair Generation Test Passed")
	assert true
}

Test 2

pub fn test_sign() {
	println("[testing] Testing Signing")
	keys := cryptography.gen_keys()

	println("[testing] Generated a new key pair successfully")
	message := time.utc().str().bytes()

	signed := keys.sign(message)
	println("[testing] Signed a message successfully: $signed")
	println("[testing] Signing Test Passed")

	// because the sign function hasn't exited yet, we know that the signature is valid
	assert true
}

Test 3

pub fn test_verify() {
	mut failed := false
	println("[testing] Testing Verification")
	keys := cryptography.gen_keys()

	println("[testing] Generated a new key pair successfully")
	message := time.utc().str().bytes()

	signature := keys.sign(message)
	println("[testing] Signed a message successfully")

	if cryptography.verify(keys.pub_key, message, signature) {
		println("[testing] Verified a signature successfully")
		println("[testing] Verification Test Passed")
		failed = false
	} else {
		println("[testing] Verification failed")
		println("[testing] Verification Test Failed")
		failed = true
	}
	
	assert failed == false
}

Cycle 9

There were no tests for this cycle and hence nothing to check.

Cycle 10

Test

Instructions

Expected Result

Type of Test

Result

Passed?

Completing a correct and valid handshake using a time object as the message.

A series of console logs on both nodes confirming that the handshake was successful.

Manual

As Expected

Completing an invalid handshake using the string "invalid data" as the message.

For both nodes to record the handshake as unsuccessful and log such to the console.

Manual

As Expected

Cycle 11

The way in which references were stored and used was completely refactored in cycle 11 and as such the code that was tested in this cycle no longer exists or is distributed in seperate parts of the project, however the new references are still tested in the tests for cycle 13 below.

Cycle 12

Test

Instructions

Expected Result

Result

Passed?

Navigate to 'https://localhost:8000/dashboard'

The dashboard page should redirect to the login page with an option to input a token or generate one.

As Expected

Click the 'generate token' button

A token to be output in the node's terminal output.

As Expected

Enter an invalid token into the input field and click 'submit'

The dashboard should not give the user access.

As Expected

Enter an valid token into the input field and click 'submit'

The dashboard should give the user acess to itself.

As Expected

Type a message and click send.

The node should receive the message from the dashboard and attempt to send it across the network.

As Expected

Connect to and then send a message to another node using the dashboard.

The node should connect to a pre-existing node and then send a message to it after a message is sent from the dashboard.

As Expected

Send a message to the node from another node.

The node on the receipient end of test 6 should receive the same message as was sent from the other node.

As Expected

Cycle 13

Test

Instructions

Expected Result

Type of Test

Result

Passed?

Use the Shell function to echo a message

The message to be echo'ed from the terminal

Automated

As Expected

Launch the database.

The database to launch and no crashes to occur.

Automated

As Expected

Stop the database.

The database to stop and no crashes to occur.

Automated

As Expected

Launch and then connect to the database.

The database to launch then accept the program's connection without any crashes.

Automated

As Expected

Get the last 5 messages from the database.

An array of messages to be returned in the expected type.

Automated

As Expected

Create a node reference in the database.

The reference to be created in the database.

Automated

As Expected

Create a node reference and then check if the software is aware of that node.

The "aware_of" check should return true for the reference test that already exists.

Automated

As Expected

Collect all references from the database.

Should return an array of node references in the expected type.

Automated

As Expected

Setup Code

import database
import pg

// This is a function used just to make the other tests easier
fn create_test_ref(db database.DatabaseConnection) {
	mut aware := db.aware_of('test')

	if !aware {
		// just in case the test ref doesn't exist
		db.create_ref('test', 'test'.bytes())
		aware = db.aware_of('test')
	}
}

Test 1

fn test_shell() {
	cmd := 'echo "hello world"'
	assert database.sh(cmd)
}

Test 2

fn test_db_launch() {
	database.launch()
	// this test will crash if it fails
	assert true
}

Test 3

fn test_db_stop() {
	database.launch()
	database.stop()
	// this test will crash if it fails
	assert true
}

Test 4

fn test_db_connection() {
	database.launch()
	db := database.connect(false, pg.Config{})
	database.stop()
	// this test will crash if it fails
	assert true
}

Test 5

fn test_messages() {
	eprintln("WARNING - THIS TEST RELIES ON THE DATABASE HAVING ATLEAST 1 MESSAGE, IF IT DOES NOT, IT WILL FAIL")
	database.launch()
	db := database.connect(false, pg.Config{})
	messages := db.get_latest_messages(0, 5)
	// if the incorrect format is returned here the program will exit.
	database.stop()
	assert messages.len > 0
}

Test 6

fn test_create_ref() {
	database.launch()
	db := database.connect(false, pg.Config{})
	create_test_ref(db)
	database.stop()
	// this test will crash if it fails
	assert true
}

Test 7

fn test_aware_ref() {
	database.launch()
	db := database.connect(false, pg.Config{})
	create_test_ref(db)
	aware := db.aware_of('test')
	database.stop()
	assert aware
}

Test 8

fn test_refs() {
	database.launch()
	db := database.connect(false, pg.Config{})
	create_test_ref(db)	// create a ref if the test one doesn't already exist
	refs := db.get_refs()
	database.stop()
	assert refs.len > 0
}

Cycle 14

One of the tests in Cycle 14 has been skipped here as it was meant purely for during development as a proof of concept and the code that it was testing was then removed.

The code has also not changed between the end of cycle 14 and now so I have provided the same table and evidence as before.

Test

Instructions

Expected Result

Type of Test

Result

Passed?

Send a message using web sockets

The message sent to be transmitted and received successfully.

Manual

Only works when sending to/from a macOS device (+ possibly Windows)

Send multiple messages for a prolonged period of time (once every 0.5 seconds for 30 seconds).

The messages to continue to be transmitted and validated consistently during the entire time.

Automated

Ran successfully for approximately 10 seconds and then crashed.

Previous3.2 Usability Testing Next4.1 Evaluation of Success Criteria

Last updated 3 years ago

hashtagCycle 1

hashtagTest 1

hashtagTest 2

hashtagTest 3

hashtagTest 4

hashtagCycle 2

hashtagTest 1

hashtagTest 2

hashtagTest 3

hashtagTest 4

hashtagTest 5

hashtagTest 6

hashtagTest 7

hashtagTest 8

hashtagCycle 3

hashtagTest 1

hashtagTest 2

hashtagTest 3

hashtagTest 4

hashtagTest 1

hashtagTest 2

hashtagTest 3

hashtagTest 4

hashtagCycle 4

hashtagTest 1

hashtagTest 2

hashtagTest 3

hashtagCycle 5

hashtagTest 1

hashtagTest 2

hashtagTest 3

hashtagTest 1

hashtagTest 2

hashtagTest 3

hashtagCycle 6

hashtagTest 1

hashtagTest 2

hashtagCycle 7

hashtagTest 1 & 3

hashtagTest 2 & 4

hashtagCycle 8

hashtagTest 1

hashtagTest 2

hashtagTest 3

hashtagTest 1

hashtagTest 2

hashtagTest 3

hashtagCycle 9

hashtagCycle 10

hashtagTest 1

hashtagTest 2

hashtagCycle 11

hashtagCycle 12

hashtagCycle 13

hashtagSetup Code

hashtagTest 1

hashtagTest 2

hashtagTest 3

hashtagTest 4

hashtagTest 5

hashtagTest 6

hashtagTest 7

hashtagTest 8

hashtagTest 1

hashtagTest 2

hashtagTest 3

hashtagTest 4

hashtagTest 5

hashtagTest 6

hashtagTest 7

hashtagTest 8

hashtagSummary

hashtagCycle 14

hashtagTest 1

hashtagTest 2

Cycle 1

Test 1

Test 2

Test 3

Test 4

Cycle 2

Test 1

Test 2

Test 3

Test 4

Test 5

Test 6

Test 7

Test 8

Cycle 3

Test 1

Test 2

Test 3

Test 4

Test 1

Test 2

Test 3

Test 4

Cycle 4

Test 1

Test 2

Test 3

Cycle 5

Test 1

Test 2

Test 3

Test 1

Test 2

Test 3

Cycle 6

Test 1

Test 2

Cycle 7

Test 1 & 3

Test 2 & 4

Cycle 8

Test 1

Test 2

Test 3

Test 1

Test 2

Test 3

Cycle 9

Cycle 10

Test 1

Test 2

Cycle 11

Cycle 12

Cycle 13

Setup Code

Test 1

Test 2

Test 3

Test 4

Test 5

Test 6

Test 7

Test 8

Test 1

Test 2

Test 3

Test 4

Test 5

Test 6

Test 7

Test 8

Summary

Cycle 14

Test 1

Test 2