Skip to content

Commit

Permalink
0.7.1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
KrzysztofJozefowicz committed Oct 5, 2016
1 parent 630190b commit 62d42e1
Show file tree
Hide file tree
Showing 16 changed files with 273 additions and 71 deletions.
3 changes: 2 additions & 1 deletion Red_Help.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,5 @@
* [PyDev with PyLint together with RED](red_help/user_guide/red_pylint.html.md)
* [Debug Robot](red_help/user_guide/debug.html.md)
* [Remote debug] (red_help/user_guide/remote.html.md)
* [Debug Robot&Python scripts](red_help/user_guide/python_red_debug.html.md)
* [Debug Robot&Python scripts](red_help/user_guide/python_red_debug.html.md)
* [How to integrate RED with Robotframework Maven Plugin](red_help/user_guide/maven.html.md)
63 changes: 63 additions & 0 deletions changelog.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,49 @@
RED 0.7.1 - 2016/10/04
** Feature
* [RED-357] - [table] Ctr+z in Documentation works slow or does not allow to reenter anything
* [RED-368] - [table] ctrl+z in tables
* [RED-497] - github #37 - add info about lib reloading and reset robot env

** Enhancement
* [RED-92] - double click on item on Outline focus this item in respective editor
* [RED-261] - Validation for duplicated settings in Keyword and Test Case tables - compatibility with RF 2.9 - 3.0
* [RED-364] - [table] var tsv - nothing displayed when invalid vars are entered in source ${var}<space>text<tab>text2
* [RED-391] - product - set default preferences in product
* [RED-510] - Add actions to switch off editor linking and expand tree inside outline view
* [RED-518] - [github #41] investigate possibility to run tests in user-defined order

** Bug
* [RED-278] - Incorrect colors of text in editor for scripts with pipes
* [RED-341] - Include pythonpath and classpath from red.xml in Quick Fix
* [RED-395] - Errors in regression from dumping to source
* [RED-414] - Not aggregating errors in table view markers
* [RED-460] - In KW/TC table preference with s|s as separator is not take into account
* [RED-462] - [table] table issues to polish
* [RED-468] - [Test problem] Wrong amount of errors
* [RED-473] - Content assistant does not show keywords when one of BDD prefixes is used
* [RED-475] - Empty test case names are not reported
* [RED-494] - Adding possibility to collaps entire sections in Source
* [RED-503] - Different behviour of row operation in TC/KW table
* [RED-507] - Table Variable - new line with comment in source and editing empty list name
* [RED-514] - IllegalArgumentException when user click on Setting Documentation after editor open
* [RED-523] - Libraries Autodiscovering does not work with library alias
* [RED-526] - [table] Settings => Ctrl+z in Doc field and Settings undo by groups

** Sub-task
* [RED-410] - EditingDocumentation - exception while entering text
* [RED-411] - many errors
* [RED-422] - Coping button "..." in KW cause error
* [RED-426] - Sorting KW with the same name
* [RED-451] - Adding menu in KW and Source tab to open Documentation view
* [RED-458] - Wrong place after pasting cut row
* [RED-459] - No active row menu on new added line
* [RED-488] - Content Assist should be the same as in Source for writing variable
* [RED-490] - Disabling editing cell when content assit is on after setting focus by outline
* [RED-500] - Setting focus after collapsing/expanding items in table
* [RED-516] - [KW] kw is pasted at the end of whole table when pasting it on element inside other keyword
* [RED-517] - 'Settings first' order should be preserved inside keywords or test cases


RED 0.7.0 - 2016/07/14

** Feature
Expand Down Expand Up @@ -51,3 +97,20 @@ RED 0.7.0 - 2016/07/14
Disabling cells next to test case name
Removig second duplicated setting line


















62 changes: 33 additions & 29 deletions red_help/first_steps/create_run.html.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## Create Project, add test,run
## Create project, add test and run

In order to start working with RED & Eclipse, you need to set up couple of
things first. Robot Perspective Workspace & project Create TestSuite Content
assistant Running TestSuite Console and message log Execution status
In order to start working with RED & Eclipse, you should set RED perspective.
In this perspective you can add robot project and test suites/resource files.
You can add python files too with variables or library schema.

### Robot Perspective

All RED activities are performed within 2 perspectives: _Robot_ , _Debug_ .
All RED activities are performed within 2 perspectives: _Robot_, _Debug_.
Former one is used to construct and execute tests, later one is for debugging
test-cases. To start working with RED, you should activate Robot perspective
first.
Expand All @@ -18,60 +18,64 @@ first.

### Workspace & project

**Workspace** stores all global Eclipse & Red preferences, if not set previously (first run or workspace path is non valid) Eclipse will show dialog to set path. User can always switch workspaces, and if necessary, perform projects import from locations outside of current workspace. Switching Workspace is done by menu action: _File -> Switch Workspace ..._
**Workspace** stores all global Eclipse & Red preferences. If it not set previously, Eclipse will show dialog to set path. User can always switch workspaces, and if necessary, perform projects import from locations outside of current workspace. Switching Workspace is done by menu action: _File -> Switch Workspace ..._

**Project** is an equivalent to folder in OS, it stores files and settings relevant to a group of files. In order to work with RED, **Robot Project** has to be created.
Create new Project can be done by:
Creating new Project can be done by:

* _File->New-> Robot Project _(item can be found under selection _New -> Project .. -> Robot Framework -> Robot Project _)
* _File->New-> Robot Project _(item can be found also under selection _New -> Project .. -> Robot Framework -> Robot Project _)
* Right click menu on Project Explorer with selection as above

If you which to import anything into Workspace ( already existing Project) or
into Project (existing testcases), menu _Import ... _will open up wizard. Upon
creating Project, you should have see similar structure in Project Explorer
tree which will also indicate that RobotFramework is visible to Eclipse
![](create_run/simple_project_1.png)
If you wish to import anything into Workspace (i.e. already existing Project)
or into Project (existing test cases), menu _Import ... _will open up wizard.
Upon creating Project, you should have see similar structure in Project
Explorer tree, which will also indicate that RobotFramework is visible to
Eclipse. ![](create_run/simple_project_1.png)

### Create TestSuite

To create sample test you should invoke action: _File -> New -> Other ... ->
Robot Framework -> Robot Test Suite_. Same action can be accessed by right
click menu. RED consists of 2 different modes of editing, a Table (Ride-like
style) and Text style. By default Table editor is used when TestCase file is
opened. ![](create_run/editors_1.png) Additionally, Source tab shows text
representation of TestSuite: ![](create_run/editors_2.png)
click menu. RED consists of 2 different modes of editing: a Table (Ride-like
style) and Text style. Four first tabs in Test Suites are table views. Last
on is text view (source). By default Source editor is used when Test Suite
file is opened. ![](create_run/editors_1.png) Source view displays text
representation of all table views: ![](create_run/editors_2.png)

#### Content assistant

Just like other modern Developments Environments, RED supports content
assistance/code completion. When editing tab or item in text editor, press
CTRL+SPACE keys to activate hints for Keywords.
CTRL+SPACE keys to activate hints for robot keywords an variables.

### Running TestSuite

To run TestSuite, _Run_ button needs to be selected or right-click menu on
file can be issued. ![](create_run/toolbar-1.png)
file in Source view. The same action is in right-click menu on file in Project
Explorer ![](create_run/toolbar-1.png)

#### Limiting test cases to be run

To limit list of test cases to be run, open _Run Configurations ..._,
![](create_run/run_1.png) in Robot part you can specify which test cases
![](create_run/run_1.png) In Robot part you can specify which test cases
should be run by using either tags or include/exclude list of test cases in
active project. ![](create_run/run_configurations.png)
active project. ![](create_run/run_configurations.png) To run single test
case in test suite, you can select desire test case in Project Explorer and in
right-click menu select "Run".

#### Console and message log

During TestSuite execution, RED displays RobotFramework console and message
logs. Those information are available by view Console and Message Log, by
default visible in the Robot perspective or by _Window -> Show View ->
Other.... -> Robot_ ![](create_run/console_1.png) If any of those 2 views are
missing, best way is to reset perspective settings by using action _Window ->
Reset Perspective ..._
logs. Those information are available in Console and Message Log, by default
visible in the Robot perspective or by _Window -> Show View -> Other.... ->
Robot_ ![](create_run/console_1.png) If any of those 2 views are missing, best
way is to reset perspective settings by using action _Window -> Reset
Perspective ..._

#### Execution status

RED can show execution status of TestCases along with outcome result and
execution time. ![](create_run/exec_1.png) Execution View is not in default
Robot perspective thus it needs to be manually added.
Visit _Window-> Show View -> Robot -> Execution View_
execution time. This view is in Robot perspective by default.
![](create_run/exec_1.png)
To open Execution go to: _Window-> Show View -> Robot -> Execution View_

10 changes: 5 additions & 5 deletions red_help/first_steps/debug.html.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Debug

Debug functionality is unique way of checking what is happening during
TestCase and TestSuite execution.It works similiary as debug functionality in
TestCase and TestSuite execution. It works similar as debug functionality in
most of programming languages - it allows track execution of program for
checking unwanted behaviour either on TestCase side or in tested software. It
is important to note that Debug functionality works only with text editor
Expand All @@ -20,7 +20,7 @@ follows: ![](debug/debug_2.png) First thing with working with Debug is to
place at least one breakpoint. This allows RED to pause Debug execution and
activate Stepping options.
To place breakpoint in Source view click on line in script and under right
click menu choose Add breakpoint. You can also add breakpoint directly by
click menu choose _Add breakpoint_. You can also add breakpoint directly by
clicking on line number in Source editor view.
When successful, blue ball icon will appear next to it, new breakpoint entry
will be visible in Breakpoint lists.
Expand All @@ -40,10 +40,10 @@ Configurations... _from Debug button: ![](debug/debug_4.png)

#### Breakpoints and execution stepping

Breakpoints are essential item, each pause execution and allows to initiate
Breakpoints are essential items, each pauses execution and allows to initiate
Debug actions.
When breakpoint line is activated during execution, following icons are
active: ![](debug/debug_5.png) moving from left to right:
active: ![](debug/debug_5.png) Moving from left to right:

* Blue circle - Skip All Breakpoints - allow to continue testcase execution onwards without stopping on defined breakpoints
* Green Play - Resume - resumes test execution
Expand All @@ -55,7 +55,7 @@ active: ![](debug/debug_5.png) moving from left to right:
* Step Return - F7 key - allows to return to main TestCase execution from embedded TestCase or Keyword if Step Into was used before

List of breakpoints can be seen in upper right side of the Debug perspective.
![](debug/break_1.png)
![](debug/break_1.png) Breakpoints actions:

* each breakpoint can be enabled/disabled
* each breakpoint can be removed
Expand Down
38 changes: 22 additions & 16 deletions red_help/first_steps/download_install.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ RED is compatible with any Oracle Java newer than 1.7 . Java official website:

### Get Eclipse

Currently RED is tested with Eclipse Luna ( v4.4.x ) release although RED is
compatible with Eclipse Luna,Mars and Neon.
Currently RED is tested with Eclipse Luna (v4.4.x) release although RED is
compatible with Eclipse Luna, Mars and Neon.
Official Eclipse website: [ Eclipse.org](https://www.eclipse.org/)

### Get RED

RED feature can be downloaded from
[github.com/nokia/RED](https://github.com/nokia/RED) RED feature is a file
[github.com/nokia/RED](https://github.com/nokia/RED). RED feature is a file
with zip extension. RED Product is RED bounded with Eclipse platform.

### Get Python & RobotFramework
Expand All @@ -24,25 +24,31 @@ be installed with respectful dependencies (currently Python 2.7.x is supported
by RobotFramework).
Python official site: [www.python.org](http://www.python.org)
RobotFramework official site: [robotframework.org](http://robotframework.org/)
We recommend to install Python packages using pip
**Note: in some cases like using portable Python&amp;RF;, there may be a need to run Eclipse and pybot with administrative privileges**
We recommend to install Python packages using pip.
**Note: in some cases like using portable Python&amp;RF;, there may be a need to run Eclipse and pybot with administrative privileges.**

### Install RED into Eclipse

#### Install from Eclipse Marketplace

Start Eclipse, open Help -> Eclipse Marketplace Search for "RED Robot Editor"
Install preferred version accepting license Restart Eclipse to apply changes
* Start Eclipse, open Help -> Eclipse Marketplace
* Search for "RED Robot Editor"
* Install preferred version accepting license
* Restart Eclipse to apply changes

#### Install from zip file

Start Eclipse, accept default Workspace folder placement
Open _Help -> Install New Software_
Click _Add -> Archive_ and select RED zip feature (eg.
org.robotframework.ide.eclipse.feature_1.0.0.201507130728.zip )
Tick all boxes in Robot Framework IDE Category and apply Next
Accept all prompts and user licences, proceed with installation process
Restart Eclipse as prompted
Verify RED installation by opening _Help -> Installation Details_ to check if
RED is visible on installed features list
* Start Eclipse, accept default Workspace folder placement

* Open _Help -> Install New Software_

* Click _Add -> Archive_ and select RED zip feature (eg. org.robotframework.ide.eclipse.feature_1.0.0.201507130728.zip)

* Tick all boxes in Robot Framework IDE Category and apply Next

* Accept all prompts and user licences, proceed with installation process

* Restart Eclipse as prompted

* Verify RED installation by opening _Help -> Installation Details_ to check if RED is visible on installed features list

8 changes: 4 additions & 4 deletions red_help/first_steps/preferences_misc.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

This page is intended to help users in following cases:

* set custom Python & Robot instance in multiple Python environment for workspace or project wide usage
* include external resource files to be seen in content assistance and validation
* set custom Python & Robot instance in multiple Python environment for workspace or project wide usage;
* include external resource files to be seen in content assistance and validation.

### Preferences

Editor preferences are stored together with other Eclipse settings, all of
them are shared across **active workspace**.
Preferences can be found in toolbar menu _Window -> Preferences -> Robot
Framework _
Framework_.
One of the most important item in multiple python environment is setting
active Python and RobotFramework instances to be used for running and
debugging.
Expand All @@ -34,7 +34,7 @@ RED

![](preferences_misc/project_external_libs.png)

**In current releases there is no transparent and discovery mechanism of including variables and libraries files automaticly** to red.xml file so user action is required any time when new external library and variable file is included in settings of testcase file.
**In current releases there is no transparent and discovery mechanism of including variables and libraries files automaticly** to red.xml file. For now user action is required any time when new external library and variable file is included in settings of testcase file.

Red.xml file opened with RED Project Editor should look like follows:

Expand Down
15 changes: 12 additions & 3 deletions red_help/user_guide/libs.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,14 @@ red.xml
All changes are stored in red.xml, if you need to modify them, open red.xml
using Eclipse Default Editor.

### Using libspec file when external library is not present locally
### Using libdoc file when external library is not present locally

In some scenarios, testware edit happens on different host than test runtime
thus it is undesirable/unnecessary to install/import all libraries as on
remote host. RobotFramework provides possibility to generate an xml file with
list of keywords, this also provides agile test development where libraries
are developed in parallel to test cases.
Libspec file can be included instead of link to external library by using
Libdoc file can be included instead of link to external library by using
red.xml editor.

For more information about LibDoc please refer to <http://robot-
Expand All @@ -84,5 +84,14 @@ execution:
This indicates that some of the dependencies are missing on your local machine
which may affect testcase execution. To verify you can try to execute libdoc
in console:
_python -m robot.libdoc &amp;ltPATH;_TO_LIBNAME&gt; list
_python -m robot.libdoc &amp;ltPATH;_TO_LIBNAME&gt; list _

### Reloading libraries after change

Whenever external library is changed (for instance new keyword is added),
libdoc needs to be regenerated to provide changes on content assist and
validation in RED. This can be done by right click on project name and
selecting _Robot Framework -&gt; Reset Robot Enviroment_.
For reloading selected libdoc, right click on library from Project Explorer
and use _Reload action_.

Loading

0 comments on commit 62d42e1

Please sign in to comment.