Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! Join TestMu Conference

Automation Advisor
Ginkgo
interrupt_handler
SetInterruptPlaceholderMessage

How to use SetInterruptPlaceholderMessage method of interrupt_handler Package

Best Ginkgo code snippet using interrupt_handler.SetInterruptPlaceholderMessage

interrupt_handler.go

Source:interrupt_handler.go

...38	Cause       InterruptCause39}40type InterruptHandlerInterface interface {41	Status() InterruptStatus42	SetInterruptPlaceholderMessage(string)43	ClearInterruptPlaceholderMessage()44	InterruptMessageWithStackTraces() string45}46type InterruptHandler struct {47	c                           chan interface{}48	lock                        *sync.Mutex49	interrupted                 bool50	interruptPlaceholderMessage string51	interruptCause              InterruptCause52	client                      parallel_support.Client53	stop                        chan interface{}54}55func NewInterruptHandler(timeout time.Duration, client parallel_support.Client) *InterruptHandler {56	handler := &InterruptHandler{57		c:           make(chan interface{}),58		lock:        &sync.Mutex{},59		interrupted: false,60		stop:        make(chan interface{}),61		client:      client,62	}63	handler.registerForInterrupts(timeout)64	return handler65}66func (handler *InterruptHandler) Stop() {67	close(handler.stop)68}69func (handler *InterruptHandler) registerForInterrupts(timeout time.Duration) {70	// os signal handling71	signalChannel := make(chan os.Signal, 1)72	signal.Notify(signalChannel, os.Interrupt, syscall.SIGTERM)73	// timeout handling74	var timeoutChannel <-chan time.Time75	var timeoutTimer *time.Timer76	if timeout > 0 {77		timeoutTimer = time.NewTimer(timeout)78		timeoutChannel = timeoutTimer.C79	}80	// cross-process abort handling81	var abortChannel chan bool82	if handler.client != nil {83		abortChannel = make(chan bool)84		go func() {85			pollTicker := time.NewTicker(ABORT_POLLING_INTERVAL)86			for {87				select {88				case <-pollTicker.C:89					if handler.client.ShouldAbort() {90						abortChannel <- true91						pollTicker.Stop()92						return93					}94				case <-handler.stop:95					pollTicker.Stop()96					return97				}98			}99		}()100	}101	// listen for any interrupt signals102	// note that some (timeouts, cross-process aborts) will only trigger once103	// for these we set up a ticker to keep interrupting the suite until it ends104	// this ensures any `AfterEach` or `AfterSuite`s that get stuck cleaning up105	// get interrupted eventually106	go func() {107		var interruptCause InterruptCause108		var repeatChannel <-chan time.Time109		var repeatTicker *time.Ticker110		for {111			select {112			case <-signalChannel:113				interruptCause = InterruptCauseSignal114			case <-timeoutChannel:115				interruptCause = InterruptCauseTimeout116				repeatInterruptTimeout := timeout / time.Duration(TIMEOUT_REPEAT_INTERRUPT_FRACTION_OF_TIMEOUT)117				if repeatInterruptTimeout > TIMEOUT_REPEAT_INTERRUPT_MAXIMUM_DURATION {118					repeatInterruptTimeout = TIMEOUT_REPEAT_INTERRUPT_MAXIMUM_DURATION119				}120				timeoutTimer.Stop()121				repeatTicker = time.NewTicker(repeatInterruptTimeout)122				repeatChannel = repeatTicker.C123			case <-abortChannel:124				interruptCause = InterruptCauseAbortByOtherProcess125				repeatTicker = time.NewTicker(ABORT_REPEAT_INTERRUPT_DURATION)126				repeatChannel = repeatTicker.C127			case <-repeatChannel:128				//do nothing, just interrupt again using the same interruptCause129			case <-handler.stop:130				if timeoutTimer != nil {131					timeoutTimer.Stop()132				}133				if repeatTicker != nil {134					repeatTicker.Stop()135				}136				signal.Stop(signalChannel)137				return138			}139			handler.lock.Lock()140			handler.interruptCause = interruptCause141			if handler.interruptPlaceholderMessage != "" {142				fmt.Println(handler.interruptPlaceholderMessage)143			}144			handler.interrupted = true145			close(handler.c)146			handler.c = make(chan interface{})147			handler.lock.Unlock()148		}149	}()150}151func (handler *InterruptHandler) Status() InterruptStatus {152	handler.lock.Lock()153	defer handler.lock.Unlock()154	return InterruptStatus{155		Interrupted: handler.interrupted,156		Channel:     handler.c,157		Cause:       handler.interruptCause,158	}159}160func (handler *InterruptHandler) SetInterruptPlaceholderMessage(message string) {161	handler.lock.Lock()162	defer handler.lock.Unlock()163	handler.interruptPlaceholderMessage = message164}165func (handler *InterruptHandler) ClearInterruptPlaceholderMessage() {166	handler.lock.Lock()167	defer handler.lock.Unlock()168	handler.interruptPlaceholderMessage = ""169}170func (handler *InterruptHandler) InterruptMessageWithStackTraces() string {171	handler.lock.Lock()172	out := fmt.Sprintf("%s\n\n", handler.interruptCause.String())173	defer handler.lock.Unlock()174	if handler.interruptCause == InterruptCauseAbortByOtherProcess {...