Changes between Initial Version and Version 1 of Developer/Projects/Open/TestTemplate


Ignore:
Timestamp:
Apr 6, 2013, 8:31:32 AM (9 years ago)
Author:
C Rempel
Comment:

Address Bug 1549

Legend:

Unmodified
Added
Removed
Modified
  • Developer/Projects/Open/TestTemplate

    v1 v1  
     1= RTEMS Test Template =
     2
     3
     4
     5[[TOC(GSoC/Projects/TestTemplate, depth=2)]]
     6
     7
     8Credit: Sebastian Huber for proposing the enhancement
     9
     10'''Mentors:''' Help Wanted.
     11
     12'''Students:''' Help Wanted. '''Past help to be filled in'''
     13
     14'''Status:''' Initiated.
     15
     16'''Introduction:''' Unit tests are a vital development tool.  It should be as easy as possible to
     17write tests and to execute them.
     18
     19'''Goal:''' Currently we have to do several steps to write a test, which is way to much work.  A lot of copy and paste is involved.  What we
     20did as of the time of the bug-report.
     21
     22# Create a new directory for the test. '''Note:''' handled by http://git.rtems.org/rtems-testing/tree/rtems-test-template
     23# Create a new Makefile.am.  This normally involves a lot of copy and paste from an existing test. '''Note:''' handled by http://git.rtems.org/rtems-testing/tree/rtems-test-template
     24# Add a new init.c file.  Which may be enough for simple tests. '''Note:''' handled by http://git.rtems.org/rtems-testing/tree/rtems-test-template
     25# Add a test.doc file for the documentation. '''Note:''' handled by http://git.rtems.org/rtems-testing/tree/rtems-test-template
     26# Add a test.scn file with the output of the test. '''TODO:''' probably could add a make-scn to rtems/make/leaf.cfg or rtems/c/src/make/leaf.cfg through a clever call to a simulator and a log file
     27# Modify the top level Makefile.am. '''TODO:''' probably could add this functionality to rtems/bootstrap
     28# Modify the top level configure.ac. '''TODO:''' probably could add this functionality to rtems/bootstrap
     29# Run bootstrap. '''TODO:''' make this an option when running the script in http://git.rtems.org/rtems-testing/tree/rtems-test-template
     30# Add a copy and paste .cvsignore. '''Note:''' outdated, possibly .gitignore
     31# Write a ChangeLog with several entries. '''Note:''' replaced ChangeLog with git functionality
     32
     33Refine this initial statement to include: project deliverables (code, docs, testing), required/suggested methodology, standards of quality, possible goal extensions beyond the main objective.
     34
     35'''Standards of Quality:''' the build system performs the needed steps
     36
     37'''Possible Goal Extensions:'''
     38# Make the unit tests more in compliance with http://softwaretestingstandard.org/ by filling in the .doc with the needed information
     39# Align the tests with the POSIX and RTEID standards through the use of doxgen comments
     40
     41'''Requirements:''' List the requirements and level of expertise you estimate are required by the developer tackling this project will have to have: Required level of programming language(s), specific areas of RTEMS or tools, level of familiarity with RTEMS, cross-development, GNU/Linux, etx., development/documentation/testing tools, mathematical/algorithmic background, other desirable skills.
     42
     43'''Resources:''' Sebastian Huber and http://git.rtems.org/rtems-testing/tree/rtems-test-template
     44
     45'''Acknowledgements'''
     46 *  Sebastian Huber, Christopher Kerl, Joel Sherrill '''TODO:''' add the other contributers
     47= Miscellaneous Sections =
     48
     49As the project progresses, you will need to add build instructions, etc and this page will evolve from a project description into a HOWTO.
     50= References =
     51
     52
     53 *  TBD
     54
     55'''Other sections:''' If you have more to say about the project that doesn't fit in the proposed sections of this template, feel free to add other sections at will.