Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

style: proofread getting started section #39

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

style: proofread getting started section #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 32 additions & 27 deletions exercises/00-getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
# Getting started

In this section we will install Robot Framework, needed test libraries and ensure that the environment
is up and running in order to do web UI testing with Robot Framework.
In this section we'll
- install Robot Framework
- install some needed test libraries
- prepare the environment for web UI testing

## Terminology

In this section, you will see a lot of Python, operating system and Robot Framework related jargon
In this section, you will see a lot of Python, operating system, and Robot Framework related jargon
which might be confusing to some. So before you go further, let's clarify some terminology that is
used frequently in this ecosystem.

- *pip* - Python package manager, this is a tool that is needed to install Robot Framework and needed test libraries
- *shell* - The shell is the command interpreter in an operating system such as Unix or GNU/Linux, it is a program that executes other programs
- *bat / batch file / cmd* - A batch file is a script file in DOS, OS/2 and Microsoft Windows. It consists of a series of commands to be executed by the command-line interpreter, stored in a plain text file.
- *robot* - The command line tool that allows the user to run Robot Framework test cases and tasks
- *test suite* - A Robot file that contains test cases
- *keyword* - a component, similar to a function in programming, that robot uses to execute steps
- *arguments* - Values that are given to keywords. Also known as parameters.
- *pip* — Python package manager; this is a tool that is needed to install Robot Framework and needed test libraries.
- *shell* — The shell is the command interpreter in an operating system such as Unix or GNU/Linux, it is a program that executes other programs. A.K.A.: Terminal, Command Prompt.
- *bat / batch file / cmd* — A batch file is a script file in DOS, OS/2 and Microsoft Windows. It consists of a series of commands to be executed by the command-line interpreter, stored in a plain text file.
- *`robot`* — The command line tool that allows the user to run Robot Framework test cases and tasks.
- *test suite* — A group of test cases. In Robot Framework, a test suite is contained in single file.
- *keyword* — A defined step; similar to a function in programming. There are [built-in keywords](https://github.com/robotframework/QuickStartGuide/blob/master/QuickStart.rst#library-keywords) or you can [define your own](https://github.com/robotframework/QuickStartGuide/blob/master/QuickStart.rst#user-keywords).
- *arguments* — Values that are given to keywords. Also known as parameters.

## Get the Repository

Expand All @@ -26,30 +28,31 @@ local copy of the repo.

## Install Robot Framework

In order to run Robot Framework test cases we're going to need install Robot Framework. We install this by
using `pip`. By default, the installation happens by calling `pip3 install <package_name>`, but if you are
### Using `pip`
In order to run Robot Framework test cases we're going to need to install Robot Framework. We install it by
using `pip`. Usually you install something by calling `pip3 install <package_name>`, but if you are
using a virtual environment, or have an alias defined, you can try `pip install <package_name>` instead.

Install Robot Framework: `pip3 install robotframework`.
### Installing Robot Framework
Run `pip3 install robotframework`

If the installation was successful, you can use `robot -h` command to verify that you get command line
help for Robot Framework. Output should include Robot version number and some other helpful stuff,
including the command line options (which are also available in [here](http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#all-command-line-options)).
To check that it was installed, run the `robot --help` command. The output should include the Robot Framework version number and some other helpful stuff,
including the command line options (which are also available in the [User Guide](http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#all-command-line-options)).

To run automated test cases for web UIs, the current go-to library is the Browser-library.

Install Browser: `pip3 install robotframework-browser`. After the installation has completed successfully,
the library has to be initialized by running `rfbrowser init`.

In order to ensure that you've done exercises as expected we need you to install robotframework-lint
### Consistency Helper
In order to ensure that you've done the exercises as expected let's install the "robotframework-lint"
tool. A linting tool is a lightweight static analysis tool to verify that you and your team are doing
your code consistently.

Install Robot Framework linter: `pip3 install robotframework-lint`.
To install the linter, run `pip3 install robotframework-lint`

## Install NodeJS
### Testing in the Browser
Robot Framework can test anything if you give it the right library. To run automated test cases for web UIs, we'll use the "Browser" library.

Browser library has requirements for NodeJS. After installing NodeJS run command: `rfbrowser init` to install needed dependencies.
To install this "Browser" library, run `pip3 install robotframework-browser`

After the installation has completed successfully,
the library has to be initialized by running `rfbrowser init`—you'll need [Node.js installed](https://nodejs.org/en/download/). It will take a few minutes to run the initialization.

## Start server

Expand All @@ -67,7 +70,9 @@ Verify setup by running:
- in Windows: run command `python verify.py 00`
- in macOS/Linux: run command `python3 verify.py 00`

> If you run into an `ImportError: cannot import name 'get_installed_distributions' from 'pip._internal.utils.misc'` error, the workaround is to downgrade your pip by running, `pip3 install pip==21.2.4`. See [issue #20](https://github.com/eficode-academy/rf-katas/issues/20) for details.

This should take a few seconds. If the output of the script ends with `Setup in perfect condition!`
we're good to go.
you're good to go to the [next section](01-manual_testing.md).

Otherwise, check the output and fix the missing packages.
Otherwise, check the output to see what you might need to fix.