sos 0.11.4

Distributed, encrypted database for private secrets.
Documentation 
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

# Test

Run all the tests.

```
cargo make test
```

To skip integration tests and just run unit tests:

```
cargo make unit
```

To generate a code coverage report in `target/coverage` run:

```
cargo make cover
```

The CLI test specs can take a long time with the debug build so if you want to skip them use:

```
cargo make test-lite
```

To run just the command line tests which would be included in test coverage:

```
cargo make test-command-line
```

These tests always use a debug version of the executable. Run with `ANTICIPATE_ECHO` to debug:

```
ANTICIPATE_ECHO=true cargo make test-command-line
```

## Test Scripts

The test scripts make it much faster to run tests by using a release version installed with `cargo install --path .`.

To run the CLI test specs using the first version of `sos` in `PATH`:

```
cargo make test-cli
```

Or to just test the shell command:

```
cargo make test-shell
```

If you need to debug the CLI tests enable echo to see the I/O, for example:

```
ANTICIPATE_ECHO=true cargo make test-cli
ANTICIPATE_ECHO=true cargo make test-shell
```

Use the `SPEC` variable to run a specific test:

## Notes

### MacOS ulimit

If you are running on MacOS and see the "too many open files" error running the tests then you will need to configure the limits.

Update your shell's ulimit by modifying the profile (eg: `~/.zshrc`):

```
ulimit -n 2048
```

And update the maxfiles limit `launchctl limit maxfiles`.

To temporarily change the maxfiles limit:

```
sudo launchctl limit maxfiles 64000 524288
```

Or to permanently change the limit create the file `/Library/LaunchDaemons/limit.maxfiles.plist`:

```xml
<?xml version="1.0" encoding="UTF-8"?> 
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" 
        "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0"> 
  <dict>
    <key>Label</key>
    <string>limit.maxfiles</string>
    <key>ProgramArguments</key>
    <array>
      <string>launchctl</string>
      <string>limit</string>
      <string>maxfiles</string>
      <string>64000</string>
      <string>524288</string>
    </array>
    <key>RunAtLoad</key>
    <true/>
    <key>ServiceIPC</key>
    <false/>
  </dict>
</plist>
```

Then run:

```
sudo chmod 600 /Library/LaunchDaemons/limit.maxfiles.plist
sudo chown root /Library/LaunchDaemons/limit.maxfiles.plist
sudo launchctl load -w /Library/LaunchDaemons/limit.maxfiles.plist
```