Skip to content

How to Test New Features

Phil Hagen edited this page Nov 5, 2023 · 4 revisions

This page documents how to test new features that are still in development and testing. Testing these new features most often involves coordinating with the developers for specific new functionality or bugfixes. In either case, this coordination is done via GitHub issues, with out-of-band communications for more sensitive aspects such as sample data

New material is developed against the latest public/v* branch and therefore the latest public virtual machine. To test, ensure you're using the latest public VM. Older version are not likely to work correctly with in-development content.

New material is typically added to the develop branch, but might also be added to a branch created specifically for the feature or bugfix.

When new material is ready to be tested, an indication to this effect will be made in the corresponding GitHub issue. This will include the branch to be used.

  1. Boot the latest public virtual machine.

  2. It is STRONGLY suggested to take a VMware snapshot at this point or before booting the VM.

  3. Run the following commands, replacing <%BRANCH_INDICATED_IN_ISSUE%> as appropriate:

    cd /usr/local/sof-elk/
    sudo git checkout <%BRANCH_INDICATED_IN_ISSUE%>
    sudo sof-elk_update.sh

This will pull the latest updates from the specified branch, then activate them per standard platform functionality.

At this point, load sample/test data as you normally would. If things don't look right, logs may be needed. If so, the following might be needed, but since these can get quite large, please do not simply paste or send them in their entirety. Most likely, there will be a handful of lines that are most useful.

  • /var/log/logstash-plain.log
  • /var/log/elasticsearch/elasticsearch.log