.. _section-Creating a FloraScript File in Sunflower

Creating a FloraScript File in Sunflower
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


FloraScript is a simple scripting language built into **Sunflower** to help develop regression tests for Sunflower applications.  These tests can also be a convenient way to validate **Sunflower** installation after each system update.


To build regression tests using FloraScript, we put FloraScript commands into a file which ends with a ".fs" file extension, and then execute the file in **Sunflower**.

To carry this out in **Sunflower**, create a new file using the main navigation menu (**File > New > File**), as shown in :numref:`figure-create-new-fs-file.png`.

.. _figure-create-new-fs-file.png:

.. figure:: ../../../figs/create-new-fs-file.png
   :alt: Use **Sunflower** main navigation menu to create a new file

   Use **Sunflower** main navigation menu to create a new file

Select the Sunflower Project you want to perform the regression tests for as the parent folder, and give a name ending with ".fs" to the file.  :numref:`figure-select-parent-folder-for-fs-file.png` shows the new FloraScript file family-regression-tests.fs having parent folder SunflowerProject1.  

.. _figure-select-parent-folder-for-fs-file.png:

.. figure:: ../../../figs/select-parent-folder-for-fs-file.png
   :alt: SunflowerProject1 is parent folder for family-regression-tests.fs

   SunflowerProject1 is parent folder for family-regression-tests.fs

Click Finish and an empty family-regression-tests.fs file should appear in the **Sunflower** navigation window.  Select the file and right click.  The pop-up menu should have **Execute FloraScript** enabled, as shown in :numref:`figure-right-click-menu-to-execute-florascript.png`.  This is the menu option for executing the regression tests in the file.

.. _figure-right-click-menu-to-execute-florascript.png:

.. figure:: ../../../figs/right-click-menu-to-execute-florascript.png
   :alt: Right click menu in navigation window shows **Execute FloraScript** option

   Right click menu in navigation window shows **Execute FloraScript** option


In the next section, we will use family-regression-tests.fs to build regression tests for the family application in SunflowerProject1.