Robot Plugin

Compatible with: IntelliJ IDEA Android Studio
14.02.2015
13 946

The Robot Plugin provides integration with Robot Framework Test Case Files (http://www.robotframework.org). This plugin provides integration with Robot keywords implemented in Java that are in the same IntelliJ project as your Robot test case files. This plugin also provides many features supporting coding in the Robot Framework that are useful whether or not you use Java.

Features include:
  • Syntax highlighting
  • Rename refactoring for Robot Keywords, whether defined in Java or Robot files.
  • Structure View support for Robot files
  • Invalid Robot syntax is underlined in red, so you can catch errors before committing your code.
  • Go to declaration of a Keyword from the point of use. Jump to Java or Robot file Keyword definition.
  • Find usages of Keywords defined in Java or Robot files
  • Autocomplete Keywords and Test Case tags
  • Autocomplete Variables that are in scope
  • Find Robot Keywords and Test Cases by symbol name (ctrl+shift+alt+n) or (cmd+shift+alt+n) for Mac
  • Go to Resource file by ctrl+click resource setting.
  • Create a Robot Test Case file from a template
  • ...and much more
by Charles Capps, an engineer at Jive Software

Download plugin

Recent change notes

Version 1.7.1 (2/13/2015)
  • Just fix a minor bug where if you used a Robot timeout value in another context, it could be considered an error. For example, if you used "None" or "5h 3minutes" as an argument to Test Setup.
Version 1.7.0
  • Underline in red any Java Robot Keyword in a class that isn't annotated with @RobotKeywords.
  • Underline in red any Java Robot Keyword that isn't public.
  • Underline in red any Java class annotated with @RobotKeywords that isn't public.
  • Don't resolve references or find usages of Java robot keywords that aren't public or aren't in a class annotated with @RobotKeywords.
Version 1.6.5
  • Added a Robot Settings page under Project settings.
  • Added a Robot setting to only autocomplete/resolve keywords that are in scope (off by default).
  • Fix a bug where arguments to Library setting constructor is considered invalid syntax.
  • Fix a bug where in certain situations keywords could resolve to the same java method twice.
Version 1.6.3
  • Minor hotfix for a bug with resolving references to Java methods with underscores.
Version 1.6.2
  • Multi-resolve keywords when there are multiple keywords with the same name.
  • Fix regex for test timeout values to be correct for all possible Robot time formats.
Version 1.6.1
  • Can now find usages of Robot Keywords in text, e.g. in strings that are arguments to Keywords.
  • Can now go to definition of Keyword from a usage in text.
  • Parse all settings correctly, e.g. the Variables setting takes a relative file as its argument.
  • If you have the "Highlight invalid Robot keywords?" setting enabled in Editor settings, then now invalid settings in the ***Settings*** table will be underlined in red.
Version 1.6.0
  • Keywords with "Embedded arguments" are now handled correctly for resolving references, finding usages, etc.
  • You can now resolve a variable that is embedded in text to the its definition.
  • Java methods annotated with @RobotKeyword are now implicitly considered used if they are used in any Robot file.
  • There is an option under "Editor | Error Highlighting" to highlight invalid Robot keywords in red.
  • The above option is OFF by default, in case users have Robot Keywords imported from sources this plugin can't detect.
Version 1.5.3
  • Made two improvements that were filed on Github
  • Keywords with "embedded arguments" can now be resolved at the point of use, and find usages works.
  • Any String argument to a Keyword can resolve to a file in a resources folder, if it refers to a valid file.
  • You can now ctrl+click the Library Java class in a Settings table
  • You can now resolve references to variables embedded in text, e.g. in the keyword execution "Log My text ${foo} and ${bar}", can now resolve ${foo} and ${bar} correctly.
Version 1.5.2
  • Fixed issue filed on github where Java methods that use underscores, e.g. "foo_java_keyword()" should autocomplete in Robot as "Foo Java Keyword".
  • Also fixed so that finding usages of Java methods correctly removes underscores before searching the normalized index for Robot Keywords, so now it works to find usages of java methods with underscores.
Version 1.5.1
  • Fixed issue filed on github where you should be able to have the [Arguments] for a Keyword on the same line as the title of the keyword.
  • Generally fixed all cases where you should be able to have any line of the Keyword code after the title.
Version 1.5.0
  • Fixed autocomplete Robot Keywords so it works with substrings, not just prefixes.
  • Fixed autocomplete Robot Variables, so it works if you already included the closing curly brace '}'
  • Fixed a bug where searching for 2 Test Cases with the same name in different file only returned 1 of the 2 Test Cases
Version 1.4.9
  • Better error handling than previous version. If the RobotKeyword class isn't on the classpath, shouldn't prevent autocomplete from working for keywords in Robot files.
Version 1.4.8
  • Enable autocomplete for Java Robot Keywords from Java class files, even if you don't have sources attached.
Version 1.4.7
  • Enable autocomplete for Java Robot Keywords in project dependencies.
Version 1.4.6
  • Added an index for Test Cases, so that searching for test case by name is much faster. I found this could be slow for large projects. You may need to invalidate you cache and restart Intellij after getting this update.
Version 1.4.5
  • Added support for Rename refactoring for Robot Files. Any Resource Setting that includes a Robot File will be renamed when the file is renamed.
Version 1.4.4
  • Quick fix for bug with renaming Robot files.
Version 1.4.3
  • Rewrite parser BNF file, so that it handles errors more gracefully with the "recoverWhile" syntax.
  • Simplify AST as much as possible to improve performance.
  • Fix resolving a variable reference to a variable in a FOR loop bound.
Version 1.4.2
  • Fix error handling so that the rest of the file parses correctly when there's a syntax error.
  • Tokenize array variable element access (e.g. @{foo}[0]) with a special token so that we can highlight it like a variable.
Version 1.4.1
  • Fix bug with "FOR IN" loops.
Version 1.4.0
  • Rename refactoring for variables -- local variables and variables defined in Variables tables.
  • Find usages of variables.
  • Fix how variable scope is determined; a variable won't resolve to an assignment on a subsequent line of code.
Version 1.3.2
  • Bugfixes-- fixed a stack overflow if you included the current file as a Resource, or there was a loop in Resource file inclusions.
  • Fixed issue where you couldn't go to declaration of a variable if there was no "=" sign.
  • Fixed issue where you couldn't go to declaration of a variable if it was defined as the empty string and was defined in a variables table.
Version 1.3.1
  • Added go-to definition for Variables. Can ctrl+click a variable to go to its definition. Works wherever the variable was defined: local variable, Variables table, or included Resource file.
  • Fixed a small bug with Resource file resolving, where the wrong variable would be substituted in the resource file path if the same variable name was included from a resource file and existed in the variables table.
Version 1.3.0
  • Added variable autocomplete for variables in scope, including those from included Resource files
  • Ctrl+Click included resource file from Resource setting to go directly to file.
  • Any text before the first Robot Table is now interpreted as a Comment, since that's how Robot works.
  • Several minor parsing improvements.
Version 1.2.3
  • Fixed Keywords syntax parsing so that [return] can be called multiple times.
  • Fixed parsing bug with assigning multiple variables to a keyword on one line.
  • Fixed several minor parsing bugs and added unit tests so they won't regress.
  • Fixed minor bug with autocomplete.
Version 1.2.2
  • Added support for parsing FOR IN RANGE, and FOR IN loops in the Robot language.
  • Fixed parsing of several edge cases, such as how Robot variables can have numbers for their name, and Settings can have spaces in-between letters and are case-insensitive.
  • Added Unit tests to improve code quality and be sure many use cases are parsing correctly.
Version 1.2.1
  • Greatly improved autocomplete performance, and performance throughout the plugin.
  • Created PsiStub indexes for RobotKeywordDef class to speed up all lookups of Robot keyword definitions in Robot files.
  • Also sped up lookups of Java Robot keywords by directly using the Annotation stub index.
  • Fix minor parsing bug, where an argument to a Keyword Definition couldn't be an array type, e.g. @{myVar}.
Version 1.2.0
  • Added line continuation support with the ellipsees (...) syntax used by Robot
  • Made parsing far more accurate, including the characters allowed in various contexts, etc.
  • Fixed a regression with rename refactoring not working for Robot-defined keywords with a space in the name.
Version 1.1.9
  • Fixed minor bug with structure view always displaying the expand arrow for leaf elements.
  • Added icons for structure view and autocomplete.
  • Fixed autocomplete bug with Keywords not completing if you've typed more than 1 word.
  • Improved autocomplete to display the arguments of the Java keyword / Robot keyword. (May need to see if this negatively affects performance for large projects since all Java keywords are in scope. May need to only autocomplete the Robot keywords that are in scope, since this is something we can determine easily.)
Version 1.1.8
  • Fix to add back case-insensitivity of finding the Java Keyword definition from a Keyword usage that was broken with performance improvements in version 1.1.6 and 1.1.7 improvements.
Version 1.1.7
  • Make parsing the settings table more lenient, since you can have spaces at the start of a line. Produce fewer Bad syntax tokens, because this may cause performance issues when there's a large text file with invalid robot syntex in the project. Invalid syntax will be handled at the parser layer.
Version 1.1.6
  • Performance improvements - use the Java Stub Index to search for methods when we're searching by the exact name. Use the word index when searching for Robot keyword definitions in Robot files. Found one case where unnecessary work may have been done. This should improve performance for large projects that have many Robot files. Next improvement would be to implement a StubTree and StubIndex.
Version 1.1.5
  • Fix a regression--accidentally compiled on Linux with Java 1.7 targeting Java 1.6, which makes it not work on Mac with IntelliJ Ultimate edition. Jetbrains--please fix this if possible?
Version 1.1.4
  • Add support for Rename Refactoring! You can rename Keywords defined in Java or Robot and the change will propagate to all usages of the Keyword!
  • Fix bug with Autocomplete listing duplicate entries, and improved autocomplete.
  • Implemented Structure View to list all Test Cases and Keyword definitions in a Robot file.
Version 1.1.3
  • Fix a regression where the plugin didn't work in Ultimate edition.
Version 1.1.2
  • Added the ability to find Test Cases with Go To Symbol, i.e. with the hotkey Ctrl+shift+alt+n.
Version 1.1.1
  • Fixed a bug with tag auto-completion from version 1.1.0.
Version 1.1.0
  • Added full syntax error highlighting support! The Robot language is now fully parsed!
  • Common Robot errors will be caught before runtime, such as assigning a variable to a String instead of a Keyword.
  • Fixed a minor bug where Autocomplete would suggest lowercase Java methods.
  • Fixed a minor bug where Autocomplete suggestions would not have spaces between words where appropriate.
Version 1.0.6
  • Added templates so you can create a Robot Test Case File or Robot Keywords File from the New menu in the project explorer.
  • Explicitly declaring dependencies on "lang" and "java" modules.
  • Hoping above change will cause this plugin to be suggested when you open a Robot file and it says "Plugins supporting files with *.robot extension are found".
Version 1.0.5
  • Fixed a major bug that apparently was causing many features to not work for Mac, because Robot files were never indexed. In Ubuntu, I didn't notice any problems. The RobotKeywordUsagesProvider has to return a new WordsScanner each time getWordsScanner() is invoked, unless the given scanner is thread-safe.
  • Yay, no more error messages in the event log!
  • Added the .iml file to git, so it's easier to start working on the project.
Version 1.0.4
  • Fixed a bug where keywords defined within Robot would appear twice in autocomplete.
Version 1.0.3
  • You can find usages of Java-defined Robot Keywords. It will find all usages in Robot files + Java
  • (Hopefully) fixed a bug where not all tokens were parsed in a Robot file by the words scanner for indexing.
  • Added plugin JAR to the bin folder for easy download if you don't want to setup your environment for plugin development and compile it.
Version 1.0.2
  • You can find usages of Robot keywords defined in Robot files.
  • Autocomplete works to suggest Robot keywords as you type---and it includes robot keywords from Java methods or Robot files
  • Reworked how searching is done in RobotKeywordDefinitionFinder. Searches by the method name against the word index when possible. When not possible, searches by the term "RobotKeyword" in java files, since we're are only dealing with robot keywords defined in Java with the @RobotKeyword annotation.
  • Autocomplete robot tags as well.
Version 1.0.1
  • Added ability to go to definition of a Robot keyword that's defined in Java or a robot file.
  • Fixed some bugs in tokenizing. Robot keyword definitions are now parsed separately from robot keywords.
  • Refactored to use a BNF file and generate the parser automatically. Trivial language at the moment, don't require much of a tree.
  • Improved performance by only searching for java keywords in the current module.

General usage instructions

The Robot Plugin for Java adds general language features such as syntax highlighting, Find Usages (from Java-defined keywords or Robot-defined keywords) and Go to Declaration.