Skip to content

Commit

Permalink
docs - typo fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
silversword411 committed Nov 10, 2022
1 parent 6506671 commit d289974
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/testing/UnitTests.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ in a diverse set of environments as possible, from computers, to routers, etc.

By providing functionality in this fashion, enables scenarios where new features and patches can be deployed to the agent in realtime,
without necessarily having to recompile and update the agents. This also enables powerful testing and debugging tools to be developed,
as the server can push functions specifically built to test and/or interact with the runtime environemnt. For example, "Console Mode", allows the user to directly evaluate code within the
as the server can push functions specifically built to test and/or interact with the runtime environment. For example, "Console Mode", allows the user to directly evaluate code within the
agent's runtime environment, to quickly debug/introspect the JavaScript running in the agent. More on that later...

### Testing the Agent
Expand All @@ -35,7 +35,7 @@ The test script will inform you of any missing parameters that are required for
self-test, is to simply run it without any options, other than AgentsFolder. This option lets the test script know where to find the necessary JavaScript files.
The test script will load the javascript files the same way an actual Mesh Server would, and send them to the agent the same exact way... The first thing the test script will do, is validate the parameters that were passed in. If any necessary values were omitted, the script will exit, and display a brief on which parameters are missing.
The first thing the script will do is to install the Mesh Agent onto the system, and wait for a connection from the agent.
Once it connects, you'll see some meta-data on the connected agent, such as Commit Date, OS Name, PlatforType, etc:
Once it connects, you'll see some meta-data on the connected agent, such as Commit Date, OS Name, PlatformType, etc:

![](images/self-test-start.png)

Expand All @@ -61,10 +61,10 @@ This test will validate that the agent is responsive and will handle console com
and then test each command to verify that the advertised commands are implemented.

**CPUInfo Test:**
The test server will attempt to fetch cpu info from the agent. This is one of the many telemtry modules that the agent implements. The goal is for the test server to be able to test each and every metadata retrieval function.
The test server will attempt to fetch cpu info from the agent. This is one of the many telemetry modules that the agent implements. The goal is for the test server to be able to test each and every metadata retrieval function.

**PS Test:**
The test server will attemp to fetch a list of all of the running processes on the system, and verify that the returned data structure is a valid JSON object.
The test server will attempt to fetch a list of all of the running processes on the system, and verify that the returned data structure is a valid JSON object.

**Service Enumeration Test:**
This test is more involved then it seems, as even tho the task is simple, in that the server is merely trying to enumerate all the background services installed on the platform,
Expand All @@ -83,7 +83,7 @@ Each of these tests will utilize a variable length randomized string for the Rea
- auth-int: This will present all modes to the agent as being available, and will verify that the agent will correctly select and use the most stringent mode.

**WebRTC Test:**
In this test, the test tool will attempt to negotiate a Peer to Peer WebRTC Datachannel session between the test tool and the agent. This test is split into the various phases of the channel negotionation:
In this test, the test tool will attempt to negotiate a Peer to Peer WebRTC Datachannel session between the test tool and the agent. This test is split into the various phases of the channel negotiation:
1. Initial Offer. This tests that the agent was successfully able to initialize WebRTC and generate the initial offer.
2. Counter Offer. This tests that the agent is able to set the counter offer generated by the test tool when the initial offer was set.
3. Peer Connection Establishment. Once the offers are exchanged, this verifies that a **DTLS** session is able to be established between the agent and the test tool.
Expand All @@ -99,7 +99,7 @@ In this test, the test tool will validate agent's File Transfer capability, in 5
5. CRC Check. This will verify the downloaded data exactly matches the data that was uploaded

**Terminal Test:**
This test will validate that the agent is able to instantiate a terminal session. This test consists of up to 4 seperate tests, depending on the platform:
This test will validate that the agent is able to instantiate a terminal session. This test consists of up to 4 separate tests, depending on the platform:
1. ROOT Terminal. This will prompt the agent to spawn a user consent dialog asking for a Terminal Session. Once allowed, the agent will spawn a ROOT terminal, that the test tool will then send input to close the session.
2. USER Terminal. This will prompt the agent to spawn a user consent dialog asking for a Terminal Session. Once allowed, the agent will spawn a USER terminal, that the test tool will then send input to close the session.
3. PowerShell ROOT Terminal. On Windows platforms with ConPTY support, this will prompt the agent to spawn a user consent dialog asking for a Terminal Session. Once allowed, the agent will spawn a ROOT PowerShell terminal, that the test tool will then send input to close the session.
Expand All @@ -112,7 +112,7 @@ This test will validate that the agent is able to instantiate a Remote KVM sessi
3. Display Selection. The agent will send a control packet indicating the selected display.
4. Screen Resolution. The agent will send a control packet indicating the resolution of the selected display.
5. JUMBO Packet. For large JPEGs, the agent will send an encoded JUMBO packet encapsulating the JPEG data.
6. JPEG Received. This validates that the test tool was able to receive encodeded image data from the agent.
6. JPEG Received. This validates that the test tool was able to receive encoded image data from the agent.



Expand Down

0 comments on commit d289974

Please sign in to comment.