[docs] GS added by MargaritaLoseva · Pull Request #534 · DevExpress/testcafe

MargaritaLoseva · 2016-05-13T10:09:21Z

closes#283
\cc @inikulin, @VasilyStrelyaev
Please, review only the text (Since test API is not complete, code snippets may not work properly and an image is not added yet. Links to API sections don't work as well.)

testcafe-build-bot · 2016-05-13T10:38:15Z

✅ Tests for the commit 316c20b have passed. See details.

inikulin · 2016-05-13T11:41:11Z

+
+This guide will provide you with step-by-step instructions on how to create a functional web test with TestCafe.
+You will learn how to install TestCafe, write a test, run the test on multiple browsers and view test results.
+During creating a test, you will learn the basics of TestCafe API, advancing step by step, from the simple to more elaborate testing techniques.


Do we really need this? Is there someone who don't know what "Getting started" is?

It's a standard intro for GS, that quickly describes what the topic covers.

inikulin · 2016-05-13T12:01:05Z

Also, we shouldn't repeat ourselves: there are various places there we start to describe functionality like "there are many reporters, you can create plugins, etc.". The better way is split getting started into following sections:

Install
Test code structure
User actions
Observing page state
Adding assertions
Running tests and getting results

At the end of each section we can have reference to the appropriate articles, e.g. at the end of "Running tests and getting results" we can have links "Learn more about reporters", "Learn more about running configurations", etc.

inikulin · 2016-05-13T12:01:09Z

\r-

testcafe-build-bot · 2016-05-26T14:41:42Z

❌ Tests for the commit 7276225 have failed. See details.

testcafe-build-bot · 2016-05-27T10:18:56Z

❌ Tests for the commit b21b4f1 have failed. See details.

MargaritaLoseva · 2016-05-27T11:04:43Z

FPR

inikulin · 2016-05-27T11:27:19Z

\cc @DevExpress/testcafe-docs I'll take a look a little bit later. Can someone else review for now?

AlexanderMoskovkin · 2016-05-27T11:43:27Z

@MargaritaLoseva Tests are failed. It seems some links are broken

MargaritaLoseva · 2016-05-27T11:45:55Z

@AlexanderMoskovkin Yes, I saw the broken links. They don't work because test api topics are not complete yet. Review only the text, please.

VasilyStrelyaev · 2016-05-27T11:59:24Z

+ const actualText = Hybrid(() => document.querySelector('#article-header').text);
+
+ expect(await actualText.to.equal('Thank You, John Smith!');
+};


inikulin · 2016-06-08T13:26:12Z

+### Observing Page State
+
+TestCafe allows you to observe the page state.
+For this purpose, it offers special functions: [Selector](../test-api/executing-client-code/index.md#selector-functions) to get direct access to DOM elements and [Client](test-api/executing-client-code/index.md#client-functions) to obtain arbitrary data from the client side.


It's ClientFunction, not Client. Also
it offers special functions
I think it's better to say special kinds of functions, because we don't offer the functions themselves, but the way to construct them.

inikulin · 2016-06-08T13:32:45Z

\r-

testcafe-build-bot · 2016-06-09T14:47:27Z

❌ Tests for the commit 97e73a2 have failed. See details.

VasilyStrelyaev · 2016-06-09T14:56:01Z

+test('Test1', async t => {
+ // Test code
+});
+```


It's always a little bit weird when we describe several steps of writing code in words with no examples in the middle.
There are two better ways:
show the code growing step-by-step,
first show the code and then describe.

There is a third option: describe code structure using comments in code

I have used the first way - growing step-by-step

For this particular example I don't think that growing step-by-step is a good approach. It's quite minimal and describes code organzation for tests, so it preferable to be observed all at once.

I don't think any other way will look better and more clear than step-by-step

Can I have a look at step-by-step version?

I also like the current variant (with growing step-by-step).
I don't want to use comments to describe this code, because comments will litter the test's clear structure.
Also, it's not good idea to describe all the test elements below the code - too much info at once.

Step-by-step version is already commited

OK, got it. Let's keep it as is.

VasilyStrelyaev · 2016-06-09T14:57:01Z

\r-

testcafe-build-bot · 2016-06-10T08:46:20Z

❌ Tests for the commit 90ec5d0 have failed. See details.

VasilyStrelyaev · 2016-06-10T09:37:12Z

+fixture `Getting Started`
+```
+
+You can optionally specify a start page URL for the fixture by using the [page](../test-api/test-code-structure.md#specifying-the-start-webpage) function.


It looks like specifying the start page is optional in this tutorial. But that's not true.
I'd better place a direct instruction here.

VasilyStrelyaev · 2016-06-10T09:37:22Z

\r-

testcafe-build-bot · 2016-06-10T10:11:29Z

❌ Tests for the commit fc6192f have failed. See details.

VasilyStrelyaev · 2016-06-10T10:46:54Z

lgtm

inikulin · 2016-06-10T14:03:51Z

+
+// Declare the parameterized hybrid function
+// to obtain text content of an element identified by the `id` attribute
+const getElementById = Selector((id) => document.querySelector(`#${id}`));


Need to remove parenths around id here as well

inikulin · 2016-06-10T14:11:56Z

lgtm

MargaritaLoseva · 2016-06-10T14:13:06Z

\cc @DevExpress/testcafe-docs
Please review

testcafe-build-bot · 2016-06-10T14:15:37Z

❌ Tests for the commit ccfef9e have failed. See details.

AlexanderMoskovkin · 2016-06-10T14:23:26Z

We show how to run a test from the command line. Should we say in Getting started that it is possible to use testCafe as a nodejs module and give a link to the Programming Interface topic?

inikulin · 2016-06-10T14:30:01Z

We show how to run a test from the command line. Should we say in Getting started that it is possible to use testCafe as a nodejs module and give a link to the Programming Interface topic?

No, this is advanced topic and more likely will be needed only for embedders.

AlexanderMoskovkin · 2016-06-10T14:33:58Z

lgtm

MargaritaLoseva · 2016-06-14T12:29:51Z

@kirovboris, @churkin please review

kirovboris · 2016-06-14T12:34:14Z

lgtm

churkin · 2016-06-14T13:15:43Z

lgtm

churkin · 2016-06-14T13:15:58Z

@testcafe-build-bot \retest

AlexanderMoskovkin · 2016-06-14T13:22:17Z

@MargaritaLoseva are failed tests ok for now?

MargaritaLoseva · 2016-06-14T13:25:03Z

Tests still fail due to broken links as @VasilyStrelyaev doesn't pull topics about API yet.

inikulin reviewed May 13, 2016
View reviewed changes

AlexanderMoskovkin closed this May 27, 2016

AlexanderMoskovkin reopened this May 27, 2016

VasilyStrelyaev reviewed May 27, 2016
View reviewed changes

inikulin reviewed Jun 8, 2016
View reviewed changes

VasilyStrelyaev reviewed Jun 9, 2016
View reviewed changes

VasilyStrelyaev reviewed Jun 10, 2016
View reviewed changes

inikulin reviewed Jun 10, 2016
View reviewed changes

GS added
ccfef9e

churkin merged commit 29a02d2 into DevExpress:masterJun 14, 2016

kirovboris pushed a commit to kirovboris/testcafe-phoenix that referenced this pull request Dec 18, 2019
GS added (DevExpress#534)
033af07

Uh oh!

Conversation

MargaritaLoseva commented May 13, 2016• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

testcafe-build-bot commented May 13, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

inikulin commented May 13, 2016

Uh oh!

inikulin commented May 13, 2016

Uh oh!

testcafe-build-bot commented May 26, 2016

Uh oh!

testcafe-build-bot commented May 27, 2016

Uh oh!

MargaritaLoseva commented May 27, 2016

Uh oh!

inikulin commented May 27, 2016

Uh oh!

AlexanderMoskovkin commented May 27, 2016

Uh oh!

MargaritaLoseva commented May 27, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

inikulin commented Jun 8, 2016

Uh oh!

testcafe-build-bot commented Jun 9, 2016

Uh oh!

VasilyStrelyaevJun 9, 2016• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

VasilyStrelyaev commented Jun 9, 2016

Uh oh!

testcafe-build-bot commented Jun 10, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

VasilyStrelyaev commented Jun 10, 2016

Uh oh!

testcafe-build-bot commented Jun 10, 2016

Uh oh!

VasilyStrelyaev commented Jun 10, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

inikulin commented Jun 10, 2016

Uh oh!

MargaritaLoseva commented Jun 10, 2016

Uh oh!

testcafe-build-bot commented Jun 10, 2016

Uh oh!

AlexanderMoskovkin commented Jun 10, 2016

Uh oh!

inikulin commented Jun 10, 2016

Uh oh!

AlexanderMoskovkin commented Jun 10, 2016

MargaritaLoseva commented May 13, 2016•
edited
Loading

VasilyStrelyaevJun 9, 2016•
edited
Loading

MargaritaLoseva commented Jun 14, 2016•
edited
Loading