Note

This documentation is being updated with material from the Fuego wiki (at fuegotest.org). Please be patient while this work is in progress.

#.. include:: FrontPage.rst

Index

Contents:

• About Fuego
• Architecture
  • Major elements
  • Container
  • Jenkins
  • Pre-packaged tests
  • Fuego test definition
  • Board
  • Fuego core
  • Different objects in Fuego
  • Jenkins operations
  • Test execution
  • Test environment file generation
  • Fuego test phases
  • Command line tool

Tutorials:

• Install and First Test
  • Overview
  • Step details
  • Run a test
  • Conclusions
  • What do do next?

Installation and Administration:

• Fuego Quickstart Guide
  • Overview
  • Install pre-requisite software
  • Download, build, start and access
  • Add your board to fuego
  • Install a toolchain
  • Now select some tests
  • Run a test
  • Additional Notes
  • Troubleshooting
• Installing Fuego
  • Overview
  • Install pre-requisite software
  • Overview of remaining steps
  • Install the Fuego repositories
  • Create the Fuego container
  • Start the Fuego container
  • Access the Fuego Jenkins web interface
  • Access the Fuego docker command line
  • Remaining steps
  • Alternative installation configurations
• Adding a Board
  • Overview
  • Board-specific test variables
• Adding a toolchain
  • Introduction
  • Obtain a toolchain
  • Install the SDK in the docker container
  • Create a -tools.sh file for the toolchain
  • Reference the toolchain in a board file
  • Notes
• Adding test jobs to Jenkins
  • Selecting tests or plans
  • Adding individual tests
  • Adding jobs based on testplans
• Adding views to Jenkins
  • Adding a board view
  • Add view by test name regular expression
  • Add specific jobs
• Test variables
  • Introduction
  • Board file
  • Overlay system
  • Stored variables
  • Spec variables
  • Dynamic variables
  • Variable precedence

User Guides:

• Jenkins User interface
  • Main dashboard
  • Node pages
  • Job pages
  • Build pages
  • View pages
  • Other Jenkins pages
• Command Line Tool - ftc
  • Introduction
  • Commands groups
  • ftc run-test
• Log files
  • Main results logs
  • Other test artifacts
  • Summary
• Generating Reports
  • ftc gen-report
  • ftc gen-report usage help

Developer Guides:

• Adding or Customizing a Distribution
  • Introduction
  • Distribution overlay file
  • Referencing the distribution in the board file
  • Testing Fuego/distribution interactions
  • Notes

Developer resources

• Building Documentation
  • building the outdated PDF
  • building the RST docs
• Fuego Developer Notes
  • Resources
  • Notes
  • Logs
  • Core scripts
• License And Contribution Policy
  • License
  • Submitting contributions

Advanced Topics:

• Adding or Customizing a Distribution
  • Introduction
  • Distribution overlay file
  • Referencing the distribution in the board file
  • Testing Fuego/distribution interactions
  • Notes
• Integration with ttc
  • Outline of supported functionality
  • Supported operations
  • Location of ttc.conf
  • Steps to use ttc with a target board
  • modify your copy_to_cmd
• Working with remote boards
  • using a jump server
  • Using ttc transport remotely
  • Setting up ssh ProxyCommand in the Fuego docker container

API Reference

• API Reference
• Functions available for tests to call
  • Functions for interacting with the target
  • Functions for checking dependencies and requirements
  • Functions for preparing board and executing tests
  • Functions for parsing results
  • Functions for cleanup
  • For batch tests
  • Misceleneous functions
  • For printing messages at various message output levels
  • fuego_test.sh functions
• Parser module API
  • Parser API
  • Deprecated API
  • Developer notes
• Core interfaces
  • From Jenkins to Fuego
  • From Fuego to Fuego
  • Example Values
  • From Fuego to Jenkins
• Adding a new test
  • Overview of Steps
  • Decide on a test name
  • Create the directory for the test
  • Get the source for a test
  • Test script
  • Test spec
  • Test results parser
  • Pass criteria and reference info
  • Jenkins job definition file
  • Publishing the test
  • Technical Details
• Using Batch Tests
  • How to make a batch test
  • Test output
  • Preparing the system for a batch job
  • Executing a batch test
  • Viewing batch test results
  • Miscelaneous notes

Reference Material:

• Fuego naming rules
  • Fuego test name
  • Test files
  • Test spec names
  • Board names
  • Jenkins element names
  • Run identifier
  • timestamp
  • test identifiers
  • Test variable names
• Artwork
  • Logos
  • Banners
  • images
  • Photos
  • Diagrams
  • Presentation templates
• FAQ
  • Languages and formats used
• Glossary
  • B
  • C
  • D
  • F
  • J
  • L
  • M
  • O
  • P
  • R
  • S
  • T
  • V

Indices and tables

• Index

• Module Index

• Search Page