github.com/hugh712/snapd@v0.0.0-20200910133618-1a99902bd583/testutil/base.go (about)

     1  // -*- Mode: Go; indent-tabs-mode: t -*-
     2  
     3  /*
     4   * Copyright (C) 2015-2020 Canonical Ltd
     5   *
     6   * This program is free software: you can redistribute it and/or modify
     7   * it under the terms of the GNU General Public License version 3 as
     8   * published by the Free Software Foundation.
     9   *
    10   * This program is distributed in the hope that it will be useful,
    11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
    12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    13   * GNU General Public License for more details.
    14   *
    15   * You should have received a copy of the GNU General Public License
    16   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    17   *
    18   */
    19  
    20  package testutil
    21  
    22  import (
    23  	"gopkg.in/check.v1"
    24  )
    25  
    26  // BaseTest is a structure used as a base test suite for all the snappy
    27  // tests.
    28  type BaseTest struct {
    29  	cleanupHandlers []func()
    30  }
    31  
    32  // SetUpTest prepares the cleanup
    33  func (s *BaseTest) SetUpTest(c *check.C) {
    34  	if len(s.cleanupHandlers) != 0 {
    35  		panic("BaseTest cleanup handlers were not consumed before a new test start, missing BaseTest.TearDownTest call?")
    36  	}
    37  }
    38  
    39  // TearDownTest cleans up the channel.ini files in case they were changed by
    40  // the test.
    41  // It also runs the cleanup handlers
    42  func (s *BaseTest) TearDownTest(c *check.C) {
    43  	// run cleanup handlers in reverse order and clear the slice
    44  	n := len(s.cleanupHandlers)
    45  	for i := range s.cleanupHandlers {
    46  		f := s.cleanupHandlers[n-1-i]
    47  		f()
    48  	}
    49  	s.cleanupHandlers = nil
    50  }
    51  
    52  // AddCleanup adds a new cleanup function to the test
    53  func (s *BaseTest) AddCleanup(f func()) {
    54  	s.cleanupHandlers = append(s.cleanupHandlers, f)
    55  }