DEV Community

Alan Richardson
Alan Richardson

Posted on • Originally published at

Should I test at the GUI Level or the API Level?

TLDR; Where to test? Can you isolate the functionality? If so, test the isolation most heavily. Then look to see what integrates, and how it integrates. Then test the integration as heavily as the 'how' requires.

Question: Is there a rule of thumb when deciding to test at the GUI level or API level? Are any rules to help decide when to test at one level over the other?

Answer: I don't think I use a simple rule of thumb. But I will try and explore some of the thought processes I use to make the decision.

When I am trying to decide whether to test at the GUI or the API I have to figure out:

  • What am I trying to test?
  • Can I isolate the functionality I'm testing to a specific 'level'?

And I think the word 'isolate' might be the 'rule of thumb' you are looking for.

  • Test heavily where you can isolate.
  • Test the integration heavily for the 'isolated' unique integration functionality
  • Test the integration as heavily as the implementation requires
  • Test the integration for emergent behaviour
  • Test the overlap between systems, during integration, more lightly

e.g. If the system has 'create user' functionality:

  • Exposed through the GUI via an admin interface
  • Exposed via an API REST call

I need to test at both levels because the functionality of 'create user' is not isolated to one level.

The questions I have to ask though are 'how much' and 'what' do I have to test at each level?

I may decide not to test as much through the GUI if my GUI calls the REST API because I can model that as (at least) two communicating systems. A GUI system and an API system.

I can heavily test the parts of functionality that are isolated in the API at the 'API level', and then lightly test the overlap of the integration between the GUI and the API.

And I want to test the unique functionality in the GUI. e.g. the GUI may have ajax calls triggered from GUI interaction - I want to test that at the GUI level.

Depending on the development process we may find that the 'ajax' calls have already been covered by JavaScript unit tests. But they haven't been run integrated in the browser page, or from all the browsers and operating systems the GUI is used in therefore, depending on the libraries used, I may want to test that cross browser and on different operating systems

If the GUI calls a different backend endpoint than the API, then I need to test both routes through to the backend code until I get to the point in the backend system where I encounter shared code - assuming there is shared code in the system used by both the REST API and the GUI triggered backend flow.

But at this point, I also need to consider how much coverage we have from unit tests which cover the shared code.

My rule of thumb might look like a list:

  • Build a model of the system such that you can identify the integration points and the 'isolated' shared functionality.
  • Test isolated functionality at the lowest points you can.
  • Work back out to higher (or 'peer') levels of integration and abstraction and consider the system in terms of integrating systems.
  • Look for unique functionality at the higher (or 'peer') levels of abstraction, you will need to test them there.
  • If you exercise unique functionality in isolation - by mocking out the integrating systems - then you might need to look at this from a technical risk perspective and decide if, or how much, you need to exercise it while integrated.

I could also model the above as:

  • Create multiple overlapping models of the system
  • Consider coverage of the multiple models of the system
  • Consider coverage of flows through the different models of the system
  • Consideration of technical risk relating to the implementation and the environments the system runs on

PS. When I explain this, people often map this on to their favourite pyramid model. I don't use any pyramid models. I prefer to model the system that I'm working with, rather than have a general model. Other people prefer pyramid models.

originally posted on

Top comments (2)

stealthmusic profile image
Jan Wedel

I'm not sure why it even makes sense to distinguish API/UI from other types of tests if you're developing a system / services full stack. This makes it even harder. You'll have to consider:

  • Backend Unit Tests
  • Backend Integration Tests (Service Level, not external dependencies)
  • Backend Service Test (Aka Service System tests or API, with external dependencies e.g. Real DB)
  • Backend System Test (aka System Test)
  • Frontend Unit Tests
  • Frontend Integration Tests with Backend Mocks
  • Frontend Systemtests with real system

For both back and frontend, the more business benefit (unit < integration < system) them more effort it is to write tests for all use and edge cases.

We are developing test driven, so unit tests are of no question. Then we are moving to use spring boot integration tests for most of the heavy load stuff (DB, MQ, REST) because it's so stunningly easy to write those tests. Then we have the main use cases modeled as end-to-end system tests for both UI and Backend.

danielscarvalho profile image
Daniel de Souza Carvalho

I like to use JUnit to test my classes and them QUnit to test services (unit testing) those are very similar test tools, it helps a lot at the dev cycle, not just to validate the code.

Moreover, take care with "sample" data in dev environment, it is trick! Tests go ok in dev environment and fail in production with the full dataset!

For UI and more advanced tests call a tester! To test is not simple, do not underestimate tests! Testers are really crazy people! They come um for example with sophisticated test tools such as "mutation code testing", this is something that the devs are not really going to do by hand!