testing-api.onlyoffice.com

Getting start

For local startup in developer mode, recommended installing a local bundle config file.

 bundle config set --local with development

Afterwards install the dependencies with the bundle.

 bundle install

How to run tests

In order to execute tests use following commands:

Locally

1. Bundler will install all needed gems

   bundle install

2. Replace path to file you want to run

    rspec spec/[functional]/[specific_spec_file.rb]

Remotely on wrata

1. Login to your wrata instance with user api.onlyoffice.com (Login info stored in secret password file)

2. Go to wrata-url/clients/api_keys and locally call command to initialize API

   

3. run tests on api.teamlab.info

   rake wrata:run_tests

   or

   run tests on api.onlyoffice.com

   rake wrata:run_tests_on_production

Test description

All spec files are rather fast to run, around 1 hour all of them except two file:

 spec/testing-api.onlyoffice.com/community_server/documentat_links_content_spec.rb

 spec/testing-api.onlyoffice.com/document_builder/documentation_links_content_spec.rb

Both those file check a lot of pages for content, so they are slow. It took around several hours to run each of them, maybe even more if palladium slow downs a bit

How to check new major version of documentation

Workspace

1. Run locally. It will fail if some new methods was added to list of API Methods.

    rake actualize_workspace

2. Manually edit to correctly add new methods to list of API Methods

    templates/workspace/api_backend.json

3. Run to actualize list of missing docs.

    rake update:workspace_api_backend

   It will produce new spec/data/failed_workspace_tests.list.
   Check with developers, that it's ok to miss those links

4. Run to check that all data is the same as in failed_workspace_tests.list

    rspec spec/testing-api.onlyoffice.com/workspace/documentation_links_content_spec.rb

Docs

1. Run locally. It will fail if some new methods was added to list of API Methods.

    rake actualize_office_api_methods

2. Manually edit to correctly add new methods to list of API Methods

    templates/document_builder/usage_api.json

3. Run to actualize list of missing docs.

    rake update:documentbuilder_office_api

   It will produce new spec/data/failed_docbuilder_tests.list Check with developers, that it's ok to miss those links

4. Run to check that all data is the same as in.

    rspec spec/testing-api.onlyoffice.com/docs/office_api/office_api_method_links_spec.rb

DocSpace

1. Run locally. It will fail if some new methods was added to list of API Methods.

    rake actualize_docspace

2. Manually edit to correctly add new methods to list of API Methods

    templates/docspace/api_backend.json

3. Run to actualize list of missing docs.

    rake update:docspace_api_backend

   It will produce new spec/data/failed_docbuilder_tests.list Check with developers, that it's ok to miss those links

4. Run to check that all data is the same as in.

    rspec spec/testing-api.onlyoffice.com/docspace/docspace_links_content_spec.rb