[REG-1579] add initial Automated Testing package docs #55
Conversation
analogrelay
requested review from
addisonbgross,
vontell,
abeizer,
nAmKcAz and
rcornwall-reg
| Select **Add package from git URL** and paste in the following URL: | ||
|
|
||
| ``` | ||
| https://github.com/Regression-Games/RegressionGames.Unity.Testing.git?path=src/gg.regression.unity.testing#v0.0.1 |
There was a problem hiding this comment.
For testing the doc, I currently recommend using this Git URL instead:
REMOVED (see below)
When Regression-Games/RegressionGames.Unity.Testing#6 lands, you could also use:
https://github.com/Regression-Games/RegressionGames.Unity.Testing.git?path=src/gg.regression.unity.testing
To get the latest main version
There was a problem hiding this comment.
This needs to be the SSH link, [email protected]:Regression-Games/RegressionGames.Unity.Testing.git, rather than the https link. I found out (through my own config) that if the user only ever uses SSH (as is the case with my computer), I have not http config for git, and even for public repos, it will fail.
There was a problem hiding this comment.
Ohhh, I keep forgetting I have this in my global git config 🤣
[url "[email protected]:"]
insteadOf = https://github.com
(It forces any https://github.com to become [email protected]:, so HTTPS URLs automatically use SSH instead)
Good call, I'll post an updated URL soon.
The doc is still fine though, since when the package goes live, the HTTPS URL will work because the repo will be public.
There was a problem hiding this comment.
After resolving some issues @abeizer found, please use this URL instead:
[email protected]:Regression-Games/RegressionGames.Unity.Testing.git?path=src/gg.regression.unity.testing#ashley/reg-1596
This is necessary until Regression-Games/RegressionGames.Unity.Testing#8 lands
There was a problem hiding this comment.
I have not http config for git, and even for public repos, it will fail.
We can provide the SSH URL too, but currently we only provide the HTTPS link in our docs for the existing SDK
There was a problem hiding this comment.
Oh my apologies! I confused myself and it was actually the reverse I experienced, duh... we need to use the https one and not the ssh one, THAT was the issue I originally had. So yes we can just keep the HTTPS one
| sidebar_label: Getting Started | ||
| --- | ||
|
|
||
| # Getting Started with Automated Testing |
There was a problem hiding this comment.
Since right now this only encapsulate the UI-related components, I was wondering if we might call it "Automated UI Testing"? We can always change it, but I don't want it to get confused with some of our other docs and site that also claim automated testing.
There was a problem hiding this comment.
I don't think this was changed yet?
| Select **Add package from git URL** and paste in the following URL: | ||
|
|
||
| ``` | ||
| https://github.com/Regression-Games/RegressionGames.Unity.Testing.git?path=src/gg.regression.unity.testing#v0.0.1 |
There was a problem hiding this comment.
This needs to be the SSH link, [email protected]:Regression-Games/RegressionGames.Unity.Testing.git, rather than the https link. I found out (through my own config) that if the user only ever uses SSH (as is the case with my computer), I have not http config for git, and even for public repos, it will fail.
| and Entity Discoverers (see below) should be added as children of the Automation Controller. | ||
| The Controller also provides APIs for spawning bots and managing recordings (via a separate, Automation Recorder component attached to the same object). | ||
|
|
||
| To add the Automation Controller to your scene, click **GameObject > Regression Games > Automation Controller** in the Unity menu. |
There was a problem hiding this comment.
What is the Unity menu? I went to the Unity menu in the toolbar. Might be good to clarify right clicking on the scene object.
There was a problem hiding this comment.
Ah, I meant the main menu bar, but right clicking also provides the same menu. I'll clarify!
| In order to automate entities in your game, the Automation Controller needs to be able to find them. | ||
| The Automation Controller uses Entity Discoverers to find entities in the scene that can be automated. | ||
| The package provides a few built-in Entity Discoverers, but you can also create your own. | ||
| To add one of the built-in discoverers, open the **GameObject > Regression Games > Discovery** menu and select the discoverer you want to add: |
There was a problem hiding this comment.
Here, also be sure to add that you should do this on the automation controller, unless it can be done at the top level as well (but we should at least tell them somewhere to click to get that menu)
There was a problem hiding this comment.
I see... this comes after the picture. I'd put it before the picture so that we avoid the scenario I just had where I didn't scroll further to see more and got stuck on that
There was a problem hiding this comment.
This "where to right click to get the menu" applies to further parts in these docs, so I'll avoid making that comment again and leave this as the last one.
There was a problem hiding this comment.
Here, also be sure to add that you should do this on the automation controller, unless it can be done at the top level as well (but we should at least tell them somewhere to click to get that menu)
If you click that menu item without a node selected, it automatically targets the automation controller. Otherwise, it should give you a fairly clear error telling you the problem.
I see... this comes after the picture. I'd put it before the picture so that we avoid the scenario I just had where I didn't scroll further to see more and got stuck on that
I didn't want to put it the image above since the text that describes the image should generally precede it. I can do that if you think it's clearer though.
|
|
||
|  | ||
|
|
||
| ## Running the Monkey Bot |
There was a problem hiding this comment.
Before this or at the beginning, make sure to mention that you should save the scene
Fixed if you use the |
There was a problem hiding this comment.
It works! Things I really like about this:
- Super easy to understand and get the bot running
- Grouping concepts/functionality within + under the Automation Controller. If I know where my controller is, I know how to access important settings and data like discoverers and recordings.
- Only capturing state + screenshot when it's relevant (not blowing up the .zip size)
One thing I don't see mentioned here is the "Destroy" option after you stop a bot -> It looks like this is supposed to be an easy way to delete recordings? It doesn't seem to be deleting my .zip files though (bug?) :-( I think its usefulness is also limited right now because if I stop my game and restart it, I don't see any previous bots in the overlay. This could be nice for a future task?
I have a mix of blocking and non-blocking comments.
Co-authored-by: Abby Beizer <[email protected]> Co-authored-by: Aaron Vontell <[email protected]>
|
PR Feedback addressed! Taking this out of draft as the remaining work is to record a GIF of the bot and I don't want to block people reviewing the doc on just that. I'll work on that right after lunch though. |
|
And now the GIF recording is in place! |
I thought I got them all, but feel free to let me know if I missed something! |
This is an initial draft of the "one-pager" Getting Started doc for the automated testing package (I think "Monkey Testing" is a little too obscure a name for this, so I was focusing on "Automated Testing" as an alternate).
TODO:
v0.0.1tag of theRegressionGames.Unity.Testingpackage on public GitHub. - This also doesn't have to be done before merge but the docs will refer to it as if it exists.Find the pull request instructions here
Every reviewer and the owner of the PR should consider these points in their request (feel free to copy this checklist so you can fill it out yourself in the overall PR comment)