In this free tutorial, you will learn how to get started with TestProject Java SDK – an excellent resource for creating robust test automation using the Java programming language. 

I’ll walk you through how to create your free TestProject account, how to download the TestProject agent and how to set up the Java SDK. You will learn how to write automated tests using Safari and Chrome, which is extremely easy. 

Using TestProject, you will learn how to navigate all of the excellent TestProject dashboards which automatically get updated to create the amazing HTML report. 

And finally, we will put everything together as you learn how to create page objects using the TestProject Java SDK. Let’s jump in.

TestProject Java SDK Setup

Let’s go ahead and get you set up with your free TestProject account. By the way, TestProject is free forever. 

First, please navigate to this link and click the free sign up button. Enter your name, email and a password, and once you filled out all the information, don’t forget to confirm your email. 

After you’ve confirmed your email, you’re going to be taken to a page that looks like this:

Once fully logged in, you can follow the setup wizard, and you can either record a codeless test, or you can create a new test by coding – which is exactly what we’re going to cover in this tutorial. Go ahead and pick Create Tests by Coding.

The very first thing that we need to do is download our agent. 

Depending on your operating system, pick the one that you want. After you install the agent, you need to start running it. On Mac, open up your terminal and type ‘TestProject agent’. On Windows, simply double click on the application and start running your agent. You will know that your agent is being executed because you’ll see it in the tray bar. 

On the next step, you’re going to need to grab your developer token:

You can copy this token and add it as an environment variable. And afterwards, I will teach you exactly how to set up your SDK. Now let’s go to the TestProject dashboard.

TestProject Java SDK Dashboards

The Home page

This is the home page of TestProject. It’s broken up into several sections. At the very top, you see the recommended addons: addons in TestProject are components that you install into your test automation and the TestProject recorder so that you are able to extend the functionality. 

For example, there’s an addon that allows you to do PDF actions, a restful API client that was developed by the TestProject team where this basically allows you to perform operations such as GET, POST, PUT, and so on. These components can either be developed by the TestProject team or anyone else in the industry that wants to create an addon for usability. If you want a view of all addons, you can click the “View available addons” button. This will take you to the Addons page, where you can see all the addons that exist. You can see the items that are installed, or filter by element type. And, of course, if you look at every single addon, it tells you what it supports.

On the right hand side, you can see the recent activity that has been going on in your TestProject dashboard. 


Below you can see the My Project area. The My Project area is basically any project that you’re working on.

Let’s add a project right now. Click on Add new project, enter a name and a description, and save. 

Now you can see you’re inside of the test area, and here you’re going to have all of your tests, and all of your jobs, and you can organize all of your tests by folders. 

Monitor tab

Next, you can see the Monitor tab, which shows current executions. As we are executing tests through the Java SDK, we’ll see some information here and of course, upcoming jobs, which are scheduled jobs.

The Reports view

In the Reports area is where we will actually spend a lot of our time. This is where all of our test automation reports come. So whenever we’re using the Java SDK, the reports will appear here. 

There are different metrics that you can see in the reports: 

  • the velocity, that will show us the total number of tests that have been executed as well as their past failed and skipped rate as well can see here the date, then you can even change the graphs
  • the distribution of our test execution – number of executions and status per agent
  • the platforms
  • trends – for example, we can see all of the different types of tests that we executed and we can see their past failed and skip percentages. 
  • targets 

Agents tab

The Agents tab shows all of the agents that we currently have that are linked to our account. We can download an agent from here and install another agent on our machine, register an agent, and also look at the agents that are ready. 


And finally, you can see the Integrations tab, that shows you the documentation for the Java, C# and Python SDKs, and I am sure that they’re going to have more in the future. You can also access the QuickStart guide and the API documentation.

If you want to create an API key, you would do that here. You can also set up Web hooks, and even Slack integration, hook up to a cloud execution service, or link up to qTest, which will allow you test case management, and you can also start developing your own addons.

Help and support

I’d also like to point out they have a Help area, where if you do need any kind of help, you can either go to a chat, the forum or docs, and of course, you can provide feedback and submit support tickets. 

My profile

And of course  your personal profile, where you can look at your account.