Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Install and Setup JavaSDK and Cucumber (Windows): Difference between revisions

From KKM-STUDIO-WIKI
 
(49 intermediate revisions by the same user not shown)
Line 1: Line 1:
The tutorial on this page is <span style="color: rgb(224, 62, 45);" >'''only'''</span> applicable to the '''WINDOWS '''operating system, other operating systems have not yet been verified.
'''READ ME FIRST'''
 
*This tutorial applies to the '''Windows '''operating system, you can also check '''[https://kkmstudio.dk/mediawiki/index.php?title=Install_and_Setup_JavaSDK_and_Cucumber_(MacOS) MacOS]''' tutorial.<br>
*This tutorial is based on this file (Programming Exercises Course 02161 Week 1 written by Hubert Baumeister in January 2022) to make additions and changes.
*Contact Shuokai Ma ([mailto:s214919@student.dtu.dk s214919@student.dtu.dk]) if you find a problem or have suggestions for this Wiki.
= Download and Install JavaSDK =
= Download and Install JavaSDK =
== Download JavaSDK ==
== Download JavaSDK ==
Go to the [https://www.oracle.com/java/technologies/downloads/ JavaSDK Download Page]. Based on your OS, download the following file (Java 19 recommended):
Go to the [https://www.oracle.com/java/technologies/downloads/ JavaSDK Download Page]. Based on your OS, download the following file (Java 21 recommended):


Windows: x64 Installer
Windows: x64 Installer
Line 13: Line 15:


== Verify JavaSDK (Optional) ==
== Verify JavaSDK (Optional) ==
You can verify your JavaSDK using the terminal command.
You should now find your JavaSDK installation directory e.g. <code class="mwt-code">C:\Program Files\Java\jdk-21\bin</code> and copy that path.[[File:10.png|800px|center|thumb|JavaSDK Installation directory]]


<code class="mwt-code">java --version</code><br>
Now you should modify environment variables on Windows.
#On the Windows taskbar, '''right-click''' the '''Windows''' '''icon''' and select '''System'''.
#In the '''Settings''' window, under '''Related links''', click '''Advanced system settings'''.
#On the '''<span class="uicontrol bold">Advanced</span>&nbsp;'''tab, click '''<span class="bold">Environment Variables</span>'''.
#Choose '''Path''' under the '''system variables''' and then Click '''<span class="bold">Edit</span>&nbsp;'''to modify that environment variable.
#Click '''New''' and '''Paste''' that address (e.g. <code class="mwt-code">C:\Program Files\Java\jdk-21\bin</code>) on the textbox
#'''Move up''' that textbox to the '''top''' of the list.
#Click '''OK''' and then '''Apply''' to have the change take effect.


You should see the following content:[[File:02.png|300px|center|frame|Verify JavaSDK]]
[[File:11.png|500px|center|thumb|Environment Variables Dialog in Windows]]
 
You can now verify your JavaSDK using the terminal command <code class="mwt-code">java --version</code>. You should see the following content:[[File:02.png|1000px|center|thumb|Verify JavaSDK]]


= Download and Install IDE (Eclipse or IntelliJ) =
= Download and Install IDE (Eclipse or IntelliJ) =
The course will use Eclipse in its teaching material but all the things we do in the course can be done in IntelliJ too. You can download the latest version of [https://www.eclipse.org/downloads/ Eclipse] and [https://www.jetbrains.com/idea/download/#section=windows IntelliJ (Community Edition)] here.
The course will use Eclipse in its teaching material but all the things we do in the course can be done in IntelliJ too. You can download the latest version of [https://www.eclipse.org/downloads/ Eclipse] and [https://www.jetbrains.com/idea/download/#section=windows IntelliJ (Community Edition)] here. After that, you can follow the instructions of the installation wizard to install the IDE.


= Download and Install the Cucumber plugin =
= Download and Install the Cucumber plugin =
== Eclipse ==
== Eclipse ==
From the Eclipse marketplace (from inside the Help menu of Eclipse), download the "Cucumber" plugin.[[File:03.png|500px|center|thumb|Install Cucumber (Eclipse)]]
From the Eclipse '''marketplace''' (from '''inside the Help menu''' of Eclipse), download the "Cucumber" plugin.[[File:03.png|500px|center|thumb|Install Cucumber (Eclipse)]]


== IntelliJ ==
== IntelliJ ==
Line 33: Line 44:


= Download and Import the project "libaray01" to your IDE =
= Download and Import the project "libaray01" to your IDE =
You can download the zip file [https://www2.imm.dtu.dk/courses/02161/2021/files/library01.zip library01.zip] here. And then you should unpack the zip file first.
You can download the zip file [https://www2.imm.dtu.dk/courses/02161/2021/files/library01.zip library01.zip] here. And then you should '''unpack the zip file first'''.
== Eclipse ==
== Eclipse ==
You can now import the project into Eclipse by clicking '''File -&gt; Projects from Folder or Archive'''. And then you click the '''Directory''' and '''choose''' the file you unpacked from the zip file. Then you '''mark''' that project library01 and click '''Finish'''.[[File:05.png|500px|center|thumb|Import project (Eclipse)]]
You can now import the project into Eclipse by clicking '''File -&gt; Import -&gt; Maven -&gt; Existing Maven Projects.&nbsp; '''After clicking '''Next''', proceed to click '''Browse&nbsp;'''and '''select''' the file you unpacked from the zip file. Then, '''mark&nbsp;'''the project '''pom.xml''' and click '''Finish'''.[[File:05.png|500px|center|thumb|Import project (Eclipse)]]
 
== IntelliJ ==
== IntelliJ ==
You can now import the project into Eclipse by clicking '''Open''' and '''Choosing''' the file you unpacked from the zip file. Then '''click''' '''OK''' and '''Trust Project'''.[[File:06.png|500px|center|thumb|Import project (IntelliJ)]]
You can now import the project into IntelliJ by clicking '''Open''' and '''Choosing''' the file '''pom.xml''' you unpacked from the zip file. Then '''click''' '''OK''' and '''Open as Project'''.[[File:12.png|500px|center|thumb|Import project (IntelliJ)]]
 
Click now '''Load '''button. The&nbsp;Maven script will then be loaded and you can now wait for the project to be built.[[File:07.png|300px|center|thumb|Load Maven script]]


= Run the project in your IDE =
= Run the project in your IDE =
Line 45: Line 55:
Find the file '''AcceptanceTest.java''' under the <code class="mwt-code">src/test/java/dtu.library.acceptance_tests</code> and then '''right-click -&gt; Run as -&gt; JUnit Test'''. You will see the following content:[[File:08.png|700px|center|thumb|Run the project in Eclipse]]
Find the file '''AcceptanceTest.java''' under the <code class="mwt-code">src/test/java/dtu.library.acceptance_tests</code> and then '''right-click -&gt; Run as -&gt; JUnit Test'''. You will see the following content:[[File:08.png|700px|center|thumb|Run the project in Eclipse]]


Although the program fails the test (as it should), it proves that you can already run the cucumber plugin. You can now begin to implement the production code such that the scenarios "Admin login", "Admin logout", "Add book", and "Search book" pass.
Although the program fails the test (as it should), it proves that you can already run the cucumber plugin. You can now begin to implement the production code such that the scenarios "Admin login", "Admin logout", "Add book", and "Search book" pass. After implementing the first scenario on "Admin login", you should see the following:[[File:15.png|500px|center|thumb|Successfully passed the first scenario test in Eclipse]]
 
== IntelliJ ==
== IntelliJ ==
Find the file '''AcceptanceTest.java''' under the <code class="mwt-code">src/test/java/dtu.library/acceptance_tests</code> and then '''right-click -&gt; Run 'AcceptanceTest''''. You will see the following content:[[File:09.png|700px|center|thumb|Run the project in IntelliJ]]
Find the file '''AcceptanceTest.java''' under the <code class="mwt-code">src/test/java/dtu.library/acceptance_tests</code> and then '''right-click -&gt; Run 'AcceptanceTest''''. You will see the following content:[[File:09.png|700px|center|thumb|Run the project in IntelliJ]] Although IntelliJ shows "build failed" at first, you can assume that you can already run the cucumber plugin. You can now begin to implement the production code such that the scenarios "Admin login", "Admin logout", "Add book", and "Search book" pass. After implementing the first scenario on "Admin login", you should see the following:[[File:14.png|700px|center|thumb|Successfully passed the first scenario test in IntelliJ]]
 
Although the program fails the test (as it should), it proves that you can already run the cucumber plugin. You can now begin to implement the production code such that the scenarios "Admin login", "Admin logout", "Add book", and "Search book" pass.


[[Category:Course 02161 Software Engineering 1]]
[[Category:Course 02161 Software Engineering 1|1]]

Latest revision as of 01:30, 29 January 2024

READ ME FIRST

  • This tutorial applies to the Windows operating system, you can also check MacOS tutorial.
  • This tutorial is based on this file (Programming Exercises Course 02161 Week 1 written by Hubert Baumeister in January 2022) to make additions and changes.
  • Contact Shuokai Ma (s214919@student.dtu.dk) if you find a problem or have suggestions for this Wiki.

Download and Install JavaSDK

Download JavaSDK

Go to the JavaSDK Download Page. Based on your OS, download the following file (Java 21 recommended):

Windows: x64 Installer

Install JavaSDK

Double-click the file you downloaded, you should see the following interface

Java(TM) Installing Program

Click NEXT, and choose where you want to install it. Then you wait for it to finish installing and click CLOSE.

Verify JavaSDK (Optional)

You should now find your JavaSDK installation directory e.g. C:\Program Files\Java\jdk-21\bin and copy that path.

JavaSDK Installation directory

Now you should modify environment variables on Windows.

  1. On the Windows taskbar, right-click the Windows icon and select System.
  2. In the Settings window, under Related links, click Advanced system settings.
  3. On the Advanced tab, click Environment Variables.
  4. Choose Path under the system variables and then Click Edit to modify that environment variable.
  5. Click New and Paste that address (e.g. C:\Program Files\Java\jdk-21\bin) on the textbox
  6. Move up that textbox to the top of the list.
  7. Click OK and then Apply to have the change take effect.
Environment Variables Dialog in Windows

You can now verify your JavaSDK using the terminal command java --version. You should see the following content:

Verify JavaSDK

Download and Install IDE (Eclipse or IntelliJ)

The course will use Eclipse in its teaching material but all the things we do in the course can be done in IntelliJ too. You can download the latest version of Eclipse and IntelliJ (Community Edition) here. After that, you can follow the instructions of the installation wizard to install the IDE.

Download and Install the Cucumber plugin

Eclipse

From the Eclipse marketplace (from inside the Help menu of Eclipse), download the "Cucumber" plugin.

Install Cucumber (Eclipse)

IntelliJ

IntelliJ already comes with a Cucumber plugin. But I recommend you also download a plugin called Cucumber for Java since it can add support for Cucumber testing tools with step definitions written. You can download that from File -> Settings -> plugins

Install Cucumber (IntelliJ)

Restart your IDE

After you install the Cucumber plugin, you need to restart your IDE (Your IDE will also notify you to do that).

Download and Import the project "libaray01" to your IDE

You can download the zip file library01.zip here. And then you should unpack the zip file first.

Eclipse

You can now import the project into Eclipse by clicking File -> Import -> Maven -> Existing Maven Projects.  After clicking Next, proceed to click Browse and select the file you unpacked from the zip file. Then, mark the project pom.xml and click Finish.

Import project (Eclipse)

IntelliJ

You can now import the project into IntelliJ by clicking Open and Choosing the file pom.xml you unpacked from the zip file. Then click OK and Open as Project.

Import project (IntelliJ)

Run the project in your IDE

Eclipse

Find the file AcceptanceTest.java under the src/test/java/dtu.library.acceptance_tests and then right-click -> Run as -> JUnit Test. You will see the following content:

Run the project in Eclipse

Although the program fails the test (as it should), it proves that you can already run the cucumber plugin. You can now begin to implement the production code such that the scenarios "Admin login", "Admin logout", "Add book", and "Search book" pass. After implementing the first scenario on "Admin login", you should see the following:

Successfully passed the first scenario test in Eclipse

IntelliJ

Find the file AcceptanceTest.java under the src/test/java/dtu.library/acceptance_tests and then right-click -> Run 'AcceptanceTest'. You will see the following content:

Run the project in IntelliJ

Although IntelliJ shows "build failed" at first, you can assume that you can already run the cucumber plugin. You can now begin to implement the production code such that the scenarios "Admin login", "Admin logout", "Add book", and "Search book" pass. After implementing the first scenario on "Admin login", you should see the following:

Successfully passed the first scenario test in IntelliJ