Fuego_naming_rules 

Fuego 1.1 wiki

Login or create account

Fuego naming rules

To add boards or write tests for Fuego, you have to create a number of files and define a number of variables.

Here are some rules and conventions for naming things in Fuego:

test names [edit section]

  • a test name must have one of the following prefixes:
    • 'Functional."
    • 'Benchmark."
  • the name following the prefix is known as the base test name, and has the following rules:
    • it may only use letters, numbers and underscores
      • that is - no dashes
    • it may use upper and lower case letters
  • All test materials reside in a directory with the full test name:
    • e.g. Functional.hello_world

base script name [edit section]

  • the base script name has the same name as the base test name, with the suffix ".sh"
    • e.g. hello_world.sh

spec file name [edit section]

  • the spec file for a test has the same name as the test, with the suffix ".spec"
    • e.g. Functional.hello_world.spec

board names [edit section]

  • boards are defined by files in the /fuego-ro/boards directory
  • their filenames consists of the board name, with the suffix ".board"
    • e.g. beaglebone.board
  • a board name should have only letters, numbers and underscores.
    • specifically, no dashes, periods, or other punctuation is allowed

node name [edit section]

  • A Jenkins node corresponding to a board must have the same name as the board.
    • e.g. beaglebone

timestamp [edit section]

  • A Fuego timestamp has the format: YYYY-mm-dd_HH:MM:SS
    • e.g. 2017-03-29_10:25:14
  • times are expressed in localtime (relative to the host where they are created)

job name [edit section]

  • A Jenkins job is used to execute a test.
  • Jenkins job names should consist of these parts: <board>.<spec>.<test_name>
    • e.g. beaglebone.default.Functional.hello_world

TBWiki engine 1.8.3 by Tim Bird