Add 10-minute-tutorial for Java #101

mlvandijk · 2018-01-06T07:25:39Z

Add a 10-minute-tutorial for Java, with Maven, JUnit and IntelliJ.

A preview is available on Netlify.

Note: This PR does not include tutorials on JavaScript & Ruby.
Those can be added once this is reviewed & merged.

mpkorstanje · 2018-01-06T16:34:24Z

content/10-minute-tutorial.md

+- An IDE editor, for example [IntelliJ IDEA](https://www.jetbrains.com/idea/?fromMenu#chooseYourEdition) (which will be used in this
+  introduction)
+
+- A Cucumber plugin for your IDE, for example [IntelliJ IDEA Cucumber for Java plugin](https://plugins.jetbrains.com/plugin/7212-cucumber-for-java) to go with IntelliJ IDEA


Has this been fixed yet to work with cucumber-jvm 2?

It hasn't. I see now.

Should we mention anything about that?

The IDE plugin is presumably optional? Maybe a link to working with Cucumber outside of the IDE?

Actually, not sure the plugin is optional with IntelliJ: https://www.jetbrains.com/help/idea/cucumber.html so I'm going to leave it.

Eclipse one works great and is available in the marketplace, in case you want to mention it.

@Flaburgan IntelliJ works fine otherwise, maybe when adding a tutorial with Eclipse. Thanks!

mpkorstanje · 2018-01-06T16:34:50Z

content/10-minute-tutorial.md

+
+- [Cucumber-JVM](https://github.com/cucumber/cucumber-jvm) (which we will add as a dependency to our project)
+
+- [JUnit 4](http://junit.org/junit4/) (which we will also add as a dependency to our project)


So not needed to get started. :)

Yeah, I'll remove them here :)

mpkorstanje · 2018-01-06T16:39:34Z

content/10-minute-tutorial.md

+2. Select **Run 'Feature: tutorial'** from the context menu.
+
+{{% note "Formatter error"%}}
+If you are using Cucumber v2.0.0 or higher, when running the test for the first time you might get an error message that mentions `CucumberJvmSMFormatterUtil`.


If you are using Cucumber v2.0.0 or higher can be removed we are using 2.0.0. You've specified that in the tutorial.

Good point. Will update

mpkorstanje · 2018-01-06T20:58:29Z

content/10-minute-tutorial.md

+
+{{% note "Specify glue location"%}}
+You might need to tell Cucumber where to find your `StepDefinitions.java` file (i.e. the 'glue' between your Gherkin and your programming code).
+If so, open your **Run Configurations** and add the name of your `<project>` directory in the **Glue** field.


You describe a problem but not what the symptoms are.

mlvandijk · 2018-01-08T09:24:30Z

Discussed with @mpkorstanje - as IntelliJ currently not working properly with Cucumber v2.x; I'll update this tutorial to describe running with a Cucumber runner (and move the running from InteliJ to running page)

plaindocs

Some comments throughout, but this is good stuff!

plaindocs · 2018-01-10T11:20:20Z

content/10-minute-tutorial.md

+- An IDE editor, for example [IntelliJ IDEA](https://www.jetbrains.com/idea/?fromMenu#chooseYourEdition) (which will be used in this
+  introduction)
+
+- A Cucumber plugin for your IDE, for example [IntelliJ IDEA Cucumber for Java plugin](https://plugins.jetbrains.com/plugin/7212-cucumber-for-java) to go with IntelliJ IDEA


The IDE plugin is presumably optional? Maybe a link to working with Cucumber outside of the IDE?

plaindocs · 2018-01-10T11:20:56Z

content/10-minute-tutorial.md

+
+3. Make sure that the Project SDK is selected (for instance, Java 1.8) and click **Next**
+
+4. Specify a **GroupId** and **ArtifactId** for your project and click **Next**


Should we tell people what these are for? Or do we assume they already know because they are setting up a Java project?

Ad 3. Unfortunately cannot test what happens exactly as I have Java set up, so cannot describe in detail here. But I've helped coworkers who did not... and you run into interesting problems (stuff not getting recognized mainly)
Ad 4. If you don't, you cannot create the project.

For this tutorial, I'm going to assume they know why OR will just follow the steps (I only mention 3 because I've seen this lead to problems). Let me know if you disagree!

plaindocs · 2018-01-10T11:22:15Z

content/10-minute-tutorial.md

+
+# Specifying Expected Behaviour
+
+We specify the expected behaviour by defining features and scenarios.


link these?

plaindocs · 2018-01-10T11:23:03Z

content/10-minute-tutorial.md

+
+We need to create this directory, as it was not created for us. In IntelliJ:
+
+1. Right click on the Test folder, select **New > Directory** and name this directory `resources`.


I'd probably skip telling people how to create a dir, and just tell them how to mark it as Test Resources Root

plaindocs · 2018-01-10T11:23:49Z

content/10-minute-tutorial.md

+
+2. Right click the folder and select **Mark directory as > Test Resources Root**.
+
+3. You can add subdirectories as needed. Create a subdirectory for your project in `src/test/resources/`


Isn't this whole thing our project?

plaindocs · 2018-01-10T11:28:16Z

content/10-minute-tutorial.md

+}
+
+
+Process finished with exit code 0


Myabe add a little explanation. here of the step implementations shown? Or just a bit of flow text that takes us into the next section.

plaindocs · 2018-01-10T11:28:32Z

content/10-minute-tutorial.md

+Process finished with exit code 0
+```
+
+## Snippets for Missing Steps


Writing Snippets for Missing Steps?

plaindocs · 2018-01-10T11:29:10Z

content/10-minute-tutorial.md

+
+To add them to a Java class in IntelliJ:
+
+1. Navigate to the `src/test/java/<project>` folder and right-click it to display the context menu


Probably condense these steps as well

plaindocs · 2018-01-10T11:31:02Z

content/10-minute-tutorial.md

+Once you have implemented all your step definitions (and the expected behaviour in your application!) and the test passes, the summary of your results should look something like this:
+
+```
+Tests run: 5, Failures: 0, Errors: 0, Skipped: 4, Time elapsed: 0.656 sec


why are they skipped?

Copy-paste error. thanks!

plaindocs · 2018-01-10T11:31:55Z

content/10-minute-tutorial.md

+```
+
+# Examples
+If you prefer to get started with a working project, try the skeleton project [which is available from GitHub](https://github.com/cucumber/cucumber-java-skeleton).


I'd link "skeleton project" not "available on GitHub"

And by this stage, asking them if they prefer something else feels odd. Maybe "If you'd like to test out a working example, try...

mlvandijk · 2018-01-11T10:43:13Z

Thanks @plaindocs for the excellent feedback. Think this is ready to (squash! and) merge now...

mlvandijk · 2018-01-14T15:01:40Z

Thanks @plaindocs !

plaindocs · 2018-01-14T15:05:19Z

My pleasure!

mlvandijk added 10 commits January 3, 2018 21:32

Getting started with 10-minute-tutorial

f73a64a

First draft of 10-minute-tutorial for java

f82054b

Fix headers

b7e505c

Update example

1c597fd

Edit after proofreading

1fcdbdb

Edit after proofreading

43455e9

Remove irrelevant notes

53eb888

Add file structure visual

999a9f3

Add numbered and bullit lists

eb38e2b

Final draft

8b50bf8

mlvandijk requested review from tsundberg and mpkorstanje January 6, 2018 07:25

mpkorstanje reviewed Jan 6, 2018

View reviewed changes

Update based on review

fdd855f

mlvandijk requested a review from plaindocs January 6, 2018 18:53

Add info on providing glue location

99c0133

mpkorstanje reviewed Jan 6, 2018

View reviewed changes

Update after review

1c0a0d7

mlvandijk added 2 commits January 8, 2018 22:01

Add JUnit Runner

224b169

Remove running from IntelliJ

a42973a

plaindocs requested changes Jan 10, 2018

View reviewed changes

mlvandijk added 2 commits January 11, 2018 11:38

Update after review

e445d9b

Update after review

1dba12d

This was referenced Jan 11, 2018

Add 10-minute tutorial for Javascript #103

Closed

Add 10-minute tutorial for Ruby #104

Closed

Remove old tutorial

a5b94c5

plaindocs approved these changes Jan 14, 2018

View reviewed changes

plaindocs merged commit eba923e into master Jan 14, 2018

plaindocs deleted the tutorial branch January 14, 2018 14:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add 10-minute-tutorial for Java #101

Add 10-minute-tutorial for Java #101

mlvandijk commented Jan 6, 2018 •

edited

Loading

mpkorstanje Jan 6, 2018

mpkorstanje Jan 6, 2018

mlvandijk Jan 6, 2018

plaindocs Jan 10, 2018

mlvandijk Jan 11, 2018 •

edited

Loading

Flaburgan Jan 11, 2018

mlvandijk Jan 11, 2018

mpkorstanje Jan 6, 2018

mlvandijk Jan 6, 2018

mpkorstanje Jan 6, 2018

mlvandijk Jan 6, 2018

mpkorstanje Jan 6, 2018

mlvandijk commented Jan 8, 2018 •

edited

Loading

plaindocs left a comment

plaindocs Jan 10, 2018

plaindocs Jan 10, 2018

mlvandijk Jan 11, 2018 •

edited

Loading

plaindocs Jan 10, 2018

plaindocs Jan 10, 2018

plaindocs Jan 10, 2018

plaindocs Jan 10, 2018

mlvandijk Jan 12, 2018

plaindocs Jan 10, 2018

plaindocs Jan 10, 2018

plaindocs Jan 10, 2018

mlvandijk Jan 11, 2018

plaindocs Jan 10, 2018

plaindocs Jan 10, 2018

mlvandijk commented Jan 11, 2018

mlvandijk commented Jan 14, 2018

plaindocs commented Jan 14, 2018


		- [Cucumber-JVM](https://github.com/cucumber/cucumber-jvm) (which we will add as a dependency to our project)

		- [JUnit 4](http://junit.org/junit4/) (which we will also add as a dependency to our project)


		3. Make sure that the Project SDK is selected (for instance, Java 1.8) and click Next

		4. Specify a GroupId and ArtifactId for your project and click Next


		# Specifying Expected Behaviour

		We specify the expected behaviour by defining features and scenarios.


		We need to create this directory, as it was not created for us. In IntelliJ:

		1. Right click on the Test folder, select New > Directory and name this directory `resources`.


		2. Right click the folder and select Mark directory as > Test Resources Root.

		3. You can add subdirectories as needed. Create a subdirectory for your project in `src/test/resources/`


		To add them to a Java class in IntelliJ:

		1. Navigate to the `src/test/java/<project>` folder and right-click it to display the context menu

Add 10-minute-tutorial for Java #101

Add 10-minute-tutorial for Java #101

Conversation

mlvandijk commented Jan 6, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mlvandijk Jan 11, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mlvandijk commented Jan 8, 2018 • edited Loading

plaindocs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mlvandijk Jan 11, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mlvandijk commented Jan 11, 2018

mlvandijk commented Jan 14, 2018

plaindocs commented Jan 14, 2018

mlvandijk commented Jan 6, 2018 •

edited

Loading

mlvandijk Jan 11, 2018 •

edited

Loading

mlvandijk commented Jan 8, 2018 •

edited

Loading

mlvandijk Jan 11, 2018 •

edited

Loading