aboutsummaryrefslogtreecommitdiff
path: root/ci/retry/README.md
blob: 983a4980708409020797091f1a73cbd0b6662b3f (plain)
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
117
118
119
120
121
122
123
retry - The command line retry tool
------------------------------------------

Retry any shell command with exponential backoff or constant delay.

### Instructions

Install:

retry is a shell script, so drop it somewhere and make sure it's added to your $PATH. Or you can use the following one-liner:

```sh
sudo sh -c "curl https://raw.githubusercontent.com/kadwanev/retry/master/retry -o /usr/local/bin/retry && chmod +x /usr/local/bin/retry"
```

If you're on OS X, retry is also on Homebrew:

```
brew pull 27283
brew install retry
```
Not popular enough for homebrew-core. Please star this project to help.

### Usage

Help:

`retry -?`

    Usage: retry [options] -- execute command
        -h, -?, --help
        -v, --verbose                    Verbose output
        -t, --tries=#                    Set max retries: Default 10
        -s, --sleep=secs                 Constant sleep amount (seconds)
        -m, --min=secs                   Exponenetial Backoff: minimum sleep amount (seconds): Default 0.3
        -x, --max=secs                   Exponenetial Backoff: maximum sleep amount (seconds): Default 60
        -f, --fail="script +cmds"        Fail Script: run in case of final failure

### Examples

No problem:

`retry echo u work good`

    u work good

Test functionality:

`retry 'echo "y u no work"; false'`

    y u no work
    Before retry #1: sleeping 0.3 seconds
    y u no work
    Before retry #2: sleeping 0.6 seconds
    y u no work
    Before retry #3: sleeping 1.2 seconds
    y u no work
    Before retry #4: sleeping 2.4 seconds
    y u no work
    Before retry #5: sleeping 4.8 seconds
    y u no work
    Before retry #6: sleeping 9.6 seconds
    y u no work
    Before retry #7: sleeping 19.2 seconds
    y u no work
    Before retry #8: sleeping 38.4 seconds
    y u no work
    Before retry #9: sleeping 60.0 seconds
    y u no work
    Before retry #10: sleeping 60.0 seconds
    y u no work
    etc..

Limit retries:

`retry -t 4 'echo "y u no work"; false'`

    y u no work
    Before retry #1: sleeping 0.3 seconds
    y u no work
    Before retry #2: sleeping 0.6 seconds
    y u no work
    Before retry #3: sleeping 1.2 seconds
    y u no work
    Before retry #4: sleeping 2.4 seconds
    y u no work
    Retries exhausted

Bad command:

`retry poop`

    bash: poop: command not found

Fail command:

`retry -t 3 -f 'echo "oh poopsickles"' 'echo "y u no work"; false'`

    y u no work
    Before retry #1: sleeping 0.3 seconds
    y u no work
    Before retry #2: sleeping 0.6 seconds
    y u no work
    Before retry #3: sleeping 1.2 seconds
    y u no work
    Retries exhausted, running fail script
    oh poopsickles

Last attempt passed:

`retry -t 3 -- 'if [ $RETRY_ATTEMPT -eq 3 ]; then echo Passed at attempt $RETRY_ATTEMPT; true; else echo Failed at attempt $RETRY_ATTEMPT; false; fi;'`

    Failed at attempt 0
    Before retry #1: sleeping 0.3 seconds
    Failed at attempt 1
    Before retry #2: sleeping 0.6 seconds
    Failed at attempt 2
    Before retry #3: sleeping 1.2 seconds
    Passed at attempt 3

### License

Apache 2.0 - go nuts