Creating your first ta project
Creating the project folder
The easiest way to do this is using Lapis_Lazuli's build in
create function. This will create all needed folders and files to get started. If you like, you could also do this manually.
- Create a folder where you want to group your projects
- For example:
- For example:
- Open CMD
- Navigate to the folder by typing
lapis_lazuli create <projectname>
- Where <projectname> is the name of your project without `<>`
Running the project for the first time
The project created by Lazis Lazuli has some basic scripts. To confirm it's working properly, let's run it!
Continue from where we left off in the CMD:
- First we are going to install another gem
gem install bundler
- After the installation is complete, go to the directory of your project
- Then write
bundle install, this will automatically download all the required gems that you need for this project.
- Again, wait for the installation to be complete.
- Finally, to execute the project, write
bundle exec cucumber
You should see a browser pop-up after a few seconds that automatically clicks through some pages. Once it's finished you should see something like this in CMD:
16 scenarios (4 failed, 2 pending, 10 passed) 49 steps (4 failed, 10 skipped, 2 pending, 33 passed) 0m31.978s
Open a project
There are many text editors (free and paid) you could use to open the files. We recommend that you use VS Code.
There are also other programs to support the complete view of a project, like Atom that will improve the usability by making it easy to navigate between files and make the code more readable. Feel free to have a search and find your own favorite editor.
Next up is Exploring your first cucumber project
About Bundle gem
The purpose of using the Bundle gem is to make life easier. Bundle will help us to automatically install all required gems. And on top of that it's smart enough to know the dependencies between gems.
Basically Bundler will look in your
Gemfile what is defined there and download all corresponding information. More info about gemfiles.
If a new version of Lapis Lazuli came out (see Rubygems), you can update your existing project by doing the following:
Gemfile.lockfrom your project folder.
- Open CMD, navigate to the project folder and write
Done! Simply use
bundle exec cucumber to run your project on the latest version.
It is possible to run without Bundler by just writing
cucumber. But this might result in unexpected errors that about missing Gems and/or because of using wrong Gem versions.
Detailed information about every folder
01.─┬/config/ 02. ├─> config.yml 03. └─> cucumber.yml 04.─┬/features/ 05. ├─┬/step_definitions/ 06. │ ├─> interaction_steps.rb 07. │ └─> validation_steps.rb 08. ├─┬/support/ 09. │ ├─> env.rb 10. | └─> functions.rb 11. ├─> 1_basic.feature 12. └─> 2_account.feature 13. └─> 3_todo_list.feature 14.──/log/ 15.──/results/ 16.──/sceenshots/
- 01. /config/
- This folder contains configuration information about your project. Some handy things you can do here is write credentials that will later be re-used throughout your whole automation project.
- 04. /features/
- This is the core of your project. It contains the test cases, the code executed in the steps of your test cases and any other code you wish to write for your solution.
- 05. step_definitions
- This folder contains the definitions of the steps you've described in your feature files. Any file ending with "_steps.rb" will be included in the execution. So you can create the files however you feel it will be most organized.
- 11. 1_basic.feature
- This file contains your test cases, split up in Features which contain Scenario's which Contains Steps.
- More information about writing Feature files can be found in Writing_gherkin_test_cases_in_cucumber
- 08. /support/
- This folder contains files that supports writing steps or the execution.
- Env.rb does things like setting up a profile before a browser is opened.
- Functions.rb can be used to place methods you're using often.
- 14. /log/
- This will contain logging information after each test you have executed
- 15. /results/
- Can be used to export results of you test run to
- 16. /screenshots/
- Any screenshot taken by your scripts will be stored in this folder.
Information about setting up your text editor
If you choose not to use a simple text editor like "Notepad", you sometimes need to setup the software to recognize the programming language we're using in this tutorial. Inside the text editor we need to download various plugins (also called add-ons or something similar) if they're not ready installed. In this tutorial we make use of "Ruby", "Cucumber", "Selenium" and "Gherkin". When these plugins are installed the text editor recognizes the code and if you make by mistake a typo the editor shows it. Some editors also help you write code by showing you the options you can choose from and extra information about the functions or methods you're using.