зеркало из https://github.com/mozilla/mig.git
[minor] initial commit of mig-runner
This commit is contained in:
Aaron Meihm
Родитель
376d1acc7d
Коммит
20c8a2c40c
4
Makefile
4
Makefile
|
|
@ -64,6 +64,9 @@ mig-scheduler: create-bindir
|
|||
mig-api: create-bindir
|
||||
$(GO) build $(GOOPTS) -o $(BINDIR)/mig-api $(GOLDFLAGS) mig.ninja/mig/mig-api
|
||||
|
||||
mig-runner: create-bindir
|
||||
$(GO) build $(GOOPTS) -o $(BINDIR)/mig-runner $(GOLDFLAGS) mig.ninja/mig/mig-runner
|
||||
|
||||
mig-action-generator: create-bindir
|
||||
$(GO) build $(GOOPTS) -o $(BINDIR)/mig-action-generator $(GOLDFLAGS) mig.ninja/mig/client/mig-action-generator
|
||||
|
||||
|
|
@ -104,6 +107,7 @@ go_vendor_dependencies:
|
|||
$(GOGETTER) github.com/mozilla/scribe/src/scribe
|
||||
$(GOGETTER) github.com/oschwald/geoip2-golang
|
||||
$(GOGETTER) github.com/streadway/amqp
|
||||
$(GOGETTER) github.com/gorhill/cronexpr
|
||||
$(GOGETTER) golang.org/x/crypto/openpgp
|
||||
$(GOGETTER) golang.org/x/crypto/sha3
|
||||
$(GOGETTER) golang.org/x/net/icmp
|
||||
|
|
|
|||
|
|
@ -774,6 +774,58 @@ finish:
|
|||
return
|
||||
}
|
||||
|
||||
// FetchActionResults retrieves mig command results associated with a
|
||||
// particular action. This function differs from PrintActionResults in
|
||||
// that it returns a slice of mig.Command structs, rather then printing
|
||||
// results to stdout.
|
||||
//
|
||||
// XXX Note in the future it may be worth refactoring the action print
|
||||
// functions to make use of this, but it would require additional work.
|
||||
func (cli Client) FetchActionResults(a mig.Action) (ret []mig.Command, err error) {
|
||||
defer func() {
|
||||
if e := recover(); e != nil {
|
||||
err = fmt.Errorf("FetchActionResults() -> %v", e)
|
||||
}
|
||||
}()
|
||||
|
||||
limit := 37
|
||||
offset := 0
|
||||
ret = make([]mig.Command, 0)
|
||||
|
||||
for {
|
||||
target := fmt.Sprintf("search?type=command&limit=%d&offset=%d", limit, offset)
|
||||
target = target + fmt.Sprintf("&actionid=%.0f", a.ID)
|
||||
|
||||
resource, err := cli.GetAPIResource(target)
|
||||
if resource.Collection.Error.Message == "no results found" {
|
||||
err = nil
|
||||
break
|
||||
} else if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
count := 0
|
||||
for _, item := range resource.Collection.Items {
|
||||
for _, data := range item.Data {
|
||||
if data.Name != "command" {
|
||||
continue
|
||||
}
|
||||
cmd, err := ValueToCommand(data.Value)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
ret = append(ret, cmd)
|
||||
count++
|
||||
}
|
||||
}
|
||||
if count == 0 {
|
||||
break
|
||||
}
|
||||
offset += limit
|
||||
}
|
||||
|
||||
return ret, nil
|
||||
}
|
||||
|
||||
func (cli Client) PrintActionResults(a mig.Action, show, render string) (err error) {
|
||||
defer func() {
|
||||
if e := recover(); e != nil {
|
||||
|
|
|
|||
|
|
@ -0,0 +1,12 @@
|
|||
; Sample MIG runner configuration file
|
||||
|
||||
[runner]
|
||||
directory = "./runner" ; The path to the root runner directory
|
||||
checkdirectory = 30 ; How often to check runners/ for job changes
|
||||
|
||||
[logging]
|
||||
mode = "stdout" ; stdout | file | syslog
|
||||
level = "debug"
|
||||
|
||||
[client]
|
||||
clientconfpath = "default" ; Path to client conf, default for $HOME/.migrc
|
||||
|
|
@ -0,0 +1,90 @@
|
|||
==========
|
||||
MIG RUNNER
|
||||
==========
|
||||
:Author: Aaron Meihm <ameihm@mozilla.com>
|
||||
|
||||
.. sectnum::
|
||||
.. contents:: Table of contents
|
||||
|
||||
MIG runner is a service that can be deployed to automatically schedule actions
|
||||
to run within the MIG environment and retrieve/process the results.
|
||||
|
||||
The runner interacts directly with the MIG API in the same manner as a client
|
||||
would. When an action is scheduled to run, the runner will deploy the action
|
||||
and schedule a time to gather results (shortly after the action has expired).
|
||||
Once the action has expired, the runner will retrieve results from the API
|
||||
and store these results in the runner directory.
|
||||
|
||||
Runner configuration file
|
||||
-------------------------
|
||||
|
||||
An example configuration file for use by mig-runner is shown below.
|
||||
|
||||
.. code::
|
||||
|
||||
; Sample MIG runner configuration file
|
||||
|
||||
[runner]
|
||||
directory = "/home/mig-runner/runner" ; The path to the root runner directory
|
||||
checkdirectory = 30 ; How often to check runners/ for job changes
|
||||
|
||||
[logging]
|
||||
mode = "stdout" ; stdout | file | syslog
|
||||
level = "debug"
|
||||
|
||||
[client]
|
||||
clientconfpath = "default" ; Path to client conf, default for $HOME/.migrc
|
||||
|
||||
The `directory` option specifies the root directory that stores all the
|
||||
mig-runner related control information. A typical runner directory may look
|
||||
something like this.
|
||||
|
||||
.. code::
|
||||
|
||||
runner/
|
||||
|
|
||||
+ runners/
|
||||
| |
|
||||
| + job1/
|
||||
| + job2/
|
||||
|
|
||||
+ plugins/
|
||||
|
||||
Job configuration
|
||||
-----------------
|
||||
|
||||
Under each job directory, a file entity.cfg defines the parameters used to
|
||||
run this job.
|
||||
|
||||
.. code::
|
||||
|
||||
[configuration]
|
||||
schedule = "<cronexpr>"
|
||||
plugin = "<plugin name>"
|
||||
|
||||
The schedule option should be set to a cron style expression to note when
|
||||
the job should be run.
|
||||
|
||||
The plugin is optional. If set, the value will be interpreted as an
|
||||
executable in the plugins directory. The results of the job will be piped
|
||||
into stdin of this executable in JSON format (mig-runner ResultEntry). The
|
||||
plugin can then parse and forward the data as needed.
|
||||
|
||||
The results are also written into a `results/` subdirectory under the
|
||||
runner directory, using the action ID as a file name. This happens
|
||||
regardless of any plugin configuration for the job.
|
||||
|
||||
In the job directory, the MIG action should should be launched should be
|
||||
called `action.json`. The time validity and expiration fields will be
|
||||
filled in by the runner process before dispatching the action to the
|
||||
API.
|
||||
|
||||
Output plugins
|
||||
--------------
|
||||
|
||||
The runner writes JSON output to stdin of any configured output plugin. This
|
||||
is intended to provide flexibility, allowing plugins to be developed in
|
||||
any language. If a plugin is being developed in go, the runner ResultEntry
|
||||
type can be used to parse incoming data. In other languages the JSON can
|
||||
be parsed as desired.
|
||||
|
||||
|
|
@ -0,0 +1,72 @@
|
|||
// This Source Code Form is subject to the terms of the Mozilla Public
|
||||
// License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
//
|
||||
// Contributor: Aaron Meihm ameihm@mozilla.com [:alm]
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"gopkg.in/gcfg.v1"
|
||||
"mig.ninja/mig"
|
||||
"mig.ninja/mig/client"
|
||||
"path"
|
||||
)
|
||||
|
||||
type Context struct {
|
||||
Channels struct {
|
||||
Log chan mig.Log
|
||||
ExitNotify chan bool
|
||||
Results chan mig.RunnerResult
|
||||
}
|
||||
Runner struct {
|
||||
Directory string
|
||||
RunDirectory string
|
||||
PluginDirectory string
|
||||
CheckDirectory int
|
||||
}
|
||||
Client struct {
|
||||
ClientConfPath string
|
||||
}
|
||||
Logging mig.Logging
|
||||
|
||||
Entities map[string]*entity
|
||||
ClientConf client.Configuration
|
||||
}
|
||||
|
||||
func initContext(config string) (ctx Context, err error) {
|
||||
defer func() {
|
||||
if e := recover(); e != nil {
|
||||
err = fmt.Errorf("initContext() -> %v", e)
|
||||
}
|
||||
}()
|
||||
|
||||
ctx = Context{}
|
||||
ctx.Channels.Log = make(chan mig.Log, 37)
|
||||
ctx.Channels.Results = make(chan mig.RunnerResult, 64)
|
||||
ctx.Channels.ExitNotify = make(chan bool, 64)
|
||||
ctx.Entities = make(map[string]*entity)
|
||||
err = gcfg.ReadFileInto(&ctx, config)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
ctx.Runner.RunDirectory = path.Join(ctx.Runner.Directory, "runners")
|
||||
ctx.Runner.PluginDirectory = path.Join(ctx.Runner.Directory, "plugins")
|
||||
|
||||
if ctx.Client.ClientConfPath == "default" {
|
||||
hdir := client.FindHomedir()
|
||||
ctx.Client.ClientConfPath = path.Join(hdir, ".migrc")
|
||||
}
|
||||
ctx.ClientConf, err = client.ReadConfiguration(ctx.Client.ClientConfPath)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
ctx.Logging, err = mig.InitLogger(ctx.Logging, "mig-runner")
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
return ctx, nil
|
||||
}
|
||||
|
|
@ -0,0 +1,123 @@
|
|||
// This Source Code Form is subject to the terms of the Mozilla Public
|
||||
// License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
//
|
||||
// Contributor: Aaron Meihm ameihm@mozilla.com [:alm]
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/gorhill/cronexpr"
|
||||
"gopkg.in/gcfg.v1"
|
||||
"mig.ninja/mig"
|
||||
"mig.ninja/mig/client"
|
||||
"path"
|
||||
"time"
|
||||
)
|
||||
|
||||
type entity struct {
|
||||
name string
|
||||
baseDir string
|
||||
confPath string
|
||||
modTime time.Time
|
||||
|
||||
abortRun chan bool
|
||||
cfg entityConfig
|
||||
}
|
||||
|
||||
type entityConfig struct {
|
||||
Configuration struct {
|
||||
Schedule string
|
||||
Plugin string
|
||||
}
|
||||
}
|
||||
|
||||
func (e *entity) launchAction() (err error) {
|
||||
defer func() {
|
||||
if e := recover(); e != nil {
|
||||
err = fmt.Errorf("launchAction() -> %v", e)
|
||||
}
|
||||
}()
|
||||
// Load the action from the entity run directory
|
||||
actpath := path.Join(e.baseDir, "action.json")
|
||||
act, err := mig.ActionFromFile(actpath)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
cli, err := client.NewClient(ctx.ClientConf, "mig-runner")
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
// Borrow some logic from the action generator.
|
||||
act.ValidFrom = time.Now().Add(-60 * time.Second).UTC()
|
||||
period, err := time.ParseDuration("2m")
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
act.ExpireAfter = act.ValidFrom.Add(period)
|
||||
asig, err := cli.SignAction(act)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
act = asig
|
||||
|
||||
res, err := cli.PostAction(act)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
mlog("%v: launched action %.0f", e.name, res.ID)
|
||||
|
||||
// Notify the results processor an action is in-flight
|
||||
re := mig.RunnerResult{}
|
||||
re.EntityName = e.name
|
||||
re.Action = res
|
||||
re.UsePlugin = e.cfg.Configuration.Plugin
|
||||
ctx.Channels.Results <- re
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (e *entity) start() {
|
||||
e.abortRun = make(chan bool, 1)
|
||||
for {
|
||||
cexpr, err := cronexpr.Parse(e.cfg.Configuration.Schedule)
|
||||
if err != nil {
|
||||
mlog("%v: %v", e.name, err)
|
||||
return
|
||||
}
|
||||
nrun := cexpr.Next(time.Now())
|
||||
waitduration := nrun.Sub(time.Now())
|
||||
mlog("%v: will run at %v (in %v)", e.name, nrun, waitduration)
|
||||
select {
|
||||
case <-e.abortRun:
|
||||
mlog("%v: asked to terminate, stopping", e.name)
|
||||
return
|
||||
case <-time.After(waitduration):
|
||||
}
|
||||
mlog("%v: running", e.name)
|
||||
err = e.launchAction()
|
||||
if err != nil {
|
||||
mlog("%v: %v", e.name, err)
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (e *entity) stop() {
|
||||
close(e.abortRun)
|
||||
}
|
||||
|
||||
func (e *entity) load() (err error) {
|
||||
defer func() {
|
||||
if e := recover(); e != nil {
|
||||
err = fmt.Errorf("load() -> %v", e)
|
||||
}
|
||||
}()
|
||||
err = gcfg.ReadFileInto(&e.cfg, e.confPath)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
|
@ -0,0 +1,195 @@
|
|||
// This Source Code Form is subject to the terms of the Mozilla Public
|
||||
// License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
//
|
||||
// Contributor: Aaron Meihm ameihm@mozilla.com [:alm]
|
||||
package main
|
||||
|
||||
import (
|
||||
"flag"
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
"mig.ninja/mig"
|
||||
"os"
|
||||
"os/signal"
|
||||
"path"
|
||||
"sync"
|
||||
"time"
|
||||
)
|
||||
|
||||
var ctx Context
|
||||
var wg sync.WaitGroup
|
||||
|
||||
func doExit(rc int) {
|
||||
close(ctx.Channels.Log)
|
||||
wg.Wait()
|
||||
os.Exit(rc)
|
||||
}
|
||||
|
||||
// Process a directory and generate a new scheduling entity if needed
|
||||
func procDir(dirpath string) (err error) {
|
||||
defer func() {
|
||||
if e := recover(); e != nil {
|
||||
err = fmt.Errorf("procDir() -> %v", e)
|
||||
}
|
||||
}()
|
||||
|
||||
ename := path.Base(dirpath)
|
||||
confpath := path.Join(dirpath, "entity.cfg")
|
||||
finfo, err := os.Stat(confpath)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
var ent *entity
|
||||
// See if we already have an entity by this name, and if the
|
||||
// modification time on the configuration file is the same. If so
|
||||
// we just return.
|
||||
ent, ok := ctx.Entities[ename]
|
||||
if ok && (ent.modTime == finfo.ModTime()) {
|
||||
return
|
||||
}
|
||||
if ent != nil {
|
||||
delete(ctx.Entities, ename)
|
||||
ent.stop()
|
||||
}
|
||||
ent = &entity{}
|
||||
// Add the entity and start it.
|
||||
ent.name = ename
|
||||
ent.modTime = finfo.ModTime()
|
||||
ent.baseDir = dirpath
|
||||
ent.confPath = confpath
|
||||
err = ent.load()
|
||||
if err != nil {
|
||||
// Don't treat this as fatal; we will just try to load it again
|
||||
// next time.
|
||||
mlog("%v: %v", ename, err)
|
||||
return nil
|
||||
}
|
||||
ctx.Entities[ename] = ent
|
||||
mlog("added entity %v", ename)
|
||||
go ent.start()
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Remove entities that are no longer present in the runner directory
|
||||
func procReap(ents []string) error {
|
||||
for k := range ctx.Entities {
|
||||
found := false
|
||||
for _, x := range ents {
|
||||
if x == k {
|
||||
found = true
|
||||
}
|
||||
}
|
||||
if !found {
|
||||
ctx.Entities[k].stop()
|
||||
delete(ctx.Entities, k)
|
||||
mlog("removed entity %v", k)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func runnerScan() (err error) {
|
||||
defer func() {
|
||||
if e := recover(); e != nil {
|
||||
err = fmt.Errorf("runnerScan() -> %v", e)
|
||||
}
|
||||
}()
|
||||
|
||||
// Begin scanning the runner directory
|
||||
for {
|
||||
mlog("scanning %v", ctx.Runner.RunDirectory)
|
||||
ents, err := ioutil.ReadDir(ctx.Runner.RunDirectory)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
haveents := make([]string, 0)
|
||||
for _, x := range ents {
|
||||
if !x.IsDir() {
|
||||
continue
|
||||
}
|
||||
haveents = append(haveents, x.Name())
|
||||
dirpath := path.Join(ctx.Runner.RunDirectory, x.Name())
|
||||
err = procDir(dirpath)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
}
|
||||
err = procReap(haveents)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
doexit := false
|
||||
select {
|
||||
case <-time.After(time.Duration(ctx.Runner.CheckDirectory) * time.Second):
|
||||
case <-ctx.Channels.ExitNotify:
|
||||
doexit = true
|
||||
}
|
||||
if doexit {
|
||||
break
|
||||
}
|
||||
}
|
||||
mlog("runner exiting due to notification")
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func mlog(s string, args ...interface{}) {
|
||||
ctx.Channels.Log <- mig.Log{Desc: fmt.Sprintf(s, args...)}
|
||||
}
|
||||
|
||||
func main() {
|
||||
var err error
|
||||
|
||||
var config = flag.String("c", "/etc/mig/runner.cfg", "Load configuration from file")
|
||||
flag.Parse()
|
||||
|
||||
ctx, err = initContext(*config)
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "error: %v\n", err)
|
||||
os.Exit(9)
|
||||
}
|
||||
|
||||
wg.Add(1)
|
||||
go func() {
|
||||
var stop bool
|
||||
for event := range ctx.Channels.Log {
|
||||
stop, err = mig.ProcessLog(ctx.Logging, event)
|
||||
if err != nil {
|
||||
panic("unable to process log")
|
||||
}
|
||||
if stop {
|
||||
break
|
||||
}
|
||||
}
|
||||
wg.Done()
|
||||
}()
|
||||
mlog("logging routine started")
|
||||
|
||||
sigch := make(chan os.Signal, 1)
|
||||
signal.Notify(sigch, os.Interrupt, os.Kill)
|
||||
go func() {
|
||||
<-sigch
|
||||
mlog("signal, exiting")
|
||||
ctx.Channels.ExitNotify <- true
|
||||
}()
|
||||
|
||||
err = loadPlugins()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "error: %v\n", err)
|
||||
doExit(9)
|
||||
}
|
||||
// Start up the results processor
|
||||
go processResults()
|
||||
|
||||
err = runnerScan()
|
||||
if err != nil {
|
||||
mlog("runner error: %v", err)
|
||||
doExit(9)
|
||||
}
|
||||
|
||||
doExit(0)
|
||||
}
|
||||
|
|
@ -0,0 +1,103 @@
|
|||
// This Source Code Form is subject to the terms of the Mozilla Public
|
||||
// License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
//
|
||||
// Contributor: Aaron Meihm ameihm@mozilla.com [:alm]
|
||||
package main
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
"mig.ninja/mig"
|
||||
"os/exec"
|
||||
"path"
|
||||
)
|
||||
|
||||
var pluginList []plugin
|
||||
|
||||
type plugin struct {
|
||||
name string
|
||||
path string
|
||||
}
|
||||
|
||||
func runPlugin(r mig.RunnerResult) (err error) {
|
||||
defer func() {
|
||||
if e := recover(); e != nil {
|
||||
err = fmt.Errorf("runPlugin() -> %v", e)
|
||||
}
|
||||
}()
|
||||
|
||||
var pent *plugin
|
||||
for i := range pluginList {
|
||||
if pluginList[i].name == r.UsePlugin {
|
||||
pent = &pluginList[i]
|
||||
}
|
||||
}
|
||||
if pent == nil {
|
||||
panic("unable to locate plugin")
|
||||
}
|
||||
|
||||
go func() {
|
||||
buf, err := json.Marshal(r)
|
||||
if err != nil {
|
||||
mlog("%v: %v", pent.name, err)
|
||||
return
|
||||
}
|
||||
c := exec.Command(pent.path)
|
||||
stdin, err := c.StdinPipe()
|
||||
if err != nil {
|
||||
mlog("%v: %v", pent.name, err)
|
||||
return
|
||||
}
|
||||
err = c.Start()
|
||||
if err != nil {
|
||||
mlog("%v: %v", pent.name, err)
|
||||
return
|
||||
}
|
||||
wb, err := stdin.Write(buf)
|
||||
if err != nil {
|
||||
mlog("%v: %v", pent.name, err)
|
||||
}
|
||||
stdin.Close()
|
||||
err = c.Wait()
|
||||
if err != nil {
|
||||
mlog("%v: %v", pent.name, err)
|
||||
}
|
||||
mlog("%v: wrote %v bytes to plugin", pent.name, wb)
|
||||
}()
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func loadPlugins() (err error) {
|
||||
defer func() {
|
||||
if e := recover(); e != nil {
|
||||
err = fmt.Errorf("loadPlugins() -> %v", e)
|
||||
}
|
||||
}()
|
||||
|
||||
pluginList = make([]plugin, 0)
|
||||
|
||||
// Identify any available output plugins
|
||||
dirents, err := ioutil.ReadDir(ctx.Runner.PluginDirectory)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
for _, x := range dirents {
|
||||
n := x.Name()
|
||||
m := x.Mode()
|
||||
if (m & 0111) == 0 {
|
||||
mlog("plugins: skipping %v (not executable)", n)
|
||||
continue
|
||||
}
|
||||
ppath := path.Join(ctx.Runner.PluginDirectory, n)
|
||||
mlog("plugins: registering %v", n)
|
||||
np := plugin{}
|
||||
np.name = n
|
||||
np.path = ppath
|
||||
pluginList = append(pluginList, np)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
|
@ -0,0 +1,128 @@
|
|||
// This Source Code Form is subject to the terms of the Mozilla Public
|
||||
// License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
//
|
||||
// Contributor: Aaron Meihm ameihm@mozilla.com [:alm]
|
||||
package main
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"mig.ninja/mig"
|
||||
"mig.ninja/mig/client"
|
||||
"os"
|
||||
"path"
|
||||
"time"
|
||||
)
|
||||
|
||||
func getResultsStoragePath(nm string) (rdir string, err error) {
|
||||
defer func() {
|
||||
if e := recover(); e != nil {
|
||||
err = fmt.Errorf("getResultsStoragePath() -> %v", e)
|
||||
}
|
||||
}()
|
||||
tstamp := time.Now().UTC().Format("20060102")
|
||||
rdir = path.Join(ctx.Runner.RunDirectory, nm, "results", tstamp)
|
||||
|
||||
_, err = os.Stat(rdir)
|
||||
if err != nil {
|
||||
if !os.IsNotExist(err) {
|
||||
panic(err)
|
||||
}
|
||||
err = os.MkdirAll(rdir, 0755)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
}
|
||||
return rdir, nil
|
||||
}
|
||||
|
||||
func getResults(r mig.RunnerResult) (err error) {
|
||||
defer func() {
|
||||
if e := recover(); e != nil {
|
||||
err = fmt.Errorf("getResults() -> %v", e)
|
||||
}
|
||||
}()
|
||||
|
||||
mlog("fetching results for %v/%.0f", r.EntityName, r.Action.ID)
|
||||
|
||||
cli, err := client.NewClient(ctx.ClientConf, "mig-runner-results")
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
results, err := cli.FetchActionResults(r.Action)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
// Store the results
|
||||
outpath, err := getResultsStoragePath(r.EntityName)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
outpath = path.Join(outpath, fmt.Sprintf("%.0f", r.Action.ID))
|
||||
fd, err := os.Create(outpath)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
defer fd.Close()
|
||||
|
||||
r.Commands = results
|
||||
buf, err := json.Marshal(r)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
_, err = fd.Write(buf)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
mlog("wrote results for %.0f to %v", r.Action.ID, outpath)
|
||||
|
||||
// If a plugin has been configured on the result set, call the
|
||||
// plugin on the data.
|
||||
if r.UsePlugin != "" {
|
||||
err = runPlugin(r)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
} else {
|
||||
mlog("no output plugin for %.0f, skipping plugin processing", r.Action.ID)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func processResults() {
|
||||
mlog("results processing routine started")
|
||||
|
||||
reslist := make([]mig.RunnerResult, 0)
|
||||
|
||||
for {
|
||||
timeout := false
|
||||
select {
|
||||
case nr := <-ctx.Channels.Results:
|
||||
mlog("monitoring result for %v/%.0f", nr.EntityName, nr.Action.ID)
|
||||
reslist = append(reslist, nr)
|
||||
case <-time.After(time.Duration(5) * time.Second):
|
||||
timeout = true
|
||||
}
|
||||
if !timeout {
|
||||
// Only attempt action results fetch if we are idle
|
||||
continue
|
||||
}
|
||||
|
||||
// See if any actions have expired, if so grab the results
|
||||
oldres := reslist
|
||||
reslist = reslist[:0]
|
||||
for _, x := range oldres {
|
||||
if time.Now().After(x.Action.ExpireAfter) {
|
||||
err := getResults(x)
|
||||
if err != nil {
|
||||
mlog("results error for %v: %v", x.EntityName, err)
|
||||
}
|
||||
continue
|
||||
}
|
||||
reslist = append(reslist, x)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
// This Source Code Form is subject to the terms of the Mozilla Public
|
||||
// License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
//
|
||||
// Contributor: Aaron Meihm ameihm@mozilla.com [:alm]
|
||||
|
||||
package mig /* import "mig.ninja/mig" */
|
||||
|
||||
// Describes results that are produced by mig-runner
|
||||
type RunnerResult struct {
|
||||
Action Action `json:"action"`
|
||||
Commands []Command `json:"commands"`
|
||||
EntityName string `json:"name"`
|
||||
UsePlugin string `json:"plugin"`
|
||||
}
|
||||
|
|
@ -0,0 +1,202 @@
|
|||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. {http://fsf.org/}
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
{one line to give the program's name and a brief idea of what it does.}
|
||||
Copyright (C) {year} {name of author}
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see {http://www.gnu.org/licenses/}.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
cronexpr Copyright (C) 2013 Raymond Hill
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
{http://www.gnu.org/licenses/}.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
{http://www.gnu.org/philosophy/why-not-lgpl.html}.
|
||||
|
|
@ -0,0 +1,134 @@
|
|||
Golang Cron expression parser
|
||||
=============================
|
||||
Given a cron expression and a time stamp, you can get the next time stamp which satisfies the cron expression.
|
||||
|
||||
In another project, I decided to use cron expression syntax to encode scheduling information. Thus this standalone library to parse and apply time stamps to cron expressions.
|
||||
|
||||
The time-matching algorithm in this implementation is efficient, it avoids as much as possible to guess the next matching time stamp, a common technique seen in a number of implementations out there.
|
||||
|
||||
There is also a companion command-line utility to evaluate cron time expressions: <https://github.com/gorhill/cronexpr/tree/master/cronexpr> (which of course uses this library).
|
||||
|
||||
Implementation
|
||||
--------------
|
||||
The reference documentation for this implementation is found at
|
||||
<https://en.wikipedia.org/wiki/Cron#CRON_expression>, which I copy/pasted here (laziness!) with modifications where this implementation differs:
|
||||
|
||||
Field name Mandatory? Allowed values Allowed special characters
|
||||
---------- ---------- -------------- --------------------------
|
||||
Seconds No 0-59 * / , -
|
||||
Minutes Yes 0-59 * / , -
|
||||
Hours Yes 0-23 * / , -
|
||||
Day of month Yes 1-31 * / , - L W
|
||||
Month Yes 1-12 or JAN-DEC * / , -
|
||||
Day of week Yes 0-6 or SUN-SAT * / , - L #
|
||||
Year No 1970–2099 * / , -
|
||||
|
||||
#### Asterisk ( * )
|
||||
The asterisk indicates that the cron expression matches for all values of the field. E.g., using an asterisk in the 4th field (month) indicates every month.
|
||||
|
||||
#### Slash ( / )
|
||||
Slashes describe increments of ranges. For example `3-59/15` in the minute field indicate the third minute of the hour and every 15 minutes thereafter. The form `*/...` is equivalent to the form "first-last/...", that is, an increment over the largest possible range of the field.
|
||||
|
||||
#### Comma ( , )
|
||||
Commas are used to separate items of a list. For example, using `MON,WED,FRI` in the 5th field (day of week) means Mondays, Wednesdays and Fridays.
|
||||
|
||||
#### Hyphen ( - )
|
||||
Hyphens define ranges. For example, 2000-2010 indicates every year between 2000 and 2010 AD, inclusive.
|
||||
|
||||
#### L
|
||||
`L` stands for "last". When used in the day-of-week field, it allows you to specify constructs such as "the last Friday" (`5L`) of a given month. In the day-of-month field, it specifies the last day of the month.
|
||||
|
||||
#### W
|
||||
The `W` character is allowed for the day-of-month field. This character is used to specify the business day (Monday-Friday) nearest the given day. As an example, if you were to specify `15W` as the value for the day-of-month field, the meaning is: "the nearest business day to the 15th of the month."
|
||||
|
||||
So, if the 15th is a Saturday, the trigger fires on Friday the 14th. If the 15th is a Sunday, the trigger fires on Monday the 16th. If the 15th is a Tuesday, then it fires on Tuesday the 15th. However if you specify `1W` as the value for day-of-month, and the 1st is a Saturday, the trigger fires on Monday the 3rd, as it does not 'jump' over the boundary of a month's days.
|
||||
|
||||
The `W` character can be specified only when the day-of-month is a single day, not a range or list of days.
|
||||
|
||||
The `W` character can also be combined with `L`, i.e. `LW` to mean "the last business day of the month."
|
||||
|
||||
#### Hash ( # )
|
||||
`#` is allowed for the day-of-week field, and must be followed by a number between one and five. It allows you to specify constructs such as "the second Friday" of a given month.
|
||||
|
||||
Predefined cron expressions
|
||||
---------------------------
|
||||
(Copied from <https://en.wikipedia.org/wiki/Cron#Predefined_scheduling_definitions>, with text modified according to this implementation)
|
||||
|
||||
Entry Description Equivalent to
|
||||
@annually Run once a year at midnight in the morning of January 1 0 0 0 1 1 * *
|
||||
@yearly Run once a year at midnight in the morning of January 1 0 0 0 1 1 * *
|
||||
@monthly Run once a month at midnight in the morning of the first of the month 0 0 0 1 * * *
|
||||
@weekly Run once a week at midnight in the morning of Sunday 0 0 0 * * 0 *
|
||||
@daily Run once a day at midnight 0 0 0 * * * *
|
||||
@hourly Run once an hour at the beginning of the hour 0 0 * * * * *
|
||||
@reboot Not supported
|
||||
|
||||
Other details
|
||||
-------------
|
||||
* If only six fields are present, a `0` second field is prepended, that is, `* * * * * 2013` internally become `0 * * * * * 2013`.
|
||||
* If only five fields are present, a `0` second field is prepended and a wildcard year field is appended, that is, `* * * * Mon` internally become `0 * * * * Mon *`.
|
||||
* Domain for day-of-week field is [0-7] instead of [0-6], 7 being Sunday (like 0). This to comply with http://linux.die.net/man/5/crontab#.
|
||||
* As of now, the behavior of the code is undetermined if a malformed cron expression is supplied
|
||||
|
||||
Install
|
||||
-------
|
||||
go get github.com/gorhill/cronexpr
|
||||
|
||||
Usage
|
||||
-----
|
||||
Import the library:
|
||||
|
||||
import "github.com/gorhill/cronexpr"
|
||||
import "time"
|
||||
|
||||
Simplest way:
|
||||
|
||||
nextTime := cronexpr.MustParse("0 0 29 2 *").Next(time.Now())
|
||||
|
||||
Assuming `time.Now()` is "2013-08-29 09:28:00", then `nextTime` will be "2016-02-29 00:00:00".
|
||||
|
||||
You can keep the returned Expression pointer around if you want to reuse it:
|
||||
|
||||
expr := cronexpr.MustParse("0 0 29 2 *")
|
||||
nextTime := expr.Next(time.Now())
|
||||
...
|
||||
nextTime = expr.Next(nextTime)
|
||||
|
||||
Use `time.IsZero()` to find out whether a valid time was returned. For example,
|
||||
|
||||
cronexpr.MustParse("* * * * * 1980").Next(time.Now()).IsZero()
|
||||
|
||||
will return `true`, whereas
|
||||
|
||||
cronexpr.MustParse("* * * * * 2050").Next(time.Now()).IsZero()
|
||||
|
||||
will return `false` (as of 2013-08-29...)
|
||||
|
||||
You may also query for `n` next time stamps:
|
||||
|
||||
cronexpr.MustParse("0 0 29 2 *").NextN(time.Now(), 5)
|
||||
|
||||
which returns a slice of time.Time objects, containing the following time stamps (as of 2013-08-30):
|
||||
|
||||
2016-02-29 00:00:00
|
||||
2020-02-29 00:00:00
|
||||
2024-02-29 00:00:00
|
||||
2028-02-29 00:00:00
|
||||
2032-02-29 00:00:00
|
||||
|
||||
The time zone of time values returned by `Next` and `NextN` is always the
|
||||
time zone of the time value passed as argument, unless a zero time value is
|
||||
returned.
|
||||
|
||||
API
|
||||
---
|
||||
<http://godoc.org/github.com/gorhill/cronexpr>
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
License: pick the one which suits you best:
|
||||
|
||||
- GPL v3 see <https://www.gnu.org/licenses/gpl.html>
|
||||
- APL v2 see <http://www.apache.org/licenses/LICENSE-2.0>
|
||||
|
||||
|
|
@ -0,0 +1,266 @@
|
|||
/*!
|
||||
* Copyright 2013 Raymond Hill
|
||||
*
|
||||
* Project: github.com/gorhill/cronexpr
|
||||
* File: cronexpr.go
|
||||
* Version: 1.0
|
||||
* License: pick the one which suits you :
|
||||
* GPL v3 see <https://www.gnu.org/licenses/gpl.html>
|
||||
* APL v2 see <http://www.apache.org/licenses/LICENSE-2.0>
|
||||
*
|
||||
*/
|
||||
|
||||
// Package cronexpr parses cron time expressions.
|
||||
package cronexpr
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"sort"
|
||||
"time"
|
||||
)
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
// A Expression represents a specific cron time expression as defined at
|
||||
// <https://github.com/gorhill/cronexpr#implementation>
|
||||
type Expression struct {
|
||||
expression string
|
||||
secondList []int
|
||||
minuteList []int
|
||||
hourList []int
|
||||
daysOfMonth map[int]bool
|
||||
workdaysOfMonth map[int]bool
|
||||
lastDayOfMonth bool
|
||||
lastWorkdayOfMonth bool
|
||||
daysOfMonthRestricted bool
|
||||
actualDaysOfMonthList []int
|
||||
monthList []int
|
||||
daysOfWeek map[int]bool
|
||||
specificWeekDaysOfWeek map[int]bool
|
||||
lastWeekDaysOfWeek map[int]bool
|
||||
daysOfWeekRestricted bool
|
||||
yearList []int
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
// MustParse returns a new Expression pointer. It expects a well-formed cron
|
||||
// expression. If a malformed cron expression is supplied, it will `panic`.
|
||||
// See <https://github.com/gorhill/cronexpr#implementation> for documentation
|
||||
// about what is a well-formed cron expression from this library's point of
|
||||
// view.
|
||||
func MustParse(cronLine string) *Expression {
|
||||
expr, err := Parse(cronLine)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
return expr
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
// Parse returns a new Expression pointer. An error is returned if a malformed
|
||||
// cron expression is supplied.
|
||||
// See <https://github.com/gorhill/cronexpr#implementation> for documentation
|
||||
// about what is a well-formed cron expression from this library's point of
|
||||
// view.
|
||||
func Parse(cronLine string) (*Expression, error) {
|
||||
|
||||
// Maybe one of the built-in aliases is being used
|
||||
cron := cronNormalizer.Replace(cronLine)
|
||||
|
||||
indices := fieldFinder.FindAllStringIndex(cron, -1)
|
||||
fieldCount := len(indices)
|
||||
if fieldCount < 5 {
|
||||
return nil, fmt.Errorf("missing field(s)")
|
||||
}
|
||||
// ignore fields beyond 7th
|
||||
if fieldCount > 7 {
|
||||
fieldCount = 7
|
||||
}
|
||||
|
||||
var expr = Expression{}
|
||||
var field = 0
|
||||
var err error
|
||||
|
||||
// second field (optional)
|
||||
if fieldCount == 7 {
|
||||
err = expr.secondFieldHandler(cron[indices[field][0]:indices[field][1]])
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
field += 1
|
||||
} else {
|
||||
expr.secondList = []int{0}
|
||||
}
|
||||
|
||||
// minute field
|
||||
err = expr.minuteFieldHandler(cron[indices[field][0]:indices[field][1]])
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
field += 1
|
||||
|
||||
// hour field
|
||||
err = expr.hourFieldHandler(cron[indices[field][0]:indices[field][1]])
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
field += 1
|
||||
|
||||
// day of month field
|
||||
err = expr.domFieldHandler(cron[indices[field][0]:indices[field][1]])
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
field += 1
|
||||
|
||||
// month field
|
||||
err = expr.monthFieldHandler(cron[indices[field][0]:indices[field][1]])
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
field += 1
|
||||
|
||||
// day of week field
|
||||
err = expr.dowFieldHandler(cron[indices[field][0]:indices[field][1]])
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
field += 1
|
||||
|
||||
// year field
|
||||
if field < fieldCount {
|
||||
err = expr.yearFieldHandler(cron[indices[field][0]:indices[field][1]])
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
} else {
|
||||
expr.yearList = yearDescriptor.defaultList
|
||||
}
|
||||
|
||||
return &expr, nil
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
// Next returns the closest time instant immediately following `fromTime` which
|
||||
// matches the cron expression `expr`.
|
||||
//
|
||||
// The `time.Location` of the returned time instant is the same as that of
|
||||
// `fromTime`.
|
||||
//
|
||||
// The zero value of time.Time is returned if no matching time instant exists
|
||||
// or if a `fromTime` is itself a zero value.
|
||||
func (expr *Expression) Next(fromTime time.Time) time.Time {
|
||||
// Special case
|
||||
if fromTime.IsZero() {
|
||||
return fromTime
|
||||
}
|
||||
|
||||
// Since expr.nextSecond()-expr.nextMonth() expects that the
|
||||
// supplied time stamp is a perfect match to the underlying cron
|
||||
// expression, and since this function is an entry point where `fromTime`
|
||||
// does not necessarily matches the underlying cron expression,
|
||||
// we first need to ensure supplied time stamp matches
|
||||
// the cron expression. If not, this means the supplied time
|
||||
// stamp falls in between matching time stamps, thus we move
|
||||
// to closest future matching immediately upon encountering a mismatching
|
||||
// time stamp.
|
||||
|
||||
// year
|
||||
v := fromTime.Year()
|
||||
i := sort.SearchInts(expr.yearList, v)
|
||||
if i == len(expr.yearList) {
|
||||
return time.Time{}
|
||||
}
|
||||
if v != expr.yearList[i] {
|
||||
return expr.nextYear(fromTime)
|
||||
}
|
||||
// month
|
||||
v = int(fromTime.Month())
|
||||
i = sort.SearchInts(expr.monthList, v)
|
||||
if i == len(expr.monthList) {
|
||||
return expr.nextYear(fromTime)
|
||||
}
|
||||
if v != expr.monthList[i] {
|
||||
return expr.nextMonth(fromTime)
|
||||
}
|
||||
|
||||
expr.actualDaysOfMonthList = expr.calculateActualDaysOfMonth(fromTime.Year(), int(fromTime.Month()))
|
||||
if len(expr.actualDaysOfMonthList) == 0 {
|
||||
return expr.nextMonth(fromTime)
|
||||
}
|
||||
|
||||
// day of month
|
||||
v = fromTime.Day()
|
||||
i = sort.SearchInts(expr.actualDaysOfMonthList, v)
|
||||
if i == len(expr.actualDaysOfMonthList) {
|
||||
return expr.nextMonth(fromTime)
|
||||
}
|
||||
if v != expr.actualDaysOfMonthList[i] {
|
||||
return expr.nextDayOfMonth(fromTime)
|
||||
}
|
||||
// hour
|
||||
v = fromTime.Hour()
|
||||
i = sort.SearchInts(expr.hourList, v)
|
||||
if i == len(expr.hourList) {
|
||||
return expr.nextDayOfMonth(fromTime)
|
||||
}
|
||||
if v != expr.hourList[i] {
|
||||
return expr.nextHour(fromTime)
|
||||
}
|
||||
// minute
|
||||
v = fromTime.Minute()
|
||||
i = sort.SearchInts(expr.minuteList, v)
|
||||
if i == len(expr.minuteList) {
|
||||
return expr.nextHour(fromTime)
|
||||
}
|
||||
if v != expr.minuteList[i] {
|
||||
return expr.nextMinute(fromTime)
|
||||
}
|
||||
// second
|
||||
v = fromTime.Second()
|
||||
i = sort.SearchInts(expr.secondList, v)
|
||||
if i == len(expr.secondList) {
|
||||
return expr.nextMinute(fromTime)
|
||||
}
|
||||
|
||||
// If we reach this point, there is nothing better to do
|
||||
// than to move to the next second
|
||||
|
||||
return expr.nextSecond(fromTime)
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
// NextN returns a slice of `n` closest time instants immediately following
|
||||
// `fromTime` which match the cron expression `expr`.
|
||||
//
|
||||
// The time instants in the returned slice are in chronological ascending order.
|
||||
// The `time.Location` of the returned time instants is the same as that of
|
||||
// `fromTime`.
|
||||
//
|
||||
// A slice with len between [0-`n`] is returned, that is, if not enough existing
|
||||
// matching time instants exist, the number of returned entries will be less
|
||||
// than `n`.
|
||||
func (expr *Expression) NextN(fromTime time.Time, n uint) []time.Time {
|
||||
nextTimes := make([]time.Time, 0, n)
|
||||
if n > 0 {
|
||||
fromTime = expr.Next(fromTime)
|
||||
for {
|
||||
if fromTime.IsZero() {
|
||||
break
|
||||
}
|
||||
nextTimes = append(nextTimes, fromTime)
|
||||
n -= 1
|
||||
if n == 0 {
|
||||
break
|
||||
}
|
||||
fromTime = expr.nextSecond(fromTime)
|
||||
}
|
||||
}
|
||||
return nextTimes
|
||||
}
|
||||
|
|
@ -0,0 +1,122 @@
|
|||
cronexpr: command-line utility
|
||||
==============================
|
||||
|
||||
A command-line utility written in Go to evaluate cron time expressions.
|
||||
|
||||
It is based on the standalone Go library <https://github.com/gorhill/cronexpr>.
|
||||
|
||||
## Install
|
||||
|
||||
go get github.com/gorhill/cronexpr
|
||||
go install github.com/gorhill/cronexpr
|
||||
|
||||
## Usage
|
||||
|
||||
cronexpr [options] "{cron expression}"
|
||||
|
||||
## Options
|
||||
|
||||
`-l`:
|
||||
|
||||
Go-compliant time layout to use for outputting time value(s), see <http://golang.org/pkg/time/#pkg-constants>.
|
||||
|
||||
Default is `"Mon, 02 Jan 2006 15:04:05 MST"`
|
||||
|
||||
`-n`:
|
||||
|
||||
Number of resulting time values to output.
|
||||
|
||||
Default is 1.
|
||||
|
||||
`-t`:
|
||||
|
||||
Whole or partial RFC3339 time value (i.e. `2006-01-02T15:04:05Z07:00`) against which the cron expression is evaluated. Examples of valid values include (assuming EST time zone):
|
||||
|
||||
`13` = 2013-01-01T00:00:00-05:00
|
||||
`2013` = 2013-01-01T00:00:00-05:00
|
||||
`2013-08` = 2013-08-01T00:00:00-05:00
|
||||
`2013-08-31` = 2013-08-31T00:00:00-05:00
|
||||
`2013-08-31T12` = 2013-08-31T12:00:00-05:00
|
||||
`2013-08-31T12:40` = 2013-08-31T12:40:00-05:00
|
||||
`2013-08-31T12:40:35` = 2013-08-31T12:40:35-05:00
|
||||
`2013-08-31T12:40:35-10:00` = 2013-08-31T12:40:35-10:00
|
||||
|
||||
Default time is current time, and default time zone is local time zone.
|
||||
|
||||
## Examples
|
||||
|
||||
#### Example 1
|
||||
|
||||
Midnight on December 31st of any year.
|
||||
|
||||
Command:
|
||||
|
||||
cronexpr -t="2013-08-31" -n=5 "0 0 31 12 *"
|
||||
|
||||
Output (assuming computer is in EST time zone):
|
||||
|
||||
# "0 0 31 12 *" + "2013-08-31T00:00:00-04:00" =
|
||||
Tue, 31 Dec 2013 00:00:00 EST
|
||||
Wed, 31 Dec 2014 00:00:00 EST
|
||||
Thu, 31 Dec 2015 00:00:00 EST
|
||||
Sat, 31 Dec 2016 00:00:00 EST
|
||||
Sun, 31 Dec 2017 00:00:00 EST
|
||||
|
||||
#### Example 2
|
||||
|
||||
2pm on February 29th of any year.
|
||||
|
||||
Command:
|
||||
|
||||
cronexpr -t=2000 -n=10 "0 14 29 2 *"
|
||||
|
||||
Output (assuming computer is in EST time zone):
|
||||
|
||||
# "0 14 29 2 *" + "2000-01-01T00:00:00-05:00" =
|
||||
Tue, 29 Feb 2000 14:00:00 EST
|
||||
Sun, 29 Feb 2004 14:00:00 EST
|
||||
Fri, 29 Feb 2008 14:00:00 EST
|
||||
Wed, 29 Feb 2012 14:00:00 EST
|
||||
Mon, 29 Feb 2016 14:00:00 EST
|
||||
Sat, 29 Feb 2020 14:00:00 EST
|
||||
Thu, 29 Feb 2024 14:00:00 EST
|
||||
Tue, 29 Feb 2028 14:00:00 EST
|
||||
Sun, 29 Feb 2032 14:00:00 EST
|
||||
Fri, 29 Feb 2036 14:00:00 EST
|
||||
|
||||
#### Example 3
|
||||
|
||||
12pm on the work day closest to the 15th of March and every three month
|
||||
thereafter.
|
||||
|
||||
Command:
|
||||
|
||||
cronexpr -t=2013-09-01 -n=5 "0 12 15W 3/3 *"
|
||||
|
||||
Output (assuming computer is in EST time zone):
|
||||
|
||||
# "0 12 15W 3/3 *" + "2013-09-01T00:00:00-04:00" =
|
||||
Mon, 16 Sep 2013 12:00:00 EDT
|
||||
Mon, 16 Dec 2013 12:00:00 EST
|
||||
Fri, 14 Mar 2014 12:00:00 EDT
|
||||
Mon, 16 Jun 2014 12:00:00 EDT
|
||||
Mon, 15 Sep 2014 12:00:00 EDT
|
||||
|
||||
#### Example 4
|
||||
|
||||
Midnight on the fifth Saturday of any month (twist: not all months have a 5th
|
||||
specific day of week).
|
||||
|
||||
Command:
|
||||
|
||||
cronexpr -t=2013-09-02 -n 5 "0 0 * * 6#5"
|
||||
|
||||
Output (assuming computer is in EST time zone):
|
||||
|
||||
# "0 0 * * 6#5" + "2013-09-02T00:00:00-04:00" =
|
||||
Sat, 30 Nov 2013 00:00:00 EST
|
||||
Sat, 29 Mar 2014 00:00:00 EDT
|
||||
Sat, 31 May 2014 00:00:00 EDT
|
||||
Sat, 30 Aug 2014 00:00:00 EDT
|
||||
Sat, 29 Nov 2014 00:00:00 EST
|
||||
|
||||
|
|
@ -0,0 +1,111 @@
|
|||
/*!
|
||||
* Copyright 2013 Raymond Hill
|
||||
*
|
||||
* Project: github.com/gorhill/cronexpr
|
||||
* File: main.go
|
||||
* Version: 1.0
|
||||
* License: GPL v3 see <https://www.gnu.org/licenses/gpl.html>
|
||||
*
|
||||
*/
|
||||
|
||||
package main
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
import (
|
||||
"flag"
|
||||
"fmt"
|
||||
"os"
|
||||
"time"
|
||||
|
||||
"github.com/gorhill/cronexpr"
|
||||
)
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
var (
|
||||
usage = func() {
|
||||
fmt.Fprintf(os.Stderr, "usage:\n %s [options] \"{cron expression}\"\noptions:\n", os.Args[0])
|
||||
flag.PrintDefaults()
|
||||
}
|
||||
inTimeStr string
|
||||
outTimeCount uint
|
||||
outTimeLayout string
|
||||
)
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
func main() {
|
||||
var err error
|
||||
|
||||
flag.Usage = usage
|
||||
flag.StringVar(&inTimeStr, "t", "", `whole or partial RFC3339 time value (i.e. "2006-01-02T15:04:05Z07:00") against which the cron expression is evaluated, now if not present`)
|
||||
flag.UintVar(&outTimeCount, "n", 1, `number of resulting time values to output`)
|
||||
flag.StringVar(&outTimeLayout, "l", "Mon, 02 Jan 2006 15:04:05 MST", `Go-compliant time layout to use for outputting time value(s), see <http://golang.org/pkg/time/#pkg-constants>`)
|
||||
flag.Parse()
|
||||
|
||||
cronStr := flag.Arg(0)
|
||||
if len(cronStr) == 0 {
|
||||
flag.Usage()
|
||||
return
|
||||
}
|
||||
|
||||
inTime := time.Now()
|
||||
inTimeLayout := ""
|
||||
timeStrLen := len(inTimeStr)
|
||||
if timeStrLen == 2 {
|
||||
inTimeLayout = "06"
|
||||
} else if timeStrLen >= 4 {
|
||||
inTimeLayout += "2006"
|
||||
if timeStrLen >= 7 {
|
||||
inTimeLayout += "-01"
|
||||
if timeStrLen >= 10 {
|
||||
inTimeLayout += "-02"
|
||||
if timeStrLen >= 13 {
|
||||
inTimeLayout += "T15"
|
||||
if timeStrLen >= 16 {
|
||||
inTimeLayout += ":04"
|
||||
if timeStrLen >= 19 {
|
||||
inTimeLayout += ":05"
|
||||
if timeStrLen >= 20 {
|
||||
inTimeLayout += "Z07:00"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if len(inTimeLayout) > 0 {
|
||||
// default to local time zone
|
||||
if timeStrLen < 20 {
|
||||
inTime, err = time.ParseInLocation(inTimeLayout, inTimeStr, time.Local)
|
||||
} else {
|
||||
inTime, err = time.Parse(inTimeLayout, inTimeStr)
|
||||
}
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "# error: unparseable time value: \"%s\"\n", inTimeStr)
|
||||
os.Exit(1)
|
||||
}
|
||||
}
|
||||
|
||||
expr, err := cronexpr.Parse(cronStr)
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "# %s: %s\n", os.Args[0], err)
|
||||
os.Exit(1)
|
||||
}
|
||||
|
||||
// Anything on the output which starts with '#' can be ignored if the caller
|
||||
// is interested only in the time values. There is only one time
|
||||
// value per line, and they are always in chronological ascending order.
|
||||
fmt.Printf("# \"%s\" + \"%s\" =\n", cronStr, inTime.Format(time.RFC3339))
|
||||
|
||||
if outTimeCount < 1 {
|
||||
outTimeCount = 1
|
||||
}
|
||||
outTimes := expr.NextN(inTime, outTimeCount)
|
||||
for _, outTime := range outTimes {
|
||||
fmt.Println(outTime.Format(outTimeLayout))
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,292 @@
|
|||
/*!
|
||||
* Copyright 2013 Raymond Hill
|
||||
*
|
||||
* Project: github.com/gorhill/cronexpr
|
||||
* File: cronexpr_next.go
|
||||
* Version: 1.0
|
||||
* License: pick the one which suits you :
|
||||
* GPL v3 see <https://www.gnu.org/licenses/gpl.html>
|
||||
* APL v2 see <http://www.apache.org/licenses/LICENSE-2.0>
|
||||
*
|
||||
*/
|
||||
|
||||
package cronexpr
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
import (
|
||||
"sort"
|
||||
"time"
|
||||
)
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
var dowNormalizedOffsets = [][]int{
|
||||
{1, 8, 15, 22, 29},
|
||||
{2, 9, 16, 23, 30},
|
||||
{3, 10, 17, 24, 31},
|
||||
{4, 11, 18, 25},
|
||||
{5, 12, 19, 26},
|
||||
{6, 13, 20, 27},
|
||||
{7, 14, 21, 28},
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
func (expr *Expression) nextYear(t time.Time) time.Time {
|
||||
// Find index at which item in list is greater or equal to
|
||||
// candidate year
|
||||
i := sort.SearchInts(expr.yearList, t.Year()+1)
|
||||
if i == len(expr.yearList) {
|
||||
return time.Time{}
|
||||
}
|
||||
// Year changed, need to recalculate actual days of month
|
||||
expr.actualDaysOfMonthList = expr.calculateActualDaysOfMonth(expr.yearList[i], expr.monthList[0])
|
||||
if len(expr.actualDaysOfMonthList) == 0 {
|
||||
return expr.nextMonth(time.Date(
|
||||
expr.yearList[i],
|
||||
time.Month(expr.monthList[0]),
|
||||
1,
|
||||
expr.hourList[0],
|
||||
expr.minuteList[0],
|
||||
expr.secondList[0],
|
||||
0,
|
||||
t.Location()))
|
||||
}
|
||||
return time.Date(
|
||||
expr.yearList[i],
|
||||
time.Month(expr.monthList[0]),
|
||||
expr.actualDaysOfMonthList[0],
|
||||
expr.hourList[0],
|
||||
expr.minuteList[0],
|
||||
expr.secondList[0],
|
||||
0,
|
||||
t.Location())
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
func (expr *Expression) nextMonth(t time.Time) time.Time {
|
||||
// Find index at which item in list is greater or equal to
|
||||
// candidate month
|
||||
i := sort.SearchInts(expr.monthList, int(t.Month())+1)
|
||||
if i == len(expr.monthList) {
|
||||
return expr.nextYear(t)
|
||||
}
|
||||
// Month changed, need to recalculate actual days of month
|
||||
expr.actualDaysOfMonthList = expr.calculateActualDaysOfMonth(t.Year(), expr.monthList[i])
|
||||
if len(expr.actualDaysOfMonthList) == 0 {
|
||||
return expr.nextMonth(time.Date(
|
||||
t.Year(),
|
||||
time.Month(expr.monthList[i]),
|
||||
1,
|
||||
expr.hourList[0],
|
||||
expr.minuteList[0],
|
||||
expr.secondList[0],
|
||||
0,
|
||||
t.Location()))
|
||||
}
|
||||
|
||||
return time.Date(
|
||||
t.Year(),
|
||||
time.Month(expr.monthList[i]),
|
||||
expr.actualDaysOfMonthList[0],
|
||||
expr.hourList[0],
|
||||
expr.minuteList[0],
|
||||
expr.secondList[0],
|
||||
0,
|
||||
t.Location())
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
func (expr *Expression) nextDayOfMonth(t time.Time) time.Time {
|
||||
// Find index at which item in list is greater or equal to
|
||||
// candidate day of month
|
||||
i := sort.SearchInts(expr.actualDaysOfMonthList, t.Day()+1)
|
||||
if i == len(expr.actualDaysOfMonthList) {
|
||||
return expr.nextMonth(t)
|
||||
}
|
||||
|
||||
return time.Date(
|
||||
t.Year(),
|
||||
t.Month(),
|
||||
expr.actualDaysOfMonthList[i],
|
||||
expr.hourList[0],
|
||||
expr.minuteList[0],
|
||||
expr.secondList[0],
|
||||
0,
|
||||
t.Location())
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
func (expr *Expression) nextHour(t time.Time) time.Time {
|
||||
// Find index at which item in list is greater or equal to
|
||||
// candidate hour
|
||||
i := sort.SearchInts(expr.hourList, t.Hour()+1)
|
||||
if i == len(expr.hourList) {
|
||||
return expr.nextDayOfMonth(t)
|
||||
}
|
||||
|
||||
return time.Date(
|
||||
t.Year(),
|
||||
t.Month(),
|
||||
t.Day(),
|
||||
expr.hourList[i],
|
||||
expr.minuteList[0],
|
||||
expr.secondList[0],
|
||||
0,
|
||||
t.Location())
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
func (expr *Expression) nextMinute(t time.Time) time.Time {
|
||||
// Find index at which item in list is greater or equal to
|
||||
// candidate minute
|
||||
i := sort.SearchInts(expr.minuteList, t.Minute()+1)
|
||||
if i == len(expr.minuteList) {
|
||||
return expr.nextHour(t)
|
||||
}
|
||||
|
||||
return time.Date(
|
||||
t.Year(),
|
||||
t.Month(),
|
||||
t.Day(),
|
||||
t.Hour(),
|
||||
expr.minuteList[i],
|
||||
expr.secondList[0],
|
||||
0,
|
||||
t.Location())
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
func (expr *Expression) nextSecond(t time.Time) time.Time {
|
||||
// nextSecond() assumes all other fields are exactly matched
|
||||
// to the cron expression
|
||||
|
||||
// Find index at which item in list is greater or equal to
|
||||
// candidate second
|
||||
i := sort.SearchInts(expr.secondList, t.Second()+1)
|
||||
if i == len(expr.secondList) {
|
||||
return expr.nextMinute(t)
|
||||
}
|
||||
|
||||
return time.Date(
|
||||
t.Year(),
|
||||
t.Month(),
|
||||
t.Day(),
|
||||
t.Hour(),
|
||||
t.Minute(),
|
||||
expr.secondList[i],
|
||||
0,
|
||||
t.Location())
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
func (expr *Expression) calculateActualDaysOfMonth(year, month int) []int {
|
||||
actualDaysOfMonthMap := make(map[int]bool)
|
||||
firstDayOfMonth := time.Date(year, time.Month(month), 1, 0, 0, 0, 0, time.UTC)
|
||||
lastDayOfMonth := firstDayOfMonth.AddDate(0, 1, -1)
|
||||
|
||||
// As per crontab man page (http://linux.die.net/man/5/crontab#):
|
||||
// "The day of a command's execution can be specified by two
|
||||
// "fields - day of month, and day of week. If both fields are
|
||||
// "restricted (ie, aren't *), the command will be run when
|
||||
// "either field matches the current time"
|
||||
|
||||
// If both fields are not restricted, all days of the month are a hit
|
||||
if expr.daysOfMonthRestricted == false && expr.daysOfWeekRestricted == false {
|
||||
return genericDefaultList[1 : lastDayOfMonth.Day()+1]
|
||||
}
|
||||
|
||||
// day-of-month != `*`
|
||||
if expr.daysOfMonthRestricted {
|
||||
// Last day of month
|
||||
if expr.lastDayOfMonth {
|
||||
actualDaysOfMonthMap[lastDayOfMonth.Day()] = true
|
||||
}
|
||||
// Last work day of month
|
||||
if expr.lastWorkdayOfMonth {
|
||||
actualDaysOfMonthMap[workdayOfMonth(lastDayOfMonth, lastDayOfMonth)] = true
|
||||
}
|
||||
// Days of month
|
||||
for v := range expr.daysOfMonth {
|
||||
// Ignore days beyond end of month
|
||||
if v <= lastDayOfMonth.Day() {
|
||||
actualDaysOfMonthMap[v] = true
|
||||
}
|
||||
}
|
||||
// Work days of month
|
||||
// As per Wikipedia: month boundaries are not crossed.
|
||||
for v := range expr.workdaysOfMonth {
|
||||
// Ignore days beyond end of month
|
||||
if v <= lastDayOfMonth.Day() {
|
||||
actualDaysOfMonthMap[workdayOfMonth(firstDayOfMonth.AddDate(0, 0, v-1), lastDayOfMonth)] = true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// day-of-week != `*`
|
||||
if expr.daysOfWeekRestricted {
|
||||
// How far first sunday is from first day of month
|
||||
offset := 7 - int(firstDayOfMonth.Weekday())
|
||||
// days of week
|
||||
// offset : (7 - day_of_week_of_1st_day_of_month)
|
||||
// target : 1 + (7 * week_of_month) + (offset + day_of_week) % 7
|
||||
for v := range expr.daysOfWeek {
|
||||
w := dowNormalizedOffsets[(offset+v)%7]
|
||||
actualDaysOfMonthMap[w[0]] = true
|
||||
actualDaysOfMonthMap[w[1]] = true
|
||||
actualDaysOfMonthMap[w[2]] = true
|
||||
actualDaysOfMonthMap[w[3]] = true
|
||||
if len(w) > 4 && w[4] <= lastDayOfMonth.Day() {
|
||||
actualDaysOfMonthMap[w[4]] = true
|
||||
}
|
||||
}
|
||||
// days of week of specific week in the month
|
||||
// offset : (7 - day_of_week_of_1st_day_of_month)
|
||||
// target : 1 + (7 * week_of_month) + (offset + day_of_week) % 7
|
||||
for v := range expr.specificWeekDaysOfWeek {
|
||||
v = 1 + 7*(v/7) + (offset+v)%7
|
||||
if v <= lastDayOfMonth.Day() {
|
||||
actualDaysOfMonthMap[v] = true
|
||||
}
|
||||
}
|
||||
// Last days of week of the month
|
||||
lastWeekOrigin := firstDayOfMonth.AddDate(0, 1, -7)
|
||||
offset = 7 - int(lastWeekOrigin.Weekday())
|
||||
for v := range expr.lastWeekDaysOfWeek {
|
||||
v = lastWeekOrigin.Day() + (offset+v)%7
|
||||
if v <= lastDayOfMonth.Day() {
|
||||
actualDaysOfMonthMap[v] = true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return toList(actualDaysOfMonthMap)
|
||||
}
|
||||
|
||||
func workdayOfMonth(targetDom, lastDom time.Time) int {
|
||||
// If saturday, then friday
|
||||
// If sunday, then monday
|
||||
dom := targetDom.Day()
|
||||
dow := targetDom.Weekday()
|
||||
if dow == time.Saturday {
|
||||
if dom > 1 {
|
||||
dom -= 1
|
||||
} else {
|
||||
dom += 2
|
||||
}
|
||||
} else if dow == time.Sunday {
|
||||
if dom < lastDom.Day() {
|
||||
dom += 1
|
||||
} else {
|
||||
dom -= 2
|
||||
}
|
||||
}
|
||||
return dom
|
||||
}
|
||||
|
|
@ -0,0 +1,488 @@
|
|||
/*!
|
||||
* Copyright 2013 Raymond Hill
|
||||
*
|
||||
* Project: github.com/gorhill/cronexpr
|
||||
* File: cronexpr_parse.go
|
||||
* Version: 1.0
|
||||
* License: pick the one which suits you best:
|
||||
* GPL v3 see <https://www.gnu.org/licenses/gpl.html>
|
||||
* APL v2 see <http://www.apache.org/licenses/LICENSE-2.0>
|
||||
*
|
||||
*/
|
||||
|
||||
package cronexpr
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"regexp"
|
||||
"sort"
|
||||
"strings"
|
||||
)
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
var (
|
||||
genericDefaultList = []int{
|
||||
0, 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,
|
||||
}
|
||||
yearDefaultList = []int{
|
||||
1970, 1971, 1972, 1973, 1974, 1975, 1976, 1977, 1978, 1979,
|
||||
1980, 1981, 1982, 1983, 1984, 1985, 1986, 1987, 1988, 1989,
|
||||
1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
|
||||
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
|
||||
2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
|
||||
2020, 2021, 2022, 2023, 2024, 2025, 2026, 2027, 2028, 2029,
|
||||
2030, 2031, 2032, 2033, 2034, 2035, 2036, 2037, 2038, 2039,
|
||||
2040, 2041, 2042, 2043, 2044, 2045, 2046, 2047, 2048, 2049,
|
||||
2050, 2051, 2052, 2053, 2054, 2055, 2056, 2057, 2058, 2059,
|
||||
2060, 2061, 2062, 2063, 2064, 2065, 2066, 2067, 2068, 2069,
|
||||
2070, 2071, 2072, 2073, 2074, 2075, 2076, 2077, 2078, 2079,
|
||||
2080, 2081, 2082, 2083, 2084, 2085, 2086, 2087, 2088, 2089,
|
||||
2090, 2091, 2092, 2093, 2094, 2095, 2096, 2097, 2098, 2099,
|
||||
}
|
||||
)
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
var (
|
||||
numberTokens = map[string]int{
|
||||
"0": 0, "1": 1, "2": 2, "3": 3, "4": 4, "5": 5, "6": 6, "7": 7, "8": 8, "9": 9,
|
||||
"10": 10, "11": 11, "12": 12, "13": 13, "14": 14, "15": 15, "16": 16, "17": 17, "18": 18, "19": 19,
|
||||
"20": 20, "21": 21, "22": 22, "23": 23, "24": 24, "25": 25, "26": 26, "27": 27, "28": 28, "29": 29,
|
||||
"30": 30, "31": 31, "32": 32, "33": 33, "34": 34, "35": 35, "36": 36, "37": 37, "38": 38, "39": 39,
|
||||
"40": 40, "41": 41, "42": 42, "43": 43, "44": 44, "45": 45, "46": 46, "47": 47, "48": 48, "49": 49,
|
||||
"50": 50, "51": 51, "52": 52, "53": 53, "54": 54, "55": 55, "56": 56, "57": 57, "58": 58, "59": 59,
|
||||
"1970": 1970, "1971": 1971, "1972": 1972, "1973": 1973, "1974": 1974, "1975": 1975, "1976": 1976, "1977": 1977, "1978": 1978, "1979": 1979,
|
||||
"1980": 1980, "1981": 1981, "1982": 1982, "1983": 1983, "1984": 1984, "1985": 1985, "1986": 1986, "1987": 1987, "1988": 1988, "1989": 1989,
|
||||
"1990": 1990, "1991": 1991, "1992": 1992, "1993": 1993, "1994": 1994, "1995": 1995, "1996": 1996, "1997": 1997, "1998": 1998, "1999": 1999,
|
||||
"2000": 2000, "2001": 2001, "2002": 2002, "2003": 2003, "2004": 2004, "2005": 2005, "2006": 2006, "2007": 2007, "2008": 2008, "2009": 2009,
|
||||
"2010": 2010, "2011": 2011, "2012": 2012, "2013": 2013, "2014": 2014, "2015": 2015, "2016": 2016, "2017": 2017, "2018": 2018, "2019": 2019,
|
||||
"2020": 2020, "2021": 2021, "2022": 2022, "2023": 2023, "2024": 2024, "2025": 2025, "2026": 2026, "2027": 2027, "2028": 2028, "2029": 2029,
|
||||
"2030": 2030, "2031": 2031, "2032": 2032, "2033": 2033, "2034": 2034, "2035": 2035, "2036": 2036, "2037": 2037, "2038": 2038, "2039": 2039,
|
||||
"2040": 2040, "2041": 2041, "2042": 2042, "2043": 2043, "2044": 2044, "2045": 2045, "2046": 2046, "2047": 2047, "2048": 2048, "2049": 2049,
|
||||
"2050": 2050, "2051": 2051, "2052": 2052, "2053": 2053, "2054": 2054, "2055": 2055, "2056": 2056, "2057": 2057, "2058": 2058, "2059": 2059,
|
||||
"2060": 2060, "2061": 2061, "2062": 2062, "2063": 2063, "2064": 2064, "2065": 2065, "2066": 2066, "2067": 2067, "2068": 2068, "2069": 2069,
|
||||
"2070": 2070, "2071": 2071, "2072": 2072, "2073": 2073, "2074": 2074, "2075": 2075, "2076": 2076, "2077": 2077, "2078": 2078, "2079": 2079,
|
||||
"2080": 2080, "2081": 2081, "2082": 2082, "2083": 2083, "2084": 2084, "2085": 2085, "2086": 2086, "2087": 2087, "2088": 2088, "2089": 2089,
|
||||
"2090": 2090, "2091": 2091, "2092": 2092, "2093": 2093, "2094": 2094, "2095": 2095, "2096": 2096, "2097": 2097, "2098": 2098, "2099": 2099,
|
||||
}
|
||||
monthTokens = map[string]int{
|
||||
`1`: 1, `jan`: 1, `january`: 1,
|
||||
`2`: 2, `feb`: 2, `february`: 2,
|
||||
`3`: 3, `mar`: 3, `march`: 3,
|
||||
`4`: 4, `apr`: 4, `april`: 4,
|
||||
`5`: 5, `may`: 5,
|
||||
`6`: 6, `jun`: 6, `june`: 6,
|
||||
`7`: 7, `jul`: 7, `july`: 7,
|
||||
`8`: 8, `aug`: 8, `august`: 8,
|
||||
`9`: 9, `sep`: 9, `september`: 9,
|
||||
`10`: 10, `oct`: 10, `october`: 10,
|
||||
`11`: 11, `nov`: 11, `november`: 11,
|
||||
`12`: 12, `dec`: 12, `december`: 12,
|
||||
}
|
||||
dowTokens = map[string]int{
|
||||
`0`: 0, `sun`: 0, `sunday`: 0,
|
||||
`1`: 1, `mon`: 1, `monday`: 1,
|
||||
`2`: 2, `tue`: 2, `tuesday`: 2,
|
||||
`3`: 3, `wed`: 3, `wednesday`: 3,
|
||||
`4`: 4, `thu`: 4, `thursday`: 4,
|
||||
`5`: 5, `fri`: 5, `friday`: 5,
|
||||
`6`: 6, `sat`: 6, `saturday`: 6,
|
||||
`7`: 0,
|
||||
}
|
||||
)
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
func atoi(s string) int {
|
||||
return numberTokens[s]
|
||||
}
|
||||
|
||||
type fieldDescriptor struct {
|
||||
name string
|
||||
min, max int
|
||||
defaultList []int
|
||||
valuePattern string
|
||||
atoi func(string) int
|
||||
}
|
||||
|
||||
var (
|
||||
secondDescriptor = fieldDescriptor{
|
||||
name: "second",
|
||||
min: 0,
|
||||
max: 59,
|
||||
defaultList: genericDefaultList[0:60],
|
||||
valuePattern: `[0-9]|[1-5][0-9]`,
|
||||
atoi: atoi,
|
||||
}
|
||||
minuteDescriptor = fieldDescriptor{
|
||||
name: "minute",
|
||||
min: 0,
|
||||
max: 59,
|
||||
defaultList: genericDefaultList[0:60],
|
||||
valuePattern: `[0-9]|[1-5][0-9]`,
|
||||
atoi: atoi,
|
||||
}
|
||||
hourDescriptor = fieldDescriptor{
|
||||
name: "hour",
|
||||
min: 0,
|
||||
max: 23,
|
||||
defaultList: genericDefaultList[0:24],
|
||||
valuePattern: `[0-9]|1[0-9]|2[0-3]`,
|
||||
atoi: atoi,
|
||||
}
|
||||
domDescriptor = fieldDescriptor{
|
||||
name: "day-of-month",
|
||||
min: 1,
|
||||
max: 31,
|
||||
defaultList: genericDefaultList[1:32],
|
||||
valuePattern: `[1-9]|[12][0-9]|3[01]`,
|
||||
atoi: atoi,
|
||||
}
|
||||
monthDescriptor = fieldDescriptor{
|
||||
name: "month",
|
||||
min: 1,
|
||||
max: 12,
|
||||
defaultList: genericDefaultList[1:13],
|
||||
valuePattern: `[1-9]|1[012]|jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec|january|february|march|april|march|april|june|july|august|september|october|november|december`,
|
||||
atoi: func(s string) int {
|
||||
return monthTokens[s]
|
||||
},
|
||||
}
|
||||
dowDescriptor = fieldDescriptor{
|
||||
name: "day-of-week",
|
||||
min: 0,
|
||||
max: 6,
|
||||
defaultList: genericDefaultList[0:7],
|
||||
valuePattern: `[0-7]|sun|mon|tue|wed|thu|fri|sat|sunday|monday|tuesday|wednesday|thursday|friday|saturday`,
|
||||
atoi: func(s string) int {
|
||||
return dowTokens[s]
|
||||
},
|
||||
}
|
||||
yearDescriptor = fieldDescriptor{
|
||||
name: "year",
|
||||
min: 1970,
|
||||
max: 2099,
|
||||
defaultList: yearDefaultList[:],
|
||||
valuePattern: `19[789][0-9]|20[0-9]{2}`,
|
||||
atoi: atoi,
|
||||
}
|
||||
)
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
var (
|
||||
layoutWildcard = `^\*$|^\?$`
|
||||
layoutValue = `^(%value%)$`
|
||||
layoutRange = `^(%value%)-(%value%)$`
|
||||
layoutWildcardAndInterval = `^\*/(\d+)$`
|
||||
layoutValueAndInterval = `^(%value%)/(\d+)$`
|
||||
layoutRangeAndInterval = `^(%value%)-(%value%)/(\d+)$`
|
||||
layoutLastDom = `^l$`
|
||||
layoutWorkdom = `^(%value%)w$`
|
||||
layoutLastWorkdom = `^lw$`
|
||||
layoutDowOfLastWeek = `^(%value%)l$`
|
||||
layoutDowOfSpecificWeek = `^(%value%)#([1-5])$`
|
||||
fieldFinder = regexp.MustCompile(`\S+`)
|
||||
entryFinder = regexp.MustCompile(`[^,]+`)
|
||||
layoutRegexp = make(map[string]*regexp.Regexp)
|
||||
)
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
var cronNormalizer = strings.NewReplacer(
|
||||
"@yearly", "0 0 0 1 1 * *",
|
||||
"@annually", "0 0 0 1 1 * *",
|
||||
"@monthly", "0 0 0 1 * * *",
|
||||
"@weekly", "0 0 0 * * 0 *",
|
||||
"@daily", "0 0 0 * * * *",
|
||||
"@hourly", "0 0 * * * * *")
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
func (expr *Expression) secondFieldHandler(s string) error {
|
||||
var err error
|
||||
expr.secondList, err = genericFieldHandler(s, secondDescriptor)
|
||||
return err
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
func (expr *Expression) minuteFieldHandler(s string) error {
|
||||
var err error
|
||||
expr.minuteList, err = genericFieldHandler(s, minuteDescriptor)
|
||||
return err
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
func (expr *Expression) hourFieldHandler(s string) error {
|
||||
var err error
|
||||
expr.hourList, err = genericFieldHandler(s, hourDescriptor)
|
||||
return err
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
func (expr *Expression) monthFieldHandler(s string) error {
|
||||
var err error
|
||||
expr.monthList, err = genericFieldHandler(s, monthDescriptor)
|
||||
return err
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
func (expr *Expression) yearFieldHandler(s string) error {
|
||||
var err error
|
||||
expr.yearList, err = genericFieldHandler(s, yearDescriptor)
|
||||
return err
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
const (
|
||||
none = 0
|
||||
one = 1
|
||||
span = 2
|
||||
all = 3
|
||||
)
|
||||
|
||||
type cronDirective struct {
|
||||
kind int
|
||||
first int
|
||||
last int
|
||||
step int
|
||||
sbeg int
|
||||
send int
|
||||
}
|
||||
|
||||
func genericFieldHandler(s string, desc fieldDescriptor) ([]int, error) {
|
||||
directives, err := genericFieldParse(s, desc)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
values := make(map[int]bool)
|
||||
for _, directive := range directives {
|
||||
switch directive.kind {
|
||||
case none:
|
||||
return nil, fmt.Errorf("syntax error in %s field: '%s'", desc.name, s[directive.sbeg:directive.send])
|
||||
case one:
|
||||
populateOne(values, directive.first)
|
||||
case span:
|
||||
populateMany(values, directive.first, directive.last, directive.step)
|
||||
case all:
|
||||
return desc.defaultList, nil
|
||||
}
|
||||
}
|
||||
return toList(values), nil
|
||||
}
|
||||
|
||||
func (expr *Expression) dowFieldHandler(s string) error {
|
||||
expr.daysOfWeekRestricted = true
|
||||
expr.daysOfWeek = make(map[int]bool)
|
||||
expr.lastWeekDaysOfWeek = make(map[int]bool)
|
||||
expr.specificWeekDaysOfWeek = make(map[int]bool)
|
||||
|
||||
directives, err := genericFieldParse(s, dowDescriptor)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
for _, directive := range directives {
|
||||
switch directive.kind {
|
||||
case none:
|
||||
sdirective := s[directive.sbeg:directive.send]
|
||||
snormal := strings.ToLower(sdirective)
|
||||
// `5L`
|
||||
pairs := makeLayoutRegexp(layoutDowOfLastWeek, dowDescriptor.valuePattern).FindStringSubmatchIndex(snormal)
|
||||
if len(pairs) > 0 {
|
||||
populateOne(expr.lastWeekDaysOfWeek, dowDescriptor.atoi(snormal[pairs[2]:pairs[3]]))
|
||||
} else {
|
||||
// `5#3`
|
||||
pairs := makeLayoutRegexp(layoutDowOfSpecificWeek, dowDescriptor.valuePattern).FindStringSubmatchIndex(snormal)
|
||||
if len(pairs) > 0 {
|
||||
populateOne(expr.specificWeekDaysOfWeek, (dowDescriptor.atoi(snormal[pairs[4]:pairs[5]])-1)*7+(dowDescriptor.atoi(snormal[pairs[2]:pairs[3]])%7))
|
||||
} else {
|
||||
return fmt.Errorf("syntax error in day-of-week field: '%s'", sdirective)
|
||||
}
|
||||
}
|
||||
case one:
|
||||
populateOne(expr.daysOfWeek, directive.first)
|
||||
case span:
|
||||
populateMany(expr.daysOfWeek, directive.first, directive.last, directive.step)
|
||||
case all:
|
||||
populateMany(expr.daysOfWeek, directive.first, directive.last, directive.step)
|
||||
expr.daysOfWeekRestricted = false
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (expr *Expression) domFieldHandler(s string) error {
|
||||
expr.daysOfMonthRestricted = true
|
||||
expr.lastDayOfMonth = false
|
||||
expr.lastWorkdayOfMonth = false
|
||||
expr.daysOfMonth = make(map[int]bool) // days of month map
|
||||
expr.workdaysOfMonth = make(map[int]bool) // work days of month map
|
||||
|
||||
directives, err := genericFieldParse(s, domDescriptor)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
for _, directive := range directives {
|
||||
switch directive.kind {
|
||||
case none:
|
||||
sdirective := s[directive.sbeg:directive.send]
|
||||
snormal := strings.ToLower(sdirective)
|
||||
// `L`
|
||||
if makeLayoutRegexp(layoutLastDom, domDescriptor.valuePattern).MatchString(snormal) {
|
||||
expr.lastDayOfMonth = true
|
||||
} else {
|
||||
// `LW`
|
||||
if makeLayoutRegexp(layoutLastWorkdom, domDescriptor.valuePattern).MatchString(snormal) {
|
||||
expr.lastWorkdayOfMonth = true
|
||||
} else {
|
||||
// `15W`
|
||||
pairs := makeLayoutRegexp(layoutWorkdom, domDescriptor.valuePattern).FindStringSubmatchIndex(snormal)
|
||||
if len(pairs) > 0 {
|
||||
populateOne(expr.workdaysOfMonth, domDescriptor.atoi(snormal[pairs[2]:pairs[3]]))
|
||||
} else {
|
||||
return fmt.Errorf("syntax error in day-of-month field: '%s'", sdirective)
|
||||
}
|
||||
}
|
||||
}
|
||||
case one:
|
||||
populateOne(expr.daysOfMonth, directive.first)
|
||||
case span:
|
||||
populateMany(expr.daysOfMonth, directive.first, directive.last, directive.step)
|
||||
case all:
|
||||
populateMany(expr.daysOfMonth, directive.first, directive.last, directive.step)
|
||||
expr.daysOfMonthRestricted = false
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
func populateOne(values map[int]bool, v int) {
|
||||
values[v] = true
|
||||
}
|
||||
|
||||
func populateMany(values map[int]bool, min, max, step int) {
|
||||
for i := min; i <= max; i += step {
|
||||
values[i] = true
|
||||
}
|
||||
}
|
||||
|
||||
func toList(set map[int]bool) []int {
|
||||
list := make([]int, len(set))
|
||||
i := 0
|
||||
for k := range set {
|
||||
list[i] = k
|
||||
i += 1
|
||||
}
|
||||
sort.Ints(list)
|
||||
return list
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
func genericFieldParse(s string, desc fieldDescriptor) ([]*cronDirective, error) {
|
||||
// At least one entry must be present
|
||||
indices := entryFinder.FindAllStringIndex(s, -1)
|
||||
if len(indices) == 0 {
|
||||
return nil, fmt.Errorf("%s field: missing directive", desc.name)
|
||||
}
|
||||
|
||||
directives := make([]*cronDirective, 0, len(indices))
|
||||
|
||||
for i := range indices {
|
||||
directive := cronDirective{
|
||||
sbeg: indices[i][0],
|
||||
send: indices[i][1],
|
||||
}
|
||||
snormal := strings.ToLower(s[indices[i][0]:indices[i][1]])
|
||||
|
||||
// `*`
|
||||
if makeLayoutRegexp(layoutWildcard, desc.valuePattern).MatchString(snormal) {
|
||||
directive.kind = all
|
||||
directive.first = desc.min
|
||||
directive.last = desc.max
|
||||
directive.step = 1
|
||||
directives = append(directives, &directive)
|
||||
continue
|
||||
}
|
||||
// `5`
|
||||
if makeLayoutRegexp(layoutValue, desc.valuePattern).MatchString(snormal) {
|
||||
directive.kind = one
|
||||
directive.first = desc.atoi(snormal)
|
||||
directives = append(directives, &directive)
|
||||
continue
|
||||
}
|
||||
// `5-20`
|
||||
pairs := makeLayoutRegexp(layoutRange, desc.valuePattern).FindStringSubmatchIndex(snormal)
|
||||
if len(pairs) > 0 {
|
||||
directive.kind = span
|
||||
directive.first = desc.atoi(snormal[pairs[2]:pairs[3]])
|
||||
directive.last = desc.atoi(snormal[pairs[4]:pairs[5]])
|
||||
directive.step = 1
|
||||
directives = append(directives, &directive)
|
||||
continue
|
||||
}
|
||||
// `*/2`
|
||||
pairs = makeLayoutRegexp(layoutWildcardAndInterval, desc.valuePattern).FindStringSubmatchIndex(snormal)
|
||||
if len(pairs) > 0 {
|
||||
directive.kind = span
|
||||
directive.first = desc.min
|
||||
directive.last = desc.max
|
||||
directive.step = atoi(snormal[pairs[2]:pairs[3]])
|
||||
directives = append(directives, &directive)
|
||||
continue
|
||||
}
|
||||
// `5/2`
|
||||
pairs = makeLayoutRegexp(layoutValueAndInterval, desc.valuePattern).FindStringSubmatchIndex(snormal)
|
||||
if len(pairs) > 0 {
|
||||
directive.kind = span
|
||||
directive.first = desc.atoi(snormal[pairs[2]:pairs[3]])
|
||||
directive.last = desc.max
|
||||
directive.step = atoi(snormal[pairs[4]:pairs[5]])
|
||||
directives = append(directives, &directive)
|
||||
continue
|
||||
}
|
||||
// `5-20/2`
|
||||
pairs = makeLayoutRegexp(layoutRangeAndInterval, desc.valuePattern).FindStringSubmatchIndex(snormal)
|
||||
if len(pairs) > 0 {
|
||||
directive.kind = span
|
||||
directive.first = desc.atoi(snormal[pairs[2]:pairs[3]])
|
||||
directive.last = desc.atoi(snormal[pairs[4]:pairs[5]])
|
||||
directive.step = atoi(snormal[pairs[6]:pairs[7]])
|
||||
directives = append(directives, &directive)
|
||||
continue
|
||||
}
|
||||
// No behavior for this one, let caller deal with it
|
||||
directive.kind = none
|
||||
directives = append(directives, &directive)
|
||||
}
|
||||
return directives, nil
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
func makeLayoutRegexp(layout, value string) *regexp.Regexp {
|
||||
layout = strings.Replace(layout, `%value%`, value, -1)
|
||||
re := layoutRegexp[layout]
|
||||
if re == nil {
|
||||
re = regexp.MustCompile(layout)
|
||||
layoutRegexp[layout] = re
|
||||
}
|
||||
return re
|
||||
}
|
||||
|
|
@ -0,0 +1,321 @@
|
|||
/*!
|
||||
* Copyright 2013 Raymond Hill
|
||||
*
|
||||
* Project: github.com/gorhill/cronexpr
|
||||
* File: cronexpr_test.go
|
||||
* Version: 1.0
|
||||
* License: pick the one which suits you best:
|
||||
* GPL v3 see <https://www.gnu.org/licenses/gpl.html>
|
||||
* APL v2 see <http://www.apache.org/licenses/LICENSE-2.0>
|
||||
*
|
||||
*/
|
||||
|
||||
package cronexpr_test
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
import (
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/gorhill/cronexpr"
|
||||
)
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
type crontimes struct {
|
||||
from string
|
||||
next string
|
||||
}
|
||||
|
||||
type crontest struct {
|
||||
expr string
|
||||
layout string
|
||||
times []crontimes
|
||||
}
|
||||
|
||||
var crontests = []crontest{
|
||||
// Seconds
|
||||
{
|
||||
"* * * * * * *",
|
||||
"2006-01-02 15:04:05",
|
||||
[]crontimes{
|
||||
{"2013-01-01 00:00:00", "2013-01-01 00:00:01"},
|
||||
{"2013-01-01 00:00:59", "2013-01-01 00:01:00"},
|
||||
{"2013-01-01 00:59:59", "2013-01-01 01:00:00"},
|
||||
{"2013-01-01 23:59:59", "2013-01-02 00:00:00"},
|
||||
{"2013-02-28 23:59:59", "2013-03-01 00:00:00"},
|
||||
{"2016-02-28 23:59:59", "2016-02-29 00:00:00"},
|
||||
{"2012-12-31 23:59:59", "2013-01-01 00:00:00"},
|
||||
},
|
||||
},
|
||||
|
||||
// every 5 Second
|
||||
{
|
||||
"*/5 * * * * * *",
|
||||
"2006-01-02 15:04:05",
|
||||
[]crontimes{
|
||||
{"2013-01-01 00:00:00", "2013-01-01 00:00:05"},
|
||||
{"2013-01-01 00:00:59", "2013-01-01 00:01:00"},
|
||||
{"2013-01-01 00:59:59", "2013-01-01 01:00:00"},
|
||||
{"2013-01-01 23:59:59", "2013-01-02 00:00:00"},
|
||||
{"2013-02-28 23:59:59", "2013-03-01 00:00:00"},
|
||||
{"2016-02-28 23:59:59", "2016-02-29 00:00:00"},
|
||||
{"2012-12-31 23:59:59", "2013-01-01 00:00:00"},
|
||||
},
|
||||
},
|
||||
|
||||
// Minutes
|
||||
{
|
||||
"* * * * *",
|
||||
"2006-01-02 15:04:05",
|
||||
[]crontimes{
|
||||
{"2013-01-01 00:00:00", "2013-01-01 00:01:00"},
|
||||
{"2013-01-01 00:00:59", "2013-01-01 00:01:00"},
|
||||
{"2013-01-01 00:59:00", "2013-01-01 01:00:00"},
|
||||
{"2013-01-01 23:59:00", "2013-01-02 00:00:00"},
|
||||
{"2013-02-28 23:59:00", "2013-03-01 00:00:00"},
|
||||
{"2016-02-28 23:59:00", "2016-02-29 00:00:00"},
|
||||
{"2012-12-31 23:59:00", "2013-01-01 00:00:00"},
|
||||
},
|
||||
},
|
||||
|
||||
// Minutes with interval
|
||||
{
|
||||
"17-43/5 * * * *",
|
||||
"2006-01-02 15:04:05",
|
||||
[]crontimes{
|
||||
{"2013-01-01 00:00:00", "2013-01-01 00:17:00"},
|
||||
{"2013-01-01 00:16:59", "2013-01-01 00:17:00"},
|
||||
{"2013-01-01 00:30:00", "2013-01-01 00:32:00"},
|
||||
{"2013-01-01 00:50:00", "2013-01-01 01:17:00"},
|
||||
{"2013-01-01 23:50:00", "2013-01-02 00:17:00"},
|
||||
{"2013-02-28 23:50:00", "2013-03-01 00:17:00"},
|
||||
{"2016-02-28 23:50:00", "2016-02-29 00:17:00"},
|
||||
{"2012-12-31 23:50:00", "2013-01-01 00:17:00"},
|
||||
},
|
||||
},
|
||||
|
||||
// Minutes interval, list
|
||||
{
|
||||
"15-30/4,55 * * * *",
|
||||
"2006-01-02 15:04:05",
|
||||
[]crontimes{
|
||||
{"2013-01-01 00:00:00", "2013-01-01 00:15:00"},
|
||||
{"2013-01-01 00:16:00", "2013-01-01 00:19:00"},
|
||||
{"2013-01-01 00:30:00", "2013-01-01 00:55:00"},
|
||||
{"2013-01-01 00:55:00", "2013-01-01 01:15:00"},
|
||||
{"2013-01-01 23:55:00", "2013-01-02 00:15:00"},
|
||||
{"2013-02-28 23:55:00", "2013-03-01 00:15:00"},
|
||||
{"2016-02-28 23:55:00", "2016-02-29 00:15:00"},
|
||||
{"2012-12-31 23:54:00", "2012-12-31 23:55:00"},
|
||||
{"2012-12-31 23:55:00", "2013-01-01 00:15:00"},
|
||||
},
|
||||
},
|
||||
|
||||
// Days of week
|
||||
{
|
||||
"0 0 * * MON",
|
||||
"Mon 2006-01-02 15:04",
|
||||
[]crontimes{
|
||||
{"2013-01-01 00:00:00", "Mon 2013-01-07 00:00"},
|
||||
{"2013-01-28 00:00:00", "Mon 2013-02-04 00:00"},
|
||||
{"2013-12-30 00:30:00", "Mon 2014-01-06 00:00"},
|
||||
},
|
||||
},
|
||||
{
|
||||
"0 0 * * friday",
|
||||
"Mon 2006-01-02 15:04",
|
||||
[]crontimes{
|
||||
{"2013-01-01 00:00:00", "Fri 2013-01-04 00:00"},
|
||||
{"2013-01-28 00:00:00", "Fri 2013-02-01 00:00"},
|
||||
{"2013-12-30 00:30:00", "Fri 2014-01-03 00:00"},
|
||||
},
|
||||
},
|
||||
{
|
||||
"0 0 * * 6,7",
|
||||
"Mon 2006-01-02 15:04",
|
||||
[]crontimes{
|
||||
{"2013-01-01 00:00:00", "Sat 2013-01-05 00:00"},
|
||||
{"2013-01-28 00:00:00", "Sat 2013-02-02 00:00"},
|
||||
{"2013-12-30 00:30:00", "Sat 2014-01-04 00:00"},
|
||||
},
|
||||
},
|
||||
|
||||
// Specific days of week
|
||||
{
|
||||
"0 0 * * 6#5",
|
||||
"Mon 2006-01-02 15:04",
|
||||
[]crontimes{
|
||||
{"2013-09-02 00:00:00", "Sat 2013-11-30 00:00"},
|
||||
},
|
||||
},
|
||||
|
||||
// Work day of month
|
||||
{
|
||||
"0 0 14W * *",
|
||||
"Mon 2006-01-02 15:04",
|
||||
[]crontimes{
|
||||
{"2013-03-31 00:00:00", "Mon 2013-04-15 00:00"},
|
||||
{"2013-08-31 00:00:00", "Fri 2013-09-13 00:00"},
|
||||
},
|
||||
},
|
||||
|
||||
// Work day of month -- end of month
|
||||
{
|
||||
"0 0 30W * *",
|
||||
"Mon 2006-01-02 15:04",
|
||||
[]crontimes{
|
||||
{"2013-03-02 00:00:00", "Fri 2013-03-29 00:00"},
|
||||
{"2013-06-02 00:00:00", "Fri 2013-06-28 00:00"},
|
||||
{"2013-09-02 00:00:00", "Mon 2013-09-30 00:00"},
|
||||
{"2013-11-02 00:00:00", "Fri 2013-11-29 00:00"},
|
||||
},
|
||||
},
|
||||
|
||||
// Last day of month
|
||||
{
|
||||
"0 0 L * *",
|
||||
"Mon 2006-01-02 15:04",
|
||||
[]crontimes{
|
||||
{"2013-09-02 00:00:00", "Mon 2013-09-30 00:00"},
|
||||
{"2014-01-01 00:00:00", "Fri 2014-01-31 00:00"},
|
||||
{"2014-02-01 00:00:00", "Fri 2014-02-28 00:00"},
|
||||
{"2016-02-15 00:00:00", "Mon 2016-02-29 00:00"},
|
||||
},
|
||||
},
|
||||
|
||||
// Last work day of month
|
||||
{
|
||||
"0 0 LW * *",
|
||||
"Mon 2006-01-02 15:04",
|
||||
[]crontimes{
|
||||
{"2013-09-02 00:00:00", "Mon 2013-09-30 00:00"},
|
||||
{"2013-11-02 00:00:00", "Fri 2013-11-29 00:00"},
|
||||
{"2014-08-15 00:00:00", "Fri 2014-08-29 00:00"},
|
||||
},
|
||||
},
|
||||
|
||||
// TODO: more tests
|
||||
}
|
||||
|
||||
func TestExpressions(t *testing.T) {
|
||||
for _, test := range crontests {
|
||||
for _, times := range test.times {
|
||||
from, _ := time.Parse("2006-01-02 15:04:05", times.from)
|
||||
expr, err := cronexpr.Parse(test.expr)
|
||||
if err != nil {
|
||||
t.Errorf(`cronexpr.Parse("%s") returned "%s"`, test.expr, err.Error())
|
||||
}
|
||||
next := expr.Next(from)
|
||||
nextstr := next.Format(test.layout)
|
||||
if nextstr != times.next {
|
||||
t.Errorf(`("%s").Next("%s") = "%s", got "%s"`, test.expr, times.from, times.next, nextstr)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
func TestZero(t *testing.T) {
|
||||
from, _ := time.Parse("2006-01-02", "2013-08-31")
|
||||
next := cronexpr.MustParse("* * * * * 1980").Next(from)
|
||||
if next.IsZero() == false {
|
||||
t.Error(`("* * * * * 1980").Next("2013-08-31").IsZero() returned 'false', expected 'true'`)
|
||||
}
|
||||
|
||||
next = cronexpr.MustParse("* * * * * 2050").Next(from)
|
||||
if next.IsZero() == true {
|
||||
t.Error(`("* * * * * 2050").Next("2013-08-31").IsZero() returned 'true', expected 'false'`)
|
||||
}
|
||||
|
||||
next = cronexpr.MustParse("* * * * * 2099").Next(time.Time{})
|
||||
if next.IsZero() == false {
|
||||
t.Error(`("* * * * * 2014").Next(time.Time{}).IsZero() returned 'true', expected 'false'`)
|
||||
}
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
func TestNextN(t *testing.T) {
|
||||
expected := []string{
|
||||
"Sat, 30 Nov 2013 00:00:00",
|
||||
"Sat, 29 Mar 2014 00:00:00",
|
||||
"Sat, 31 May 2014 00:00:00",
|
||||
"Sat, 30 Aug 2014 00:00:00",
|
||||
"Sat, 29 Nov 2014 00:00:00",
|
||||
}
|
||||
from, _ := time.Parse("2006-01-02 15:04:05", "2013-09-02 08:44:30")
|
||||
result := cronexpr.MustParse("0 0 * * 6#5").NextN(from, uint(len(expected)))
|
||||
if len(result) != len(expected) {
|
||||
t.Errorf(`MustParse("0 0 * * 6#5").NextN("2013-09-02 08:44:30", 5):\n"`)
|
||||
t.Errorf(` Expected %d returned time values but got %d instead`, len(expected), len(result))
|
||||
}
|
||||
for i, next := range result {
|
||||
nextStr := next.Format("Mon, 2 Jan 2006 15:04:15")
|
||||
if nextStr != expected[i] {
|
||||
t.Errorf(`MustParse("0 0 * * 6#5").NextN("2013-09-02 08:44:30", 5):\n"`)
|
||||
t.Errorf(` result[%d]: expected "%s" but got "%s"`, i, expected[i], nextStr)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestNextN_every5min(t *testing.T) {
|
||||
expected := []string{
|
||||
"Mon, 2 Sep 2013 08:45:00",
|
||||
"Mon, 2 Sep 2013 08:50:00",
|
||||
"Mon, 2 Sep 2013 08:55:00",
|
||||
"Mon, 2 Sep 2013 09:00:00",
|
||||
"Mon, 2 Sep 2013 09:05:00",
|
||||
}
|
||||
from, _ := time.Parse("2006-01-02 15:04:05", "2013-09-02 08:44:32")
|
||||
result := cronexpr.MustParse("*/5 * * * *").NextN(from, uint(len(expected)))
|
||||
if len(result) != len(expected) {
|
||||
t.Errorf(`MustParse("*/5 * * * *").NextN("2013-09-02 08:44:30", 5):\n"`)
|
||||
t.Errorf(` Expected %d returned time values but got %d instead`, len(expected), len(result))
|
||||
}
|
||||
for i, next := range result {
|
||||
nextStr := next.Format("Mon, 2 Jan 2006 15:04:05")
|
||||
if nextStr != expected[i] {
|
||||
t.Errorf(`MustParse("*/5 * * * *").NextN("2013-09-02 08:44:30", 5):\n"`)
|
||||
t.Errorf(` result[%d]: expected "%s" but got "%s"`, i, expected[i], nextStr)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
var benchmarkExpressions = []string{
|
||||
"* * * * *",
|
||||
"@hourly",
|
||||
"@weekly",
|
||||
"@yearly",
|
||||
"30 3 15W 3/3 *",
|
||||
"30 0 0 1-31/5 Oct-Dec * 2000,2006,2008,2013-2015",
|
||||
"0 0 0 * Feb-Nov/2 thu#3 2000-2050",
|
||||
}
|
||||
var benchmarkExpressionsLen = len(benchmarkExpressions)
|
||||
|
||||
func BenchmarkParse(b *testing.B) {
|
||||
for i := 0; i < b.N; i++ {
|
||||
_ = cronexpr.MustParse(benchmarkExpressions[i%benchmarkExpressionsLen])
|
||||
}
|
||||
}
|
||||
|
||||
func BenchmarkNext(b *testing.B) {
|
||||
exprs := make([]*cronexpr.Expression, benchmarkExpressionsLen)
|
||||
for i := 0; i < benchmarkExpressionsLen; i++ {
|
||||
exprs[i] = cronexpr.MustParse(benchmarkExpressions[i])
|
||||
}
|
||||
from := time.Now()
|
||||
b.ResetTimer()
|
||||
for i := 0; i < b.N; i++ {
|
||||
expr := exprs[i%benchmarkExpressionsLen]
|
||||
next := expr.Next(from)
|
||||
next = expr.Next(next)
|
||||
next = expr.Next(next)
|
||||
next = expr.Next(next)
|
||||
next = expr.Next(next)
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,37 @@
|
|||
/*!
|
||||
* Copyright 2013 Raymond Hill
|
||||
*
|
||||
* Project: github.com/gorhill/example_test.go
|
||||
* File: example_test.go
|
||||
* Version: 1.0
|
||||
* License: GPL v3 see <https://www.gnu.org/licenses/gpl.html>
|
||||
*
|
||||
*/
|
||||
|
||||
package cronexpr_test
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"time"
|
||||
|
||||
"github.com/gorhill/cronexpr"
|
||||
)
|
||||
|
||||
/******************************************************************************/
|
||||
|
||||
// ExampleMustParse
|
||||
func ExampleMustParse() {
|
||||
t := time.Date(2013, time.August, 31, 0, 0, 0, 0, time.UTC)
|
||||
nextTimes := cronexpr.MustParse("0 0 29 2 *").NextN(t, 5)
|
||||
for i := range nextTimes {
|
||||
fmt.Println(nextTimes[i].Format(time.RFC1123))
|
||||
// Output:
|
||||
// Mon, 29 Feb 2016 00:00:00 UTC
|
||||
// Sat, 29 Feb 2020 00:00:00 UTC
|
||||
// Thu, 29 Feb 2024 00:00:00 UTC
|
||||
// Tue, 29 Feb 2028 00:00:00 UTC
|
||||
// Sun, 29 Feb 2032 00:00:00 UTC
|
||||
}
|
||||
}
|
||||
Загрузка…
Ссылка в новой задаче