How-to Submit a Software Mini-Test Plan

To schedule testing time on the Wednesday software day please send a mini-test plan to the mcc e-log. You can do this by sending email to controls-software-release mailing list as follows:

Please tag your email subject line

"SW Mini-Test Plan: <whatever you're doing>"

The body of the email should include:

1. a description of the software you are testing
2. what other systems this will affect
3. What you require (ie: beam,rf,timing, rate)
4. if your test is invasive to the beam, or to other applications
5. how long you need for your test (2hrs)
6. CVS Tagged version to be released
7. CVS Tagged version before loding you're new software
8. ioc booted
9. Other applications updated such as ChannelWatcher files, archive files, ALH (j.rock) on lclshome,etc.
10. a test plan..the steps you intend to take in testing testing your release to ensure that it works.

If you have changed any parameters of the system, return those system parameters to the state that you found them in, and let the program deputy know that you are finished with your test. If you need assistance returning the system to its original state, please ask the program deputy for assistance. This assumes that you have notified the program deputy, prior to your test so that system parameters have been saved before you started your test.

After you finish testing. Find you mcc-elog entry and select "FOLLOW UP" link, to enter the results of your test.
Enter the following information:

1. the status of your test
2. include the state you left the system if this is pertinent.
3. if you have released software please list the cvs tagged version of the software and the previously booted version (good) to be used to backout software.
4. List instructions regarding how to back-out your new release.
5. Provide your contact information in case of questions or problems.

Your mini-test plan should be submitted by Tuesday noon. Please note that your test/release must be APPROVED, which means that it MUST be listed on the
LCLS Commissioning Software Day. If your test will not take place during the Software Test Day, OPS (eoic) and Program Deputy must be informed and your mini-test place submitted to the mcc-elog.

Before starting your test you MUST:

1. have your test plan submitted to the mcc-elog
2. check with OPS (eoic) and the Program Deputy, or Controls Deputy
3. perform your test from the control room unless you are
   1. required to be in the field
   2. you obtain pre-approval from Ernest and OPS, or Controls Deputy.
4. After completing your test, follow-up your initial mini-test plan in the mcc-elog.
   

How to Submit a Software Test Plan (beginning July 8 2011)

Before the Day of Your Test

To schedule software testing time in production, please create a Software Job in CATER. If your job is in response to an existing CATER Software Problem or Software Request, create a job for that Problem/Request. If not, create a new Software Request and job. Do this by Friday noon of the week before you intend to do your work.

Fill out all the required and appropriate fields for the job following these guidelines:

Status:

          Active: For new, upcoming, and in-progress jobs

          Complete: For jobs that have been completed or backed out

          Drop: For jobs that will not be performed after all

Job Title:

          Functional description of software release or test. Intended to be brief and clear description for physicists, operators, and anyone else not doing the work.

          Examples:

                    "Oracle security patch"

                    "Add support for waveforms to SCORE"

                    "Bug fix for EDM byte widget"

                    "Update undulator polynomials"

Resource:

          Name of the person doing the work

Time Needed:

          Duration of test (hours)

Time Comment (optional):

          Any additional comment regarding the Time Needed, for example "1 hour invasive, 2 hours non-invasive"

Planned Start Date & Time:

          Enter the date you hope to do your work. This field will be updated by the Controls Deputy as the schedule matures.

Beam Requirements:

          What conditions you require to do your test, for example beam timing, etc. Select from drop-down menu

Beam Comment (optional):

          Any additional comment regarding the Beam Requirements, for example "Beam required through BSY"

Invasive:    

           Is your test somehow invasive to accelerator operation (interrupts beam, timing, RF, etc.). Select Yes or No from drop-down menu

Invasive Comment (optional):

          Any additional comment regarding the Invasive field, for example "Interrupts LI25 RF stations"

Scheduling Priority:

          Select from drop-down menu. Most often, you will choose one of these:

                    PAMM (Planned Accessible Machine Maintenance): Work while accelerator operating (similar to Repair Opportunity Days)

                    POMM: (Planned Operational Machine Maintenance): Work while accelerator not operating (similar to Machine Development days)

Description:

          A description of the software you are testing

Test Plan:

          The steps you intend to take in testing your software, including any checkout

Backout Plan:

          The steps required to back out the software

Risk/Benefit:

          A brief description of the risk of your test (if it does not work, what is the potential fallout) and the benefit (why are you doing this)

Dependencies:

          Other software work that your test depends on 

Followup Comments:

          Fill this field in when you have completed your job (or backed out or cancelled it)

On the Day of Your Test

Before starting your test you MUST:

1. Have had your Software Job approved by the Controls Deputy
2. Check with MCC Operators (EOIC) or Controls Deputy immediately before beginning
3. Save snapshots or configs of any system parameters that you may affect

During your test you MUST:

1. Perform your test from the control room unless you are required to be in the field or you obtain pre-approval from the MCC Operators (EOIC) or Controls Deputy.

After your test you MUST:

1. Return any sytem parameters to the state that you found them in. If you need assistance doing this, please ask the MCC Operators for assistance.
2. Notify the Controls Deputy or MCC Operators (EOIC) that you are done
3. Update the Followup Comments field of your Software job to describe the status of your test and the state you left the system in, if pertinent. If appropriate, update the Status field of your job. Apply these changes to your Software Job. This will cause a notification email to be sent out.