Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
caddy
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Łukasz Nowak
caddy
Commits
130301e3
Commit
130301e3
authored
May 28, 2015
by
Matt Holt
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #92 from abiosoft/master
Git: code refactor. replace Sleep with Ticker
parents
ee059c09
2013838b
Changes
7
Show whitespace changes
Inline
Side-by-side
Showing
7 changed files
with
148 additions
and
101 deletions
+148
-101
config/setup/git_test.go
config/setup/git_test.go
+3
-3
middleware/git/git.go
middleware/git/git.go
+4
-3
middleware/git/git_test.go
middleware/git/git_test.go
+1
-1
middleware/git/gitos/gitos.go
middleware/git/gitos/gitos.go
+43
-0
middleware/git/gittest/gittest.go
middleware/git/gittest/gittest.go
+31
-2
middleware/git/service.go
middleware/git/service.go
+47
-73
middleware/git/service_test.go
middleware/git/service_test.go
+19
-19
No files found.
config/setup/git_test.go
View file @
130301e3
...
...
@@ -57,14 +57,14 @@ func TestIntervals(t *testing.T) {
check
(
t
,
err
)
// wait for first background pull
time
.
Sleep
(
time
.
Millisecond
*
100
)
gittest
.
Sleep
(
time
.
Millisecond
*
100
)
// switch logger to test file
logFile
:=
gittest
.
Open
(
"file"
)
git
.
Logger
=
log
.
New
(
logFile
,
""
,
0
)
// sleep for the interval
time
.
Sleep
(
repo
.
Interval
)
gittest
.
Sleep
(
repo
.
Interval
)
// get log output
out
,
err
:=
ioutil
.
ReadAll
(
logFile
)
...
...
@@ -87,7 +87,7 @@ No new changes.`
}
// stop background thread monitor
git
.
Monitor
.
StopAndWait
(
repo
.
URL
,
1
)
git
.
Services
.
Stop
(
repo
.
URL
,
1
)
}
...
...
middleware/git/git.go
View file @
130301e3
...
...
@@ -33,8 +33,9 @@ var initMutex = sync.Mutex{}
// Logger is used to log errors; if nil, the default log.Logger is used.
var
Logger
*
log
.
Logger
// Monitor listens for halt signal to stop repositories from auto pulling.
var
Monitor
=
&
monitor
{}
// Services holds all git pulling services and provides the function to
// stop them.
var
Services
=
&
services
{}
// logger is an helper function to retrieve the available logger
func
logger
()
*
log
.
Logger
{
...
...
@@ -67,7 +68,7 @@ func (r *Repo) Pull() error {
defer
r
.
Unlock
()
// prevent a pull if the last one was less than 5 seconds ago
if
time
.
Since
(
r
.
lastPull
)
<
5
*
time
.
Second
{
if
gos
.
Time
Since
(
r
.
lastPull
)
<
5
*
time
.
Second
{
return
nil
}
...
...
middleware/git/git_test.go
View file @
130301e3
...
...
@@ -160,7 +160,7 @@ Command echo Hello successful.
before
:=
r
.
repo
.
lastPull
time
.
Sleep
(
r
.
repo
.
Interval
)
gittest
.
Sleep
(
r
.
repo
.
Interval
)
err
=
r
.
repo
.
Pull
()
after
:=
r
.
repo
.
lastPull
...
...
middleware/git/gitos/gitos.go
View file @
130301e3
...
...
@@ -5,6 +5,7 @@ import (
"io/ioutil"
"os"
"os/exec"
"time"
)
// File is an abstraction for file (os.File).
...
...
@@ -114,6 +115,33 @@ type OS interface {
// beginning with prefix, opens the file for reading and writing, and
// returns the resulting File.
TempFile
(
string
,
string
)
(
File
,
error
)
// Sleep pauses the current goroutine for at least the duration d. A
// negative or zero duration causes Sleep to return immediately.
Sleep
(
time
.
Duration
)
// NewTicker returns a new Ticker containing a channel that will send the
// time with a period specified by the argument.
NewTicker
(
time
.
Duration
)
Ticker
// TimeSince returns the time elapsed since the argument.
TimeSince
(
time
.
Time
)
time
.
Duration
}
// Ticker is an abstraction for Ticker (time.Ticker)
type
Ticker
interface
{
C
()
<-
chan
time
.
Time
Stop
()
}
// GitTicker is the implementation of Ticker for git.
type
GitTicker
struct
{
*
time
.
Ticker
}
// C returns the channel on which the ticks are delivered.s
func
(
g
*
GitTicker
)
C
()
<-
chan
time
.
Time
{
return
g
.
Ticker
.
C
}
// GitOS is the implementation of OS for git.
...
...
@@ -158,3 +186,18 @@ func (g GitOS) ReadDir(dirname string) ([]os.FileInfo, error) {
func
(
g
GitOS
)
Command
(
name
string
,
args
...
string
)
Cmd
{
return
&
gitCmd
{
exec
.
Command
(
name
,
args
...
)}
}
// Sleep calls time.Sleep.
func
(
g
GitOS
)
Sleep
(
d
time
.
Duration
)
{
time
.
Sleep
(
d
)
}
// New Ticker calls time.NewTicker.
func
(
g
GitOS
)
NewTicker
(
d
time
.
Duration
)
Ticker
{
return
&
GitTicker
{
time
.
NewTicker
(
d
)}
}
// TimeSince calls time.Since
func
(
g
GitOS
)
TimeSince
(
t
time
.
Time
)
time
.
Duration
{
return
time
.
Since
(
t
)
}
middleware/git/gittest/gittest.go
View file @
130301e3
...
...
@@ -19,6 +19,9 @@ var CmdOutput = "success"
// TempFileName is the name of any file returned by mocked gitos.OS's TempFile().
var
TempFileName
=
"tempfile"
// TimeSpeed is how faster the mocked gitos.Ticker and gitos.Sleep should run.
var
TimeSpeed
=
5
// dirs mocks a fake git dir if filename is "gitdir".
var
dirs
=
map
[
string
][]
os
.
FileInfo
{
"gitdir"
:
{
...
...
@@ -31,6 +34,11 @@ func Open(name string) gitos.File {
return
&
fakeFile
{
name
:
name
}
}
// Sleep calls fake time.Sleep
func
Sleep
(
d
time
.
Duration
)
{
FakeOS
.
Sleep
(
d
)
}
// fakeFile is a mock gitos.File.
type
fakeFile
struct
{
name
string
...
...
@@ -70,7 +78,7 @@ func (f *fakeFile) Write(b []byte) (int, error) {
return
len
(
b
),
nil
}
// fakeCmd is a mock git.Cmd.
// fakeCmd is a mock git
os
.Cmd.
type
fakeCmd
struct
{}
func
(
f
fakeCmd
)
Run
()
error
{
...
...
@@ -128,7 +136,16 @@ func (f fakeInfo) Sys() interface{} {
return
nil
}
// fakeOS is a mock git.OS.
// fakeTicker is a mock gitos.Ticker
type
fakeTicker
struct
{
*
time
.
Ticker
}
func
(
f
fakeTicker
)
C
()
<-
chan
time
.
Time
{
return
f
.
Ticker
.
C
}
// fakeOS is a mock gitos.OS.
type
fakeOS
struct
{}
func
(
f
fakeOS
)
Mkdir
(
name
string
,
perm
os
.
FileMode
)
error
{
...
...
@@ -165,3 +182,15 @@ func (f fakeOS) ReadDir(dirname string) ([]os.FileInfo, error) {
func
(
f
fakeOS
)
Command
(
name
string
,
args
...
string
)
gitos
.
Cmd
{
return
fakeCmd
{}
}
func
(
f
fakeOS
)
Sleep
(
d
time
.
Duration
)
{
time
.
Sleep
(
d
/
time
.
Duration
(
TimeSpeed
))
}
func
(
f
fakeOS
)
NewTicker
(
d
time
.
Duration
)
gitos
.
Ticker
{
return
&
fakeTicker
{
time
.
NewTicker
(
d
/
time
.
Duration
(
TimeSpeed
))}
}
func
(
f
fakeOS
)
TimeSince
(
t
time
.
Time
)
time
.
Duration
{
return
time
.
Since
(
t
)
*
time
.
Duration
(
TimeSpeed
)
}
middleware/git/service.go
View file @
130301e3
...
...
@@ -2,109 +2,83 @@ package git
import
(
"sync"
"time"
"github.com/mholt/caddy/middleware/git/gitos"
)
//
RepoService is the repository service that runs in background and
// p
eriodic p
ull from the repository.
type
R
epoService
struct
{
//
repoService is the service that runs in background and periodically
// pull from the repository.
type
r
epoService
struct
{
repo
*
Repo
running
bool
// whether service is running.
ticker
gitos
.
Ticker
// ticker to tick at intervals
halt
chan
struct
{}
// channel to notify service to halt and stop pulling.
exit
chan
struct
{}
// channel to notify on exit.
}
// Start starts a new
RepoService in background and adds it to monitor
.
// Start starts a new
background service to pull periodically
.
func
Start
(
repo
*
Repo
)
{
service
:=
&
R
epoService
{
service
:=
&
r
epoService
{
repo
,
true
,
make
(
chan
struct
{}),
gos
.
NewTicker
(
repo
.
Interval
),
make
(
chan
struct
{}),
}
// start service
go
func
(
s
*
RepoService
)
{
go
func
(
s
*
repoService
)
{
for
{
// if service is halted
if
!
s
.
running
{
// notify exit channel
service
.
exit
<-
struct
{}{}
break
}
time
.
Sleep
(
repo
.
Interval
)
select
{
case
<-
s
.
ticker
.
C
()
:
err
:=
repo
.
Pull
()
if
err
!=
nil
{
logger
()
.
Println
(
err
)
}
case
<-
s
.
halt
:
s
.
ticker
.
Stop
()
return
}
}
}(
service
)
// add to
monitor to enable halting
Monitor
.
add
(
service
)
// add to
services to make it stoppable
Services
.
add
(
service
)
}
// monitor monitors running services (RepoService)
// and can halt them.
type
monitor
struct
{
services
[]
*
RepoService
// services stores all repoServices
type
services
struct
{
services
[]
*
repoService
sync
.
Mutex
}
// add adds a new service to
the monitor
.
func
(
m
*
monitor
)
add
(
service
*
R
epoService
)
{
m
.
Lock
()
defer
m
.
Unlock
()
// add adds a new service to
list of services
.
func
(
s
*
services
)
add
(
r
*
r
epoService
)
{
s
.
Lock
()
defer
s
.
Unlock
()
m
.
services
=
append
(
m
.
services
,
service
)
// start a goroutine to listen for halt signal
service
.
running
=
true
go
func
(
r
*
RepoService
)
{
<-
r
.
halt
r
.
running
=
false
}(
service
)
s
.
services
=
append
(
s
.
services
,
r
)
}
// Stop stops at most `limit`
currently running services that i
s pulling from git repo at
// repoURL. It
returns list of exit channels for the services. A wait for message on the
//
channels guarantees exit.
If limit is less than zero, it is ignored.
// Stop stops at most `limit`
running service
s pulling from git repo at
// repoURL. It
waits until the service is terminated before returning.
// If limit is less than zero, it is ignored.
// TODO find better ways to identify repos
func
(
m
*
monitor
)
Stop
(
repoURL
string
,
limit
int
)
[]
chan
struct
{}
{
m
.
Lock
()
defer
m
.
Unlock
()
var
chans
[]
chan
struct
{}
func
(
s
*
services
)
Stop
(
repoURL
string
,
limit
int
)
{
s
.
Lock
()
defer
s
.
Unlock
()
// locate
service
s
for
i
,
j
:=
0
,
0
;
i
<
len
(
m
.
services
)
&&
((
limit
>=
0
&&
j
<
limit
)
||
limit
<
0
);
i
++
{
s
:=
m
.
services
[
i
]
if
s
.
repo
.
URL
==
repoURL
{
// locate
repo
s
for
i
,
j
:=
0
,
0
;
i
<
len
(
s
.
services
)
&&
((
limit
>=
0
&&
j
<
limit
)
||
limit
<
0
);
i
++
{
s
ervice
:=
s
.
services
[
i
]
if
s
ervice
.
repo
.
URL
==
repoURL
{
// send halt signal
s
.
halt
<-
struct
{}{}
chans
=
append
(
chans
,
s
.
exit
)
s
ervice
.
halt
<-
struct
{}{}
s
.
services
[
i
]
=
nil
j
++
m
.
services
[
i
]
=
nil
}
}
// remove them from
service
s list
services
:=
m
.
services
[
:
0
]
for
_
,
s
:=
range
m
.
services
{
// remove them from
repo
s list
services
:=
s
.
services
[
:
0
]
for
_
,
s
:=
range
s
.
services
{
if
s
!=
nil
{
services
=
append
(
services
,
s
)
}
}
m
.
services
=
services
return
chans
}
// StopAndWait is similar to stop but it waits for the services to terminate before
// returning.
func
(
m
*
monitor
)
StopAndWait
(
repoUrl
string
,
limit
int
)
{
chans
:=
m
.
Stop
(
repoUrl
,
limit
)
for
_
,
c
:=
range
chans
{
<-
c
}
s
.
services
=
services
}
middleware/git/service_test.go
View file @
130301e3
...
...
@@ -16,45 +16,45 @@ func Test(t *testing.T) {
repo
:=
&
Repo
{
URL
:
"git@github.com"
,
Interval
:
time
.
Second
}
Start
(
repo
)
if
len
(
Monitor
.
services
)
!=
1
{
t
.
Errorf
(
"Expected 1 service, found %v"
,
len
(
Monitor
.
services
))
if
len
(
Services
.
services
)
!=
1
{
t
.
Errorf
(
"Expected 1 service, found %v"
,
len
(
Services
.
services
))
}
Monitor
.
StopAndWait
(
repo
.
URL
,
1
)
if
len
(
Monitor
.
services
)
!=
0
{
t
.
Errorf
(
"Expected 1 service, found %v"
,
len
(
Monitor
.
services
))
Services
.
Stop
(
repo
.
URL
,
1
)
if
len
(
Services
.
services
)
!=
0
{
t
.
Errorf
(
"Expected 1 service, found %v"
,
len
(
Services
.
services
))
}
repos
:=
make
([]
*
Repo
,
5
)
for
i
:=
0
;
i
<
5
;
i
++
{
repos
[
i
]
=
&
Repo
{
URL
:
fmt
.
Sprintf
(
"test%v"
,
i
),
Interval
:
time
.
Second
*
2
}
Start
(
repos
[
i
])
if
len
(
Monitor
.
services
)
!=
i
+
1
{
t
.
Errorf
(
"Expected %v service(s), found %v"
,
i
+
1
,
len
(
Monitor
.
services
))
if
len
(
Services
.
services
)
!=
i
+
1
{
t
.
Errorf
(
"Expected %v service(s), found %v"
,
i
+
1
,
len
(
Services
.
services
))
}
}
time
.
Sleep
(
time
.
Second
*
5
)
Monitor
.
StopAndWait
(
repos
[
0
]
.
URL
,
1
)
if
len
(
Monitor
.
services
)
!=
4
{
t
.
Errorf
(
"Expected %v service(s), found %v"
,
4
,
len
(
Monitor
.
services
))
gos
.
Sleep
(
time
.
Second
*
5
)
Services
.
Stop
(
repos
[
0
]
.
URL
,
1
)
if
len
(
Services
.
services
)
!=
4
{
t
.
Errorf
(
"Expected %v service(s), found %v"
,
4
,
len
(
Services
.
services
))
}
repo
=
&
Repo
{
URL
:
"git@github.com"
,
Interval
:
time
.
Second
}
Start
(
repo
)
if
len
(
Monitor
.
services
)
!=
5
{
t
.
Errorf
(
"Expected %v service(s), found %v"
,
5
,
len
(
Monitor
.
services
))
if
len
(
Services
.
services
)
!=
5
{
t
.
Errorf
(
"Expected %v service(s), found %v"
,
5
,
len
(
Services
.
services
))
}
repo
=
&
Repo
{
URL
:
"git@github.com"
,
Interval
:
time
.
Second
*
2
}
Start
(
repo
)
if
len
(
Monitor
.
services
)
!=
6
{
t
.
Errorf
(
"Expected %v service(s), found %v"
,
6
,
len
(
Monitor
.
services
))
if
len
(
Services
.
services
)
!=
6
{
t
.
Errorf
(
"Expected %v service(s), found %v"
,
6
,
len
(
Services
.
services
))
}
time
.
Sleep
(
time
.
Second
*
5
)
Monitor
.
StopAndWait
(
repo
.
URL
,
-
1
)
if
len
(
Monitor
.
services
)
!=
4
{
t
.
Errorf
(
"Expected %v service(s), found %v"
,
4
,
len
(
Monitor
.
services
))
gos
.
Sleep
(
time
.
Second
*
5
)
Services
.
Stop
(
repo
.
URL
,
-
1
)
if
len
(
Services
.
services
)
!=
4
{
t
.
Errorf
(
"Expected %v service(s), found %v"
,
4
,
len
(
Services
.
services
))
}
}
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment