Compare commits
30 Commits
v1.12
...
v1.15.beta
Author | SHA1 | Date | |
---|---|---|---|
|
2d409fbce0 | ||
|
550dc01dfb | ||
|
d0492bad8c | ||
|
55625d51bc | ||
|
8ddc124f89 | ||
|
8b7042411c | ||
|
b72caedcbb | ||
|
f989590d14 | ||
|
f2afa015bd | ||
|
dc7162b57d | ||
|
8828bcaed6 | ||
|
7d2e8dd34d | ||
|
bb80977213 | ||
|
1b4206a6b3 | ||
|
3351429515 | ||
|
00e34193aa | ||
|
4e0b9f54f6 | ||
|
9defc968ba | ||
|
66eee100f2 | ||
|
9e4642d0c2 | ||
|
44bb0dd65f | ||
|
eeaad58d1e | ||
|
44051b9184 | ||
|
a2daa98d08 | ||
|
97bdcb644c | ||
|
a0137807f3 | ||
|
b0a0e296d2 | ||
|
e63d200382 | ||
|
cb86b0dbe6 | ||
|
bead88c5e2 |
1
.gitignore
vendored
1
.gitignore
vendored
@@ -6,3 +6,4 @@ fileboy-darwin-amd64.bin
|
||||
fileboy-linux-amd64.bin
|
||||
fileboy-windows-amd64.exe
|
||||
./bin/*
|
||||
.fileboy.pid
|
||||
|
18
.travis.yml
18
.travis.yml
@@ -11,11 +11,17 @@ dist: bionic # ubuntu 18.04
|
||||
|
||||
script:
|
||||
- make init
|
||||
- make build-linux
|
||||
- ls bin
|
||||
- ./bin/fileboy-linux-amd64.bin version
|
||||
- ./bin/fileboy-linux-amd64.bin help
|
||||
- ./bin/fileboy-linux-amd64.bin init
|
||||
- make build-all
|
||||
- ls -al bin
|
||||
- echo $PATH
|
||||
- cp bin/fileboy-linux-amd64.bin /home/travis/bin/fileboy
|
||||
- fileboy version
|
||||
- fileboy help
|
||||
- fileboy init
|
||||
- cat filegirl.yaml
|
||||
- ./bin/fileboy-linux-amd64.bin exec
|
||||
- fileboy exec
|
||||
- fileboy deamon
|
||||
- ls -al .fileboy.pid
|
||||
- ps aux | grep fileboy
|
||||
- fileboy stop
|
||||
|
||||
|
20
CHANGELOG.md
20
CHANGELOG.md
@@ -1,3 +1,23 @@
|
||||
### Release v1.15
|
||||
|
||||
2020.01.02
|
||||
|
||||
- 增加 指令配置项 `instruction`, 可以通过预定义的指令来控制 command 的行为
|
||||
- 增加 `should-finish` 指令
|
||||
- 增加 `exec-when-start` 指令
|
||||
- 增加 `ignore-warn` 指令
|
||||
- 增加 `ignore-info` 指令
|
||||
- 增加 `ignore-stdout` 指令
|
||||
- 增加 `ignore-exec-error` 指令
|
||||
|
||||
|
||||
2019.12.28
|
||||
|
||||
- 增加 `deamon`命令,支持以守护进程的方式运行在后台 **Unix only**
|
||||
- 增加 `stop`命令,用来停止 deamon 进程 **Unix only**
|
||||
- 优化 exec stdout
|
||||
|
||||
|
||||
### Release v1.12
|
||||
|
||||
2019.12.18
|
||||
|
61
README.md
61
README.md
@@ -17,6 +17,7 @@ fileboy,文件变更监听通知系统,使用 Go 编写。
|
||||
- 命令支持变量占位符
|
||||
- 支持冗余任务丢弃,自定义冗余任务范围
|
||||
- 支持 http 通知
|
||||
- 高级指令用法
|
||||
- 更多...
|
||||
|
||||
## 编译环境
|
||||
@@ -31,8 +32,8 @@ go version 1.13
|
||||
|
||||
### 下载二进制文件
|
||||
|
||||
Github: [download v1.12](https://github.com/dengsgo/fileboy/releases)
|
||||
Gitee: [dowmload v1.12](https://gitee.com/dengsgo/fileboy/releases)
|
||||
Github: [download v1.15](https://github.com/dengsgo/fileboy/releases)
|
||||
Gitee: [dowmload v1.15](https://gitee.com/dengsgo/fileboy/releases)
|
||||
|
||||
下载已经编译好的对应平台二进制文件,重命名为`fileboy`, 加入系统 Path 中即可。
|
||||
|
||||
@@ -137,45 +138,49 @@ notifier:
|
||||
# 请求超时 15 秒
|
||||
# POST 格式:
|
||||
# Content-Type: application/json;charset=UTF-8
|
||||
# User-Agent: FileBoy Net Notifier v1.12
|
||||
# User-Agent: FileBoy Net Notifier v1.15
|
||||
# Body: {"project_folder":"/project/path","file":"main.go","changed":1576567861913824940,"ext":".go","event":"write"}
|
||||
# 例: http://example.com/notifier/fileboy-listener
|
||||
# 不启用通知,请留空 ""
|
||||
callUrl: ""
|
||||
|
||||
# 特殊指令
|
||||
instruction:
|
||||
# 可以通过特殊的指令选项来控制 command 的行为,指令可以有多个
|
||||
# 指令选项解释:
|
||||
# exec-when-start fileboy启动就绪后,自动执行一次 'exec' 定义的命令
|
||||
# should-finish 触发执行 'exec' 时(C),如果上一次的命令(L)未退出(还在执行),会等待 L 退出(而不是强制 kill ),直到 L 有明确 exit code 才会开始执行本次命令。
|
||||
# 在等待 L 退出时,又有新事件触发了命令执行(N),则 C 执行取消,只会保留最后一次的 N 执行
|
||||
# ignore-stdout 执行 'exec' 产生的 stdout 会被丢弃
|
||||
# ignore-warn fileboy 自身的 warn 信息会被丢弃
|
||||
# ignore-info fileboy 自身的 info 信息会被丢弃
|
||||
# ignore-exec-error 执行 'exec' 出错仍继续执行下面的命令而不退出
|
||||
|
||||
#- should-finish
|
||||
#- exec-when-start
|
||||
- ignore-warn
|
||||
```
|
||||
|
||||
### TODO
|
||||
|
||||
- [x] 命令支持变量占位符
|
||||
- [x] 支持多命令
|
||||
- [x] 支持监听指定文件夹
|
||||
- [x] 支持不监听指定文件夹
|
||||
- [x] 支持监听指定后缀文件
|
||||
- [x] 支持自定事件监听
|
||||
- [x] 支持 http 通知
|
||||
- [x] 支持冗余任务丢弃
|
||||
- [ ] 支持 http 合并任务的通知
|
||||
|
||||
## QA
|
||||
|
||||
#### 很多框架都自带了 hot reload 的功能,为什么还要单独写个 fileboy 呢?
|
||||
### 很多框架都自带了 hot reload 的功能,为什么还要单独写个 fileboy 呢?
|
||||
|
||||
这个是一款通用的 hot reload 的软件,理论上适用于任何需要 hot reload 的场景,并不局限于语言层面上。只要灵活的配置 `filegirl.yaml`文件就行了。
|
||||
|
||||
#### fileboy 可以应用在那些具体的场景?
|
||||
### fileboy 可以应用在那些具体的场景?
|
||||
|
||||
在开发中,我们很需要一款可以帮助我们自动打包编译的工具,那 fileboy 就非常适合这样的场景。比如 go 项目的热编译,让我们可以边修改代码边运行得到反馈。又比如 PHP Swoole 框架,由于常驻进程的原因,无法更改代码立即reload,使用 fileboy 就可以辅助做到传统 PHP 开发的体验。
|
||||
对于一些需要监控文件日志或者配置变动的场景, fileboy 同样适合。你可以事先编写好相应的通知报警脚本,然后定义`filegirl.yaml`中的`command`命令,交由 fileboy 自动运行监控报警。
|
||||
|
||||
#### 通知器在什么时候会发送 http 请求 ?
|
||||
### 通知器在什么时候会发送 http 请求 ?
|
||||
|
||||
通知器发送 http 通知的前提是在配置文件中设置了 `callUrl` 参数(不为空即为已设置)。触发请求的时机和执行 command 命令是一致的,`command -> delayMillSecond` 参数对于触发器同样有效。请求超时默认15秒.
|
||||
|
||||
#### idea 下更改文件,为什么会执行两次或者多次 command ?
|
||||
### idea 下更改文件,为什么会执行两次或者多次 command ?
|
||||
|
||||
由于 idea 系列软件特殊的文件保存策略,他会自动创建一些临时文件,并且在需要时多次重写文件,所以有时反映在文件上就是有多次的更改,所以会出现这种情况。1.5之后的版本增加了 `delayMillSecond` 参数,可以解决这个问题。
|
||||
|
||||
#### filegirl.yaml 里面的 command 如何配置复杂命令?
|
||||
### filegirl.yaml 里面的 command 如何配置复杂命令?
|
||||
|
||||
fileboy 目前支持 `命令 + 参数`这种形式的 command,而且 参数中不能有""符号或者有空格。如:
|
||||
`go build`:支持;
|
||||
@@ -184,19 +189,21 @@ fileboy 目前支持 `命令 + 参数`这种形式的 command,而且 参数中
|
||||
`cat a.txt | grep "q" | wc -l`:不支持
|
||||
对于不支持的命令,可以把它写到一个文件里,然后在 command 中执行这个文件来解决。
|
||||
|
||||
#### 为什么起名为 fileboy,又把配置名叫做 filegirl ?
|
||||
### 为什么起名为 fileboy,又把配置名叫做 filegirl ?
|
||||
|
||||
因为爱情~~ (◡ᴗ◡✿)
|
||||
|
||||
|
||||
|
||||
### 贡献者
|
||||
## 贡献者
|
||||
|
||||
> 排名不分先后
|
||||
| | | |
|
||||
| ------------ | ------------ | ------------ |
|
||||
| <a href="https://github.com/dengsgo"><img src="https://avatars1.githubusercontent.com/u/7929002?s=460&v=4" width=64 style="border-radius:45px;" /></a> | <a href="https://github.com/jason-gao"><img src="https://avatars1.githubusercontent.com/u/9896574?s=460&v=4" width=64 style="border-radius:45px;" /></a> | <a href="https://github.com/itwesley"><img src="https://avatars1.githubusercontent.com/u/1928721?s=460&v=4" width=64 style="border-radius:45px;" /></a> |
|
||||
|
||||
[@dengsgo](https://www.yoytang.com) <dengsgo@gmail.com>
|
||||
## 感谢支持
|
||||
|
||||
[@itwesley](https://github.com/itwesley) <wcshen1126@gmail.com>
|
||||
|
||||
[@jason-gao](https://github.com/jason-gao) <3048789891@qq.com>
|
||||
| |
|
||||
| ------------ |
|
||||
| <a href="https://www.jetbrains.com/?from=fileboy"><img src="./resources/jetbrains.png" width=140 /></a> |
|
||||
|
||||
|
37
README_EN.md
37
README_EN.md
@@ -17,6 +17,7 @@ For Hot Reload scenarios (typically for developing go projects without having to
|
||||
- Command support variable placeholders
|
||||
- Supporting redundant task discarding and customizing redundant task scope
|
||||
- Supporting HTTP notifications
|
||||
- Advanced instruction usage
|
||||
- more...
|
||||
|
||||
## COMPILE
|
||||
@@ -32,8 +33,8 @@ go version 1.13
|
||||
|
||||
### BINARIES
|
||||
|
||||
Github: [download v1.12](https://github.com/dengsgo/fileboy/releases)
|
||||
Gitee: [dowmload v1.12](https://gitee.com/dengsgo/fileboy/releases)
|
||||
Github: [download v1.15](https://github.com/dengsgo/fileboy/releases)
|
||||
Gitee: [dowmload v1.15](https://gitee.com/dengsgo/fileboy/releases)
|
||||
|
||||
Download the compiled binary file of the corresponding platform, rename it `fileboy`, and add it to the system Path.
|
||||
|
||||
@@ -133,18 +134,40 @@ notifier:
|
||||
# timeout 15 second
|
||||
# POST :
|
||||
# Content-Type: application/json;charset=UTF-8
|
||||
# User-Agent: FileBoy Net Notifier v1.12
|
||||
# User-Agent: FileBoy Net Notifier v1.15
|
||||
# Body: {"project_folder":"/project/path","file":"main.go","changed":1576567861913824940,"ext":".go","event":"write"}
|
||||
# e.g: http://example.com/notifier/fileboy-listener
|
||||
# no notice is enabled. Please leave it blank. ""
|
||||
callUrl: ""
|
||||
|
||||
instruction:
|
||||
# command behavior can be controlled by special command options. there can be multiple instructions
|
||||
# options:
|
||||
# exec-when-start when fileboy is ready to start, execute the command defined by 'exec' once automatically
|
||||
# should-finish when the execution of 'exec' is triggered (C), if the last command (L) does not exit (still executing),
|
||||
# it will wait for L to exit (instead of forcing kill), and the execution of this command will not start until L has an explicit exit code.
|
||||
# when waiting for L to exit, and a new event triggers command execution (n), C execution is cancelled, and only the last N execution is retained
|
||||
# ignore-stdout stdout generated by executing 'exec' will be discarded
|
||||
# ignore-warn the warn information of fileboy itself will be discarded
|
||||
# ignore-info the info information of fileboy itself will be discarded
|
||||
# ignore-exec-error error executing 'exec' continue to execute the following command without exiting
|
||||
|
||||
#- should-finish
|
||||
#- exec-when-start
|
||||
- ignore-warn
|
||||
```
|
||||
|
||||
### CONTRIBUTOR
|
||||
## CONTRIBUTOR
|
||||
|
||||
[@dengsgo](https://www.yoytang.com) <dengsgo@gmail.com>
|
||||
| | | |
|
||||
| ------------ | ------------ | ------------ |
|
||||
| <a href="https://github.com/dengsgo"><img src="https://avatars1.githubusercontent.com/u/7929002?s=460&v=4" width=64 style="border-radius:45px;" /></a> | <a href="https://github.com/jason-gao"><img src="https://avatars1.githubusercontent.com/u/9896574?s=460&v=4" width=64 style="border-radius:45px;" /></a> | <a href="https://github.com/itwesley"><img src="https://avatars1.githubusercontent.com/u/1928721?s=460&v=4" width=64 style="border-radius:45px;" /></a> |
|
||||
|
||||
[@itwesley](https://github.com/itwesley) <wcshen1126@gmail.com>
|
||||
|
||||
[@jason-gao](https://github.com/jason-gao) <3048789891@qq.com>
|
||||
|
||||
## THANKS
|
||||
|
||||
| |
|
||||
| ------------ |
|
||||
| <a href="https://www.jetbrains.com/?from=fileboy"><img src="./resources/jetbrains.png" width=140></a> |
|
||||
|
||||
|
50
deamon.go
Normal file
50
deamon.go
Normal file
@@ -0,0 +1,50 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"io/ioutil"
|
||||
"os"
|
||||
"os/exec"
|
||||
"runtime"
|
||||
"strconv"
|
||||
)
|
||||
|
||||
func getPidFile() string {
|
||||
return projectFolder + "/.fileboy.pid"
|
||||
}
|
||||
|
||||
func runAsDeamon() (int, error) {
|
||||
if runtime.GOOS == "windows" {
|
||||
logAndExit("daemons mode cannot run on windows.")
|
||||
}
|
||||
err := stopDeamon()
|
||||
if err != nil {
|
||||
logAndExit(err)
|
||||
}
|
||||
_, err = exec.LookPath("fileboy")
|
||||
if err != nil {
|
||||
logAndExit("cannot found `fileboy` command in the PATH")
|
||||
}
|
||||
deamon := exec.Command("fileboy")
|
||||
deamon.Dir = projectFolder
|
||||
deamon.Env = os.Environ()
|
||||
deamon.Stdout = os.Stdout
|
||||
err = deamon.Start()
|
||||
if err != nil {
|
||||
logAndExit(err)
|
||||
}
|
||||
pid := deamon.Process.Pid
|
||||
if pid != 0 {
|
||||
ioutil.WriteFile(getPidFile(), []byte(strconv.Itoa(pid)), 0644)
|
||||
}
|
||||
return pid, nil
|
||||
}
|
||||
|
||||
func stopDeamon() error {
|
||||
bs, err := ioutil.ReadFile(getPidFile())
|
||||
if err != nil {
|
||||
return nil
|
||||
}
|
||||
_ = exec.Command("kill", string(bs)).Run()
|
||||
os.Remove(getPidFile())
|
||||
return nil
|
||||
}
|
97
fileboy.go
97
fileboy.go
@@ -2,8 +2,6 @@ package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"gopkg.in/fsnotify/fsnotify.v1"
|
||||
"gopkg.in/yaml.v2"
|
||||
"io/ioutil"
|
||||
"log"
|
||||
"math/rand"
|
||||
@@ -12,13 +10,20 @@ import (
|
||||
"strconv"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"gopkg.in/fsnotify/fsnotify.v1"
|
||||
"gopkg.in/yaml.v2"
|
||||
)
|
||||
|
||||
const (
|
||||
Version = 1
|
||||
|
||||
PreError = "ERROR:"
|
||||
PreWarn = "Warn:"
|
||||
InstExecWhenStart = "exec-when-start"
|
||||
InstShouldFinish = "should-finish"
|
||||
InstIgnoreWarn = "ignore-warn"
|
||||
InstIgnoreInfo = "ignore-info"
|
||||
InstIgnoreStdout = "ignore-stdout"
|
||||
InstIgnoreExecError = "ignore-exec-error"
|
||||
)
|
||||
|
||||
var (
|
||||
@@ -52,30 +57,37 @@ func parseConfig() {
|
||||
cfg = new(FileGirl)
|
||||
fc, err := ioutil.ReadFile(getFileGirlPath())
|
||||
if err != nil {
|
||||
log.Println(PreError, "The filegirl.yaml file in", projectFolder, "is not exist! ", err)
|
||||
logError("the filegirl.yaml file in", projectFolder, "is not exist! ", err)
|
||||
fmt.Print(firstRunHelp)
|
||||
logAndExit("Fileboy unable to run.")
|
||||
logAndExit("fileboy unable to run.")
|
||||
}
|
||||
err = yaml.Unmarshal(fc, cfg)
|
||||
if err != nil {
|
||||
logAndExit(PreError, "Parsed filegirl.yaml failed: ", err)
|
||||
logAndExit("parsed filegirl.yaml failed: ", err)
|
||||
}
|
||||
if cfg.Core.Version > Version {
|
||||
logAndExit(PreError, "Current fileboy support max version : ", Version)
|
||||
logAndExit("current fileboy support max version : ", Version)
|
||||
}
|
||||
// init map
|
||||
cfg.Monitor.TypesMap = map[string]bool{}
|
||||
cfg.Monitor.IncludeDirsMap = map[string]bool{}
|
||||
cfg.Monitor.ExceptDirsMap = map[string]bool{}
|
||||
cfg.Monitor.IncludeDirsRec = map[string]bool{}
|
||||
cfg.InstructionMap = map[string]bool{}
|
||||
// convert to map
|
||||
for _, v := range cfg.Monitor.Types {
|
||||
cfg.Monitor.TypesMap[v] = true
|
||||
}
|
||||
log.Println(cfg)
|
||||
for _, v := range cfg.Instruction {
|
||||
cfg.InstructionMap[v] = true
|
||||
}
|
||||
log.Printf("%+v", cfg)
|
||||
}
|
||||
|
||||
func eventDispatcher(event fsnotify.Event) {
|
||||
if event.Name == getPidFile() {
|
||||
return
|
||||
}
|
||||
ext := path.Ext(event.Name)
|
||||
if len(cfg.Monitor.Types) > 0 &&
|
||||
!keyInMonitorTypesMap(".*", cfg) &&
|
||||
@@ -97,15 +109,15 @@ func eventDispatcher(event fsnotify.Event) {
|
||||
}
|
||||
|
||||
func addWatcher() {
|
||||
log.Println("collecting directory information...")
|
||||
logInfo("collecting directory information...")
|
||||
dirsMap := map[string]bool{}
|
||||
for _, dir := range cfg.Monitor.IncludeDirs {
|
||||
darr := dirParse2Array(dir)
|
||||
if len(darr) < 1 || len(darr) > 2 {
|
||||
logAndExit(PreError, "filegirl section monitor dirs is error. ", dir)
|
||||
logAndExit("filegirl section monitor dirs is error. ", dir)
|
||||
}
|
||||
if strings.HasPrefix(darr[0], "/") {
|
||||
logAndExit(PreError, "dirs must be relative paths ! err path:", dir)
|
||||
logAndExit("dirs must be relative paths ! err path:", dir)
|
||||
}
|
||||
if darr[0] == "." {
|
||||
if len(darr) == 2 && darr[1] == "*" {
|
||||
@@ -135,7 +147,7 @@ func addWatcher() {
|
||||
}
|
||||
for _, dir := range cfg.Monitor.ExceptDirs {
|
||||
if dir == "." {
|
||||
logAndExit(PreError, "exceptDirs must is not project root path ! err path:", dir)
|
||||
logAndExit("exceptDirs must is not project root path ! err path:", dir)
|
||||
}
|
||||
p := projectFolder + "/" + dir
|
||||
delete(dirsMap, p)
|
||||
@@ -144,14 +156,14 @@ func addWatcher() {
|
||||
})
|
||||
}
|
||||
for dir := range dirsMap {
|
||||
log.Println("watcher add -> ", dir)
|
||||
logInfo("watcher add -> ", dir)
|
||||
err := watcher.Add(dir)
|
||||
if err != nil {
|
||||
logAndExit(PreError, err)
|
||||
logAndExit(err)
|
||||
}
|
||||
}
|
||||
log.Println("total monitored dirs: " + strconv.Itoa(len(dirsMap)))
|
||||
log.Println("fileboy is ready.")
|
||||
logInfo("total monitored dirs: " + strconv.Itoa(len(dirsMap)))
|
||||
logInfo("fileboy is ready.")
|
||||
cfg.Monitor.DirsMap = dirsMap
|
||||
}
|
||||
|
||||
@@ -180,7 +192,7 @@ func initWatcher() {
|
||||
if !ok {
|
||||
return
|
||||
}
|
||||
log.Println(PreError, err)
|
||||
logError(err)
|
||||
}
|
||||
}
|
||||
}()
|
||||
@@ -215,9 +227,9 @@ func watchChangeHandler(event fsnotify.Event) {
|
||||
err := watcher.Add(event.Name)
|
||||
if err == nil {
|
||||
do = true
|
||||
log.Println("watcher add -> ", event.Name)
|
||||
logInfo("watcher add -> ", event.Name)
|
||||
} else {
|
||||
log.Println(PreWarn, "watcher add faild:", event.Name, err)
|
||||
logWarn("watcher add faild:", event.Name, err)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -230,37 +242,56 @@ func watchChangeHandler(event fsnotify.Event) {
|
||||
_ = watcher.Remove(event.Name)
|
||||
err := watcher.Add(event.Name)
|
||||
if err == nil {
|
||||
log.Println("watcher add -> ", event.Name)
|
||||
logInfo("watcher add -> ", event.Name)
|
||||
} else {
|
||||
log.Println(PreWarn, "watcher add faild:", event.Name, err)
|
||||
logWarn("watcher add faild:", event.Name, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func parseArgs() {
|
||||
switch len(os.Args) {
|
||||
case 1:
|
||||
switch {
|
||||
case len(os.Args) == 1:
|
||||
show()
|
||||
parseConfig()
|
||||
done := make(chan bool)
|
||||
initWatcher()
|
||||
defer watcher.Close()
|
||||
if keyInInstruction(InstExecWhenStart) {
|
||||
taskMan.run(new(changedFile))
|
||||
}
|
||||
<-done
|
||||
return
|
||||
case 2:
|
||||
case len(os.Args) > 1:
|
||||
c := os.Args[1]
|
||||
switch c {
|
||||
case "deamon":
|
||||
pid, err := runAsDeamon()
|
||||
if err != nil {
|
||||
logAndExit(err)
|
||||
}
|
||||
logUInfo("PID:", pid)
|
||||
logUInfo("fileboy is ready. the main process will run as a daemons")
|
||||
return
|
||||
case "stop":
|
||||
err := stopDeamon()
|
||||
if err != nil {
|
||||
logAndExit(err)
|
||||
}
|
||||
logUInfo("fileboy daemon is stoped.")
|
||||
return
|
||||
case "init":
|
||||
_, err := ioutil.ReadFile(getFileGirlPath())
|
||||
if err == nil {
|
||||
log.Println(PreError, "Profile filegirl.yaml already exists.")
|
||||
logAndExit("If you want to regenerate filegirl.yaml, delete it first")
|
||||
logError("profile filegirl.yaml already exists.")
|
||||
logAndExit("delete it first when you want to regenerate filegirl.yaml")
|
||||
}
|
||||
err = ioutil.WriteFile(getFileGirlPath(), []byte(exampleFileGirl), 0644)
|
||||
if err != nil {
|
||||
log.Println(PreError, "Profile filegirl.yaml create failed! ", err)
|
||||
logError("profile filegirl.yaml create failed! ", err)
|
||||
return
|
||||
}
|
||||
log.Println("Profile filegirl.yaml created ok")
|
||||
logUInfo("profile filegirl.yaml created ok")
|
||||
return
|
||||
case "exec":
|
||||
parseConfig()
|
||||
@@ -268,12 +299,14 @@ func parseArgs() {
|
||||
return
|
||||
case "version", "v", "-v", "--version":
|
||||
fmt.Println(versionDesc)
|
||||
default:
|
||||
case "help", "--help", "--h", "-h":
|
||||
fmt.Print(helpStr)
|
||||
default:
|
||||
logAndExit("unknown parameter, use 'fileboy help' to view available commands")
|
||||
}
|
||||
return
|
||||
default:
|
||||
logAndExit("Unknown parameters, use `fileboy help` show help info.")
|
||||
logAndExit("unknown parameters, use `fileboy help` show help info.")
|
||||
}
|
||||
}
|
||||
|
||||
@@ -293,7 +326,7 @@ func main() {
|
||||
log.SetPrefix("[FileBoy]: ")
|
||||
log.SetFlags(2)
|
||||
log.SetOutput(os.Stdout)
|
||||
show()
|
||||
// show()
|
||||
var err error
|
||||
projectFolder, err = os.Getwd()
|
||||
if err != nil {
|
||||
|
@@ -24,4 +24,8 @@ type FileGirl struct {
|
||||
Notifier struct {
|
||||
CallUrl string `yaml:"callUrl"`
|
||||
}
|
||||
Instruction []string `yaml:"instruction"`
|
||||
|
||||
// convert to
|
||||
InstructionMap map[string]bool `yaml:"-"`
|
||||
}
|
||||
|
13
notifer.go
13
notifer.go
@@ -3,7 +3,6 @@ package main
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"log"
|
||||
"net/http"
|
||||
"strings"
|
||||
"time"
|
||||
@@ -35,7 +34,7 @@ func newNetNotifier(callUrl string) *NetNotifier {
|
||||
|
||||
func (n *NetNotifier) Put(cf *changedFile) {
|
||||
if !n.CanPost {
|
||||
log.Println(PreWarn, "notifier call url ignore. ", n.CallUrl)
|
||||
logWarn("notifier call url ignore. ", n.CallUrl)
|
||||
return
|
||||
}
|
||||
n.dispatch(&postParams{
|
||||
@@ -50,7 +49,7 @@ func (n *NetNotifier) Put(cf *changedFile) {
|
||||
func (n *NetNotifier) dispatch(params *postParams) {
|
||||
b, err := json.Marshal(params)
|
||||
if err != nil {
|
||||
log.Println(PreError, "json.Marshal n.params. ", err)
|
||||
logError("json.Marshal n.params. ", err)
|
||||
return
|
||||
}
|
||||
client := &http.Client{
|
||||
@@ -58,14 +57,14 @@ func (n *NetNotifier) dispatch(params *postParams) {
|
||||
}
|
||||
req, err := http.NewRequest("POST", n.CallUrl, bytes.NewBuffer(b))
|
||||
if err != nil {
|
||||
log.Println(PreError, "http.NewRequest. ", err)
|
||||
logError("http.NewRequest. ", err)
|
||||
return
|
||||
}
|
||||
req.Header.Set("Content-Type", "application/json;charset=UTF-8")
|
||||
req.Header.Set("User-Agent", "FileBoy Net Notifier v1.12")
|
||||
req.Header.Set("User-Agent", "FileBoy Net Notifier v1.15")
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
log.Println(PreError, "notifier call failed. err:", err)
|
||||
logError("notifier call failed. err:", err)
|
||||
return
|
||||
}
|
||||
defer func() {
|
||||
@@ -76,5 +75,5 @@ func (n *NetNotifier) dispatch(params *postParams) {
|
||||
if resp.StatusCode >= 300 {
|
||||
// todo retry???
|
||||
}
|
||||
log.Println("notifier done .")
|
||||
logInfo("notifier done .")
|
||||
}
|
||||
|
28
raw.go
28
raw.go
@@ -76,11 +76,27 @@ notifier:
|
||||
# 请求超时 15 秒
|
||||
# POST 格式:
|
||||
# Content-Type: application/json;charset=UTF-8
|
||||
# User-Agent: FileBoy Net Notifier v1.12
|
||||
# User-Agent: FileBoy Net Notifier v1.15
|
||||
# Body: {"project_folder":"/project/path","file":"main.go","changed":1576567861913824940,"ext":".go","event":"write"}
|
||||
# 例: http://example.com/notifier/fileboy-listener
|
||||
# 不启用通知,请留空 ""
|
||||
callUrl: ""
|
||||
|
||||
# 特殊指令
|
||||
instruction:
|
||||
# 可以通过特殊的指令选项来控制 command 的行为,指令可以有多个
|
||||
# 指令选项解释:
|
||||
# exec-when-start fileboy启动就绪后,自动执行一次 'exec' 定义的命令
|
||||
# should-finish 触发执行 'exec' 时(C),如果上一次的命令(L)未退出(还在执行),会等待 L 退出(而不是强制 kill ),直到 L 有明确 exit code 才会开始执行本次命令。
|
||||
# 在等待 L 退出时,又有新事件触发了命令执行(N),则 C 执行取消,只会保留最后一次的 N 执行
|
||||
# ignore-stdout 执行 'exec' 产生的 stdout 会被丢弃
|
||||
# ignore-warn fileboy 自身的 warn 信息会被丢弃
|
||||
# ignore-info fileboy 自身的 info 信息会被丢弃
|
||||
# ignore-exec-error 执行 'exec' 出错仍继续执行下面的命令而不退出
|
||||
|
||||
#- should-finish
|
||||
#- exec-when-start
|
||||
- ignore-warn
|
||||
`
|
||||
|
||||
var firstRunHelp = `第一次运行 fileboy ?
|
||||
@@ -96,6 +112,10 @@ Usage of fileboy:
|
||||
初始化 fileboy, 在当前目录生成 filegirl.yaml 配置文件
|
||||
exec
|
||||
尝试运行定义的 command 命令
|
||||
deamon
|
||||
读取当前目录下的 filegirl.yaml 配置,以守护进程的方式运行在后台
|
||||
stop
|
||||
停止守护进程
|
||||
version
|
||||
查看当前版本信息
|
||||
`
|
||||
@@ -119,13 +139,13 @@ var logo = `
|
||||
_____ _ | | _____ ____) ) | | | |___| |
|
||||
| ___) | | | | | ___) | __ (| | | |\_____/
|
||||
| | _| |_| |_____| |_____| |__) ) |___| | ___
|
||||
|_| (_____)_______)_______)______/ \_____/ (___) V1.12
|
||||
|_| (_____)_______)_______)______/ \_____/ (___) V1.15
|
||||
`
|
||||
var statement = `Dengsgo [dengsgo@gmail.com] Open Source with MIT License`
|
||||
|
||||
var versionDesc = `
|
||||
Version fileboy: v1.12 filegirl: v` + strconv.Itoa(Version) + `
|
||||
Released 2019.12.18
|
||||
Version fileboy: v1.15 filegirl: v` + strconv.Itoa(Version) + `
|
||||
Released 2020.03.03
|
||||
Licence MIT
|
||||
Author dengsgo [dengsgo@gmail.com]
|
||||
Website https://github.com/dengsgo/fileboy
|
||||
|
BIN
resources/jetbrains.png
Normal file
BIN
resources/jetbrains.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 164 KiB |
98
taskman.go
98
taskman.go
@@ -1,10 +1,6 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"fmt"
|
||||
"io"
|
||||
"log"
|
||||
"os"
|
||||
"os/exec"
|
||||
"sync"
|
||||
@@ -18,18 +14,40 @@ type TaskMan struct {
|
||||
notifier *NetNotifier
|
||||
putLock sync.Mutex
|
||||
runLock sync.Mutex
|
||||
|
||||
waitChan chan bool
|
||||
waitQueue []*changedFile
|
||||
}
|
||||
|
||||
func newTaskMan(delay int, callUrl string) *TaskMan {
|
||||
return &TaskMan{
|
||||
delay: delay,
|
||||
notifier: newNetNotifier(callUrl),
|
||||
t := &TaskMan{
|
||||
delay: delay,
|
||||
notifier: newNetNotifier(callUrl),
|
||||
waitChan: make(chan bool, 1),
|
||||
waitQueue: []*changedFile{},
|
||||
}
|
||||
if keyInInstruction(InstShouldFinish) {
|
||||
go func() {
|
||||
for {
|
||||
<-t.waitChan
|
||||
if len(t.waitQueue) > 0 {
|
||||
cf := t.waitQueue[len(t.waitQueue)-1]
|
||||
if len(t.waitQueue) > 1 {
|
||||
logInfo("redundant tasks dropped:", len(t.waitQueue)-1)
|
||||
}
|
||||
t.waitQueue = []*changedFile{}
|
||||
go t.preRun(cf)
|
||||
}
|
||||
}
|
||||
}()
|
||||
}
|
||||
|
||||
return t
|
||||
}
|
||||
|
||||
func (t *TaskMan) Put(cf *changedFile) {
|
||||
if t.delay < 1 {
|
||||
t.preRun(cf)
|
||||
t.dispatcher(cf)
|
||||
return
|
||||
}
|
||||
t.putLock.Lock()
|
||||
@@ -40,15 +58,29 @@ func (t *TaskMan) Put(cf *changedFile) {
|
||||
if t.lastTaskId > cf.Changed {
|
||||
return
|
||||
}
|
||||
t.preRun(cf)
|
||||
t.dispatcher(cf)
|
||||
}()
|
||||
}
|
||||
|
||||
func (t *TaskMan) dispatcher(cf *changedFile) {
|
||||
if keyInInstruction(InstShouldFinish) {
|
||||
t.waitQueue = append(t.waitQueue, cf)
|
||||
if t.cmd == nil {
|
||||
t.waitChan <- true
|
||||
return
|
||||
}
|
||||
logInfo("waitting for the last task to finish")
|
||||
logInfo("waiting tasks:", len(t.waitQueue))
|
||||
} else {
|
||||
t.preRun(cf)
|
||||
}
|
||||
}
|
||||
|
||||
func (t *TaskMan) preRun(cf *changedFile) {
|
||||
if t.cmd != nil && t.cmd.Process != nil {
|
||||
log.Println("stop old process ")
|
||||
if err := t.cmd.Process.Kill(); err != nil {
|
||||
log.Println(PreWarn, "stopped err, reason:", err)
|
||||
logInfo("stop old process ")
|
||||
logWarn("stopped err, reason:", err)
|
||||
}
|
||||
}
|
||||
go t.run(cf)
|
||||
@@ -60,42 +92,44 @@ func (t *TaskMan) run(cf *changedFile) {
|
||||
defer t.runLock.Unlock()
|
||||
for i := 0; i < len(cfg.Command.Exec); i++ {
|
||||
carr := cmdParse2Array(cfg.Command.Exec[i], cf)
|
||||
log.Println("EXEC", carr)
|
||||
logInfo("EXEC", carr)
|
||||
t.cmd = exec.Command(carr[0], carr[1:]...)
|
||||
//cmd.SysProcAttr = &syscall.SysProcAttr{CreationFlags: syscall.CREATE_UNICODE_ENVIRONMENT}
|
||||
t.cmd.Stdin = os.Stdin
|
||||
//cmd.Stdout = os.Stdout
|
||||
t.cmd.Stdout = os.Stdout
|
||||
if keyInInstruction(InstIgnoreStdout) {
|
||||
t.cmd.Stdout = nil
|
||||
}
|
||||
t.cmd.Stderr = os.Stderr
|
||||
t.cmd.Dir = projectFolder
|
||||
t.cmd.Env = os.Environ()
|
||||
stdout, err := t.cmd.StdoutPipe()
|
||||
err := t.cmd.Start()
|
||||
if err != nil {
|
||||
log.Println(PreError, err.Error())
|
||||
return
|
||||
}
|
||||
err = t.cmd.Start()
|
||||
if err != nil {
|
||||
log.Println(PreError, "run command", carr, "error. ", err)
|
||||
}
|
||||
reader := bufio.NewReader(stdout)
|
||||
for {
|
||||
line, err2 := reader.ReadString('\n')
|
||||
if err2 != nil || io.EOF == err2 {
|
||||
break
|
||||
logError("run command", carr, "error. ", err)
|
||||
if keyInInstruction(InstIgnoreExecError) {
|
||||
continue
|
||||
}
|
||||
fmt.Print(line)
|
||||
break
|
||||
}
|
||||
err = t.cmd.Wait()
|
||||
if err != nil {
|
||||
log.Println(PreWarn, "cmd wait err ", err)
|
||||
logError("command exec failed:", carr, err)
|
||||
if keyInInstruction(InstIgnoreExecError) {
|
||||
continue
|
||||
}
|
||||
break
|
||||
}
|
||||
if t.cmd.Process != nil {
|
||||
if err = t.cmd.Process.Kill(); err != nil {
|
||||
log.Println(PreWarn, "cmd cannot kill, reason:", err)
|
||||
err := t.cmd.Process.Kill()
|
||||
logInfo(t.cmd.ProcessState)
|
||||
if t.cmd.ProcessState != nil && !t.cmd.ProcessState.Exited() {
|
||||
logError("command cannot stop!", carr, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
log.Println("end ")
|
||||
if keyInInstruction(InstShouldFinish) {
|
||||
t.cmd = nil
|
||||
t.waitChan <- true
|
||||
}
|
||||
logInfo("EXEC end")
|
||||
}
|
||||
|
31
util.go
31
util.go
@@ -13,6 +13,11 @@ func keyInMonitorTypesMap(k string, cfg *FileGirl) bool {
|
||||
return ok
|
||||
}
|
||||
|
||||
func keyInInstruction(k string) bool {
|
||||
_, ok := cfg.InstructionMap[k]
|
||||
return ok
|
||||
}
|
||||
|
||||
func cmdParse2Array(s string, cf *changedFile) []string {
|
||||
a := strings.Split(s, " ")
|
||||
r := make([]string, 0)
|
||||
@@ -76,7 +81,33 @@ func inStrArray(s string, arr []string) bool {
|
||||
return false
|
||||
}
|
||||
|
||||
func logInfo(v ...interface{}) {
|
||||
if keyInInstruction(InstIgnoreInfo) {
|
||||
return
|
||||
}
|
||||
logUInfo(v...)
|
||||
}
|
||||
|
||||
func logUInfo(v ...interface{}) {
|
||||
v = append([]interface{}{"I:"}, v...)
|
||||
log.Println(v...)
|
||||
}
|
||||
|
||||
func logWarn(v ...interface{}) {
|
||||
if keyInInstruction(InstIgnoreWarn) {
|
||||
return
|
||||
}
|
||||
v = append([]interface{}{"W:"}, v...)
|
||||
log.Println(v...)
|
||||
}
|
||||
|
||||
func logError(v ...interface{}) {
|
||||
v = append([]interface{}{"E:"}, v...)
|
||||
log.Println(v...)
|
||||
}
|
||||
|
||||
func logAndExit(v ...interface{}) {
|
||||
v = append([]interface{}{"O:"}, v...)
|
||||
log.Println(v...)
|
||||
os.Exit(15)
|
||||
}
|
||||
|
Reference in New Issue
Block a user