File: shared_directory.go

package info (click to toggle)
arduino-cli 1.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 65,096 kB
  • sloc: cpp: 6,520; sh: 196; python: 30; makefile: 28
file content (67 lines) | stat: -rw-r--r-- 1,916 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
// This file is part of arduino-cli.
//
// Copyright 2022 ARDUINO SA (http://www.arduino.cc/)
//
// This software is released under the GNU General Public License version 3,
// which covers the main part of arduino-cli.
// The terms of this license can be found at:
// https://www.gnu.org/licenses/gpl-3.0.en.html
//
// You can be released from the requirements of the above licenses by purchasing
// a commercial license. Buying such a license is mandatory if you want to
// modify or otherwise use the software for commercial activities involving the
// Arduino software without disclosing the source code of your own applications.
// To purchase a commercial license, send an email to license@arduino.cc.

package integrationtest

import (
	"sync"
	"testing"

	"github.com/arduino/go-paths-helper"
	"github.com/rogpeppe/go-internal/lockedfile"
	"github.com/stretchr/testify/require"
)

// SharedDir is a directory that is shared between multiple tests.
type SharedDir struct {
	dir      *paths.Path
	t        *testing.T
	mux      sync.Mutex
	fileLock *lockedfile.File
}

// Lock locks the shared directory for exclusive access and return the path to the directory.
func (d *SharedDir) Lock() *paths.Path {
	d.mux.Lock()
	defer d.mux.Unlock()
	if d.fileLock != nil {
		panic("SharedDir already locked")
	}
	fileLock, err := lockedfile.Create(d.dir.Join(".lock").String())
	require.NoError(d.t, err)
	d.fileLock = fileLock
	return d.dir
}

// Unlock unlocks the shared directory.
func (d *SharedDir) Unlock() {
	d.mux.Lock()
	defer d.mux.Unlock()
	if d.fileLock == nil {
		panic("SharedDir already unlocked")
	}
	require.NoError(d.t, d.fileLock.Close())
	d.fileLock = nil
}

// NewSharedDir creates a new shared directory.
func NewSharedDir(t *testing.T, id string) *SharedDir {
	dir := paths.TempDir().Join(ProjectName + "-" + id)
	require.NoError(t, dir.MkdirAll())
	return &SharedDir{
		dir: dir,
		t:   t,
	}
}