9 |
10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/files/testpages/autocomplete.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |
-
12 |
9 |
10 | 11 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/files/testpages/elementWithin.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |
Home
8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/files/testpages/iframe1.html: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/files/testpages/iframe2.html: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/files/testpages/noClickTilVisible.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |-
12 |
-
9 |
- item 1 10 |
- item 2 11 |
11 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/files/testpages/waitFor.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |
-
12 |
9 |
10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docs/testpages/autocomplete.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |
-
12 |
9 |
10 | 11 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /docs/testpages/elementWithin.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |
Home
8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docs/testpages/iframe1.html: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/testpages/iframe2.html: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/testpages/noClickTilVisible.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |-
12 |
-
9 |
- item 1 10 |
- item 2 11 |
11 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docs/testpages/waitFor.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |
-
12 |
25 |
26 | Live HTML Reporter
27 | ------------------
28 | Prints results to an html page. Support images. Screenshots on error.
29 | *)
30 | open configuration
31 | open reporters
32 | reporter <- new reporters.LiveHtmlReporter(BrowserStartMode.Chrome, "driver path") :> IReporter
33 |
34 | (**
35 | 
36 |
37 | TeamCity Reporter
38 | -----------------
39 | Prints special outputs that are compatible with team city.
40 | *)
41 |
42 | open configuration
43 | open reporters
44 | reporter <- new TeamCityReporter() :> IReporter
45 |
46 | //screenshot is TODO
47 |
48 | (**
49 | JUnit Reporter
50 | -----------------
51 | Produces test results in basic JUnit format. Compatible with CircleCI.
52 | *)
53 |
54 | open configuration
55 | open reporters
56 | reporter <- new JUnitReporter("./TestResults.xml") :> IReporter
57 |
--------------------------------------------------------------------------------
/docsSrc/content/cleanups.js:
--------------------------------------------------------------------------------
1 | $(function() {
2 | // Makes code snippets responsive
3 | $("table").addClass("table-responsive");
4 | })
5 |
6 |
--------------------------------------------------------------------------------
/docsSrc/content/hotload.js:
--------------------------------------------------------------------------------
1 | var refreshSocket = new WebSocket('ws://' + window.location.host)
2 | .onmessage = () => {
3 | location.reload();
4 | }
5 |
--------------------------------------------------------------------------------
/docsSrc/content/submenu.js:
--------------------------------------------------------------------------------
1 | $(function() {
2 | // ------------------------------------------------------- //
3 | // Multi Level dropdowns
4 | // ------------------------------------------------------ //
5 | $("ul.dropdown-menu [data-toggle='dropdown']").on("click", function(event) {
6 | event.preventDefault();
7 | event.stopPropagation();
8 |
9 | $(this).siblings().toggleClass("show");
10 |
11 |
12 | if (!$(this).next().hasClass('show')) {
13 | $(this).parents('.dropdown-menu').first().find('.show').removeClass("show");
14 | }
15 | $(this).parents('li.nav-item.dropdown.show').on('hidden.bs.dropdown', function(e) {
16 | $('.dropdown-submenu .show').removeClass("show");
17 | });
18 |
19 | });
20 | });
21 |
--------------------------------------------------------------------------------
/docsSrc/content/themes.js:
--------------------------------------------------------------------------------
1 |
2 | var themes = {
3 | "light" : {
4 | "button-text" : "Swap to Dark",
5 | "button-classes" : "btn btn-dark border-light",
6 | "next-theme" : "dark",
7 | "body-class" : "bootstrap"
8 | },
9 | "dark" : {
10 | "button-text" : "Swap to Light",
11 | "button-classes" : "btn btn-light",
12 | "next-theme" : "light",
13 | "body-class" : "bootstrap-dark"
14 | }
15 | };
16 |
17 | var themeStorageKey = 'theme';
18 |
19 | function swapThemeInDom(theme) {
20 | var newTheme = themes[theme];
21 | var bootstrapCSS = document.getElementsByTagName('body')[0];
22 | bootstrapCSS.setAttribute('class', newTheme['body-class'])
23 | }
24 |
25 | function persistNewTheme(theme) {
26 | window.localStorage.setItem(themeStorageKey, theme);
27 | }
28 |
29 | function setToggleButton(theme) {
30 | var newTheme = themes[theme];
31 | var themeToggleButton = document.getElementById('theme-toggle');
32 | themeToggleButton.textContent = newTheme['button-text'];
33 | themeToggleButton.className = newTheme['button-classes'];
34 | themeToggleButton.onclick = function() {
35 | setTheme(newTheme['next-theme']);
36 | }
37 | }
38 |
39 | function setTheme(theme) {
40 | try {
41 | swapThemeInDom(theme);
42 | }
43 | catch(e){
44 | }
45 | try {
46 | persistNewTheme(theme);
47 | }
48 | catch(e) {
49 | }
50 | try {
51 | setToggleButton(theme);
52 | }
53 | catch (e) {
54 | }
55 | }
56 |
57 | function getThemeFromStorage() {
58 | return window.localStorage.getItem(themeStorageKey);
59 | }
60 |
61 | function getThemeFromScheme() {
62 | try {
63 | if (window.matchMedia("(prefers-color-scheme: dark)").matches){
64 | return 'dark';
65 | }
66 | else {
67 | return 'light';
68 | }
69 | }
70 | catch(e) {
71 | return null;
72 | }
73 | }
74 |
75 | function loadTheme() {
76 | var theme = getThemeFromStorage() || getThemeFromScheme() || 'light';
77 | setTheme(theme);
78 | }
79 |
80 | document.addEventListener('readystatechange', (event) => {
81 | loadTheme()
82 | });
83 |
--------------------------------------------------------------------------------
/docsSrc/content/tips.js:
--------------------------------------------------------------------------------
1 | var currentTip = null;
2 | var currentTipElement = null;
3 |
4 | function hideTip(evt, name, unique) {
5 | var el = document.getElementById(name);
6 | el.style.display = "none";
7 | currentTip = null;
8 | }
9 |
10 | function findPos(obj) {
11 | // no idea why, but it behaves differently in webbrowser component
12 | if (window.location.search == "?inapp")
13 | return [obj.offsetLeft + 10, obj.offsetTop + 30];
14 |
15 | var curleft = 0;
16 | var curtop = obj.offsetHeight;
17 | while (obj) {
18 | curleft += obj.offsetLeft;
19 | curtop += obj.offsetTop;
20 | obj = obj.offsetParent;
21 | };
22 | return [curleft, curtop];
23 | }
24 |
25 | function hideUsingEsc(e) {
26 | if (!e) { e = event; }
27 | hideTip(e, currentTipElement, currentTip);
28 | }
29 |
30 | function showTip(evt, name, unique, owner) {
31 | document.onkeydown = hideUsingEsc;
32 | if (currentTip == unique) return;
33 | currentTip = unique;
34 | currentTipElement = name;
35 |
36 | var pos = findPos(owner ? owner : (evt.srcElement ? evt.srcElement : evt.target));
37 | var posx = pos[0];
38 | var posy = pos[1];
39 |
40 | var el = document.getElementById(name);
41 | var parent = (document.documentElement == null) ? document.body : document.documentElement;
42 | el.style.position = "absolute";
43 | el.style.left = posx + "px";
44 | el.style.top = posy + "px";
45 | el.style.display = "block";
46 | }
47 |
--------------------------------------------------------------------------------
/docsSrc/content/upgrade1to2.fsx.broken:
--------------------------------------------------------------------------------
1 | (*** hide ***)
2 | // This block of code is omitted in the generated HTML documentation. Use
3 | // it to define helpers that you do not want to show in the documentation.
4 | #I "../../src/canopy/bin/Release/netstandard2.0"
5 |
6 | #if !FAKE
7 | #r "netstandard"
8 | #endif
9 |
10 | #r "canopy.dll"
11 | open canopy.classic
12 |
13 | (**
14 | Upgrade 1.x to 2.x
15 | ========================
16 | *)
17 |
18 | (**
19 | Breaking changes
20 | -----
21 | * Removed coverage report support, made move to 2.0 more difficult and I don't think they were used
22 | * Removed phantomjs support, the project is no longer updated because of chrome headless
23 | * Removed writeToSelectWithOptionValue, old backwards compat flag
24 | * Removed optimizeByDisablingCoverageReport, old optimization around coverage reports
25 | * Changed default driver path from c:\ to executing directory
26 | *)
27 |
28 | (**
29 | Namespace changes
30 | -----
31 | ```
32 | canopy -> canopy.classic
33 | canopy.runner -> canopy.runner.classic //no longer auto opened
34 |
35 | canopy.configuration //no longer auto opened
36 | canopy.reporters
37 | canopy.screen
38 | canopy.types //no longer auto opened
39 | canopy.wait //no longer auto opened
40 | canopy.finders
41 | canopy.history
42 | canopy.userAgents
43 |
44 | canopy.parallell.functions //new
45 | canopy.parallell.instanced //new
46 | ```
47 | *)
48 |
49 | (**
50 | Signature changes
51 | -----
52 | * The signature for custom finders now requires an instance of IWebDriver (the browser) also
53 | * From ```string -> (By -> ReadOnlyCollection9 |
10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /docsSrc/files/testpages/autocomplete.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |
-
12 |
9 |
10 | 11 | 18 | 19 | 20 | -------------------------------------------------------------------------------- /docsSrc/files/testpages/elementWithin.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |
Home
8 | 9 | 10 | 11 | -------------------------------------------------------------------------------- /docsSrc/files/testpages/iframe1.html: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docsSrc/files/testpages/iframe2.html: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docsSrc/files/testpages/noClickTilVisible.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |-
12 |
-
9 |
- item 1 10 |
- item 2 11 |
11 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /docsSrc/files/testpages/waitFor.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |
-
12 |
18 |
21 |
22 |
19 |
20 |
23 |
24 |
37 |
38 |
25 |
36 |
26 |
35 |
27 |
34 | 28 | The canopy library can be installed from NuGet: 29 |
30 |31 |
PM> Install-Package canopy32 | 33 |
39 |
53 |
54 | Getting Started
55 | ---------------
56 | ####1\. Create a new F# console application (4.6.1+ or .net core)
57 |
40 | canopy is a web testing framework with one goal in mind, make UI testing simple:
41 |
42 | * Solid stabilization layer built on top of Selenium. Death to "brittle, quirky, UI tests".
43 |
44 | * Quick to learn. Even if you've never done UI Automation, and don't know F#.
45 |
46 | * Clean, concise API.
47 |
48 | * .net Standard 2.0.
49 |
50 | * MIT License.
51 |
52 |
58 |
62 |
63 | ####2\. Install canopy via Nuget
64 |
59 | 
60 |
61 |
60 |
65 |
69 |
70 | ####3\. Install chromedriver via Nuget
71 |
66 | 
67 |
68 |
67 |
72 |
76 |
77 | ####4\. Paste the following code into `Program.fs`
78 |
79 | *)
80 | //these are similar to C# using statements
81 | open canopy.runner.classic
82 | open canopy.configuration
83 | open canopy.classic
84 |
85 | canopy.configuration.chromeDir <- System.AppContext.BaseDirectory
86 |
87 | //start an instance of chrome
88 | start chrome
89 |
90 | //this is how you define a test
91 | "taking canopy for a spin" &&& fun _ ->
92 | //this is an F# function body, it's whitespace enforced
93 |
94 | //go to url
95 | url "http://lefthandedgoat.github.io/canopy/testpages/"
96 |
97 | //assert that the element with an id of 'welcome' has
98 | //the text 'Welcome'
99 | "#welcome" == "Welcome"
100 |
101 | //assert that the element with an id of 'firstName' has the value 'John'
102 | "#firstName" == "John"
103 |
104 | //change the value of element with
105 | //an id of 'firstName' to 'Something Else'
106 | "#firstName" << "Something Else"
107 |
108 | //verify another element's value, click a button,
109 | //verify the element is updated
110 | "#button_clicked" == "button not clicked"
111 | click "#button"
112 | "#button_clicked" == "button clicked"
113 |
114 | //run all tests
115 | run()
116 |
117 | printfn "press [enter] to exit"
118 | System.Console.ReadLine() |> ignore
119 |
120 | quit()
121 | (**
122 |
73 | 
74 |
75 |
74 |
123 |
128 |
129 |
124 | ####5\. Run
125 | 
126 |
127 |
126 |
130 |
140 |
141 | ####7\. Watch some intro videos
142 |
131 | ####6\. Explore the rest of canopy's API
132 |
133 | * [Actions](/canopy/Docs/actions.html): documentation of everything you can do on a page
134 | * [Assertions](/canopy/Docs/assertions.html): all the ways you can verify what's on the page is correct
135 | * [Configuration](/canopy/Docs/configuration.html): configure and fine tune canopy
136 | * [Testing](/canopy/Docs/content.html): different ways to orchestrate tests and troubleshoot issues with a page
137 | * [Reporting](/canopy/Docs/reporting.html): different ways to output the results of your test suite
138 |
139 |
143 |
148 |
149 |
144 | 4 minute canopy starter kit
145 |
146 |
147 |
150 |
160 |
161 |
151 | 5 minutes with Amir Rajan
152 |
158 |
159 |
162 |
172 | *)
173 |
--------------------------------------------------------------------------------
/docsSrc/index.md.bak:
--------------------------------------------------------------------------------
1 | # canopy
2 |
3 | ---
4 |
5 | ## What is canopy?
6 |
7 | canopy is a library that does this specific thing.
8 |
9 | ## Why use canopy?
10 |
11 | I created it because I had to solve an issue with this other thing.
12 |
13 | ---
14 |
15 |
163 | 30 minutes with Chris Holt at fsharpConf
164 |
170 |
171 |
16 |
61 |
--------------------------------------------------------------------------------
/docsTool/CLI.fs:
--------------------------------------------------------------------------------
1 | namespace DocsTool
2 |
3 | module CLIArgs =
4 | open Argu
5 | open Fake.IO.Globbing.Operators
6 |
7 | type WatchArgs =
8 | | ProjectGlob of string
9 | | DocsSourceDirectory of string
10 | | GitHubRepoUrl of string
11 | | ProjectName of string
12 | | ReleaseVersion of string
13 | with
14 | interface IArgParserTemplate with
15 | member this.Usage =
16 | match this with
17 | | ProjectGlob _ -> "The glob for the dlls to generate API documentation."
18 | | DocsSourceDirectory _ -> "The docs source directory."
19 | | GitHubRepoUrl _ -> "The GitHub repository url."
20 | | ProjectName _ -> "The project name."
21 | | ReleaseVersion _ -> "The project's Release Version name."
22 |
23 | type BuildArgs =
24 | | SiteBaseUrl of string
25 | | ProjectGlob of string
26 | | DocsOutputDirectory of string
27 | | DocsSourceDirectory of string
28 | | GitHubRepoUrl of string
29 | | ProjectName of string
30 | | ReleaseVersion of string
31 | with
32 | interface IArgParserTemplate with
33 | member this.Usage =
34 | match this with
35 | | SiteBaseUrl _ -> "The public site's base url."
36 | | ProjectGlob _ -> "The glob for the dlls to generate API documentation"
37 | | DocsOutputDirectory _ -> "The docs output directory."
38 | | DocsSourceDirectory _ -> "The docs source directory."
39 | | GitHubRepoUrl _ -> "The GitHub repository url."
40 | | ProjectName _ -> "The project name."
41 | | ReleaseVersion _ -> "The project's Release Version name."
42 |
43 | type CLIArguments =
44 | | [
17 |
27 |
18 |
26 |
19 |
22 |
25 | Tutorials
20 |Takes you by the hand through a series of steps to create your first thing.
21 |
28 |
38 |
29 |
37 |
30 |
33 |
36 | How-To Guides
31 |Guides you through the steps involved in addressing key problems and use-cases.
32 |
39 |
49 |
40 |
48 |
41 |
44 |
47 | Explanations
42 |Discusses key topics and concepts at a fairly high level and provide useful background information and explanation..
43 |
50 |
60 |
51 |
59 |
52 |
55 |
58 | Api Reference
53 |Contain technical reference for APIs.
54 |