Test implementation

[DanielKraft]

Reason (Why?) At this time no frontend and backend tests have been implemented yet.

Solution (What?)

1. Identify components which should be tested.
2. Identify suitable test frameworks and modules.

• Frontend Tests:

  • Basic informations:

  • https://vuejs.org/v2/guide/testing.html

  • https://vuejs.org/v2/cookbook/unit-testing-vue-components.html

  • Test frameworks/modules:

    1. Jest (framework)

       • "Jest is a JavaScript test framework that is focused on simplicity. One of its unique features is the ability to take snapshots of tests in order to provide an alternative means of verifying units of your application."

       • https://cli.vuejs.org/core-plugins/unit-jest.html
    2. Mocha (framework)

       • "Mocha is a JavaScript test framework that is focused on being flexible. Because of this flexibility, it allows you to choose different libraries to fulfill other common features such as spying (e.g., Sinon) and assertions (e.g., Chai). Another unique feature of Mocha is that it can also execute tests in the browser in addition to Node.js."

       • https://cli.vuejs.org/core-plugins/unit-mocha.html
    3. @vue/test-utils (module)
       • Useful for mocking API calls in service components.
       • https://vue-test-utils.vuejs.org/guides/testing-async-components.html#asynchronous-behavior-outside-of-vue

• Backend Tests:

  • Basic informations:
  • https://devguide.python.org/runtests/
  • https://realpython.com/python-testing/
  • Test frameworks:

    1. "The unittest unit testing framework was originally inspired by JUnit and has a similar flavor as major unit testing frameworks in other languages. It supports test automation, sharing of setup and shutdown code for tests, aggregation of tests into collections, and independence of the tests from the reporting framework."

       • https://docs.python.org/3/library/unittest.html

    2. "The doctest module searches for pieces of text that look like interactive Python sessions, and then executes those sessions to verify that they work exactly as shown."

       • https://docs.python.org/3/library/doctest.html

Out of scope

Relation to other Issues

Acceptance criteria

[DanielKraft]

Frontend Tests

• As test framework Jest should be used, because our project chooses a lightweight framework.
• Files which could be tested:
  • src\components\ui\LocationSearchBar.vue (for example the search for the location)
  • src\components\ui\SearchBar.vue (for example the search for keywords)
  • src\utils\services\DataService.ts
  • src\utils\services\LocationService.ts
  • src\utils\services\TagService.ts

[DanielKraft]

Backend Tests

• data_extraction
  • To test the data extraction, you would have to apply the scraper to a mocked website. However, this requires a lot of effort.
• data_enhancement
  • Testing of the data enhancement could be realized with some effort. However, with the introduction of more data sources, these tests could quickly become complex.
• upload_to_elasticsearch
  • The upload to elasticsearch is rather uninteresting for testing.