gopkg/gocron
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: rename module

Browse Source
This commit is contained in:
Сергей Солодягин
2023-12-27 22:03:13 +03:00
parent 848adb4508
commit 083103e4b6
11 changed files with 81 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+64 -51
View File
@@ -1,7 +1,7 @@
# gocron: A Golang Job Scheduling Package # gocron: A Golang Job Scheduling Package
[![CI State](https://github.com/go-co-op/gocron/actions/workflows/go_test.yml/badge.svg?branch=v2&event=push)](https://github.com/go-co-op/gocron/actions) [![CI State](https://github.com/andoma-go/gocron/actions/workflows/go_test.yml/badge.svg?branch=v2&event=push)](https://github.com/andoma-go/gocron/actions)
![Go Report Card](https://goreportcard.com/badge/github.com/go-co-op/gocron) [![Go Doc](https://godoc.org/github.com/go-co-op/gocron/v2?status.svg)](https://pkg.go.dev/github.com/go-co-op/gocron/v2) ![Go Report Card](https://goreportcard.com/badge/github.com/andoma-go/gocron) [![Go Doc](https://godoc.org/github.com/andoma-go/gocron/v2?status.svg)](https://pkg.go.dev/github.com/andoma-go/gocron/v2)
gocron is a job scheduling package which lets you run Go functions at pre-determined intervals. gocron is a job scheduling package which lets you run Go functions at pre-determined intervals.
@@ -11,7 +11,7 @@ If you want to chat, you can find us on Slack at
## Quick Start ## Quick Start
``` ```
go get github.com/go-co-op/gocron/v2 go get github.com/andoma-go/gocron/v2
``` ```
```golang ```golang
@@ -21,7 +21,7 @@ import (
"fmt" "fmt"
"time" "time"
"github.com/go-co-op/gocron/v2" "github.com/andoma-go/gocron/v2"
) )
func main() { func main() {
@@ -70,77 +70,90 @@ func main() {
- **Executor**: The executor calls the job's task and manages the complexities of different job - **Executor**: The executor calls the job's task and manages the complexities of different job
execution timing requirements (e.g. singletons that shouldn't overrun each other, limiting the max number of jobs running) execution timing requirements (e.g. singletons that shouldn't overrun each other, limiting the max number of jobs running)
## Features ## Features
### Job types ### Job types
Jobs can be run at various intervals. Jobs can be run at various intervals.
- [**Duration**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#DurationJob):
Jobs can be run at a fixed `time.Duration`. - [**Duration**](https://pkg.go.dev/github.com/andoma-go/gocron/v2#DurationJob):
- [**Random duration**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#DurationRandomJob): Jobs can be run at a fixed `time.Duration`.
Jobs can be run at a random `time.Duration` between a min and max. - [**Random duration**](https://pkg.go.dev/github.com/andoma-go/gocron/v2#DurationRandomJob):
- [**Cron**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#CronJob): Jobs can be run at a random `time.Duration` between a min and max.
Jobs can be run using a crontab. - [**Cron**](https://pkg.go.dev/github.com/andoma-go/gocron/v2#CronJob):
- [**Daily**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#DailyJob): Jobs can be run using a crontab.
Jobs can be run every x days at specific times. - [**Daily**](https://pkg.go.dev/github.com/andoma-go/gocron/v2#DailyJob):
- [**Weekly**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#WeeklyJob): Jobs can be run every x days at specific times.
Jobs can be run every x weeks on specific days of the week and at specific times. - [**Weekly**](https://pkg.go.dev/github.com/andoma-go/gocron/v2#WeeklyJob):
- [**Monthly**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#MonthlyJob): Jobs can be run every x weeks on specific days of the week and at specific times.
Jobs can be run every x months on specific days of the month and at specific times. - [**Monthly**](https://pkg.go.dev/github.com/andoma-go/gocron/v2#MonthlyJob):
- [**One time**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#OneTimeJob): Jobs can be run every x months on specific days of the month and at specific times.
Jobs can be run once at a specific time. These are non-recurring jobs. - [**One time**](https://pkg.go.dev/github.com/andoma-go/gocron/v2#OneTimeJob):
Jobs can be run once at a specific time. These are non-recurring jobs.
### Concurrency Limits ### Concurrency Limits
Jobs can be limited individually or across the entire scheduler. Jobs can be limited individually or across the entire scheduler.
- [**Per job limiting with singleton mode**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#WithSingletonMode):
Jobs can be limited to a single concurrent execution that either reschedules (skips overlapping executions) - [**Per job limiting with singleton mode**](https://pkg.go.dev/github.com/andoma-go/gocron/v2#WithSingletonMode):
or queues (waits for the previous execution to finish). Jobs can be limited to a single concurrent execution that either reschedules (skips overlapping executions)
- [**Per scheduler limiting with limit mode**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#WithLimitConcurrentJobs): or queues (waits for the previous execution to finish).
Jobs can be limited to a certain number of concurrent executions across the entire scheduler - [**Per scheduler limiting with limit mode**](https://pkg.go.dev/github.com/andoma-go/gocron/v2#WithLimitConcurrentJobs):
using either reschedule (skip when the limit is met) or queue (jobs are added to a queue to Jobs can be limited to a certain number of concurrent executions across the entire scheduler
wait for the limit to be available). using either reschedule (skip when the limit is met) or queue (jobs are added to a queue to
wait for the limit to be available).
- **Note:** A scheduler limit and a job limit can both be enabled. - **Note:** A scheduler limit and a job limit can both be enabled.
### Distributed instances of gocron ### Distributed instances of gocron
Multiple instances of gocron can be run. Multiple instances of gocron can be run.
- [**Elector**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#WithDistributedElector):
An elector can be used to elect a single instance of gocron to run as the primary with the - [**Elector**](https://pkg.go.dev/github.com/andoma-go/gocron/v2#WithDistributedElector):
other instances checking to see if a new leader needs to be elected. An elector can be used to elect a single instance of gocron to run as the primary with the
- Implementations: [go-co-op electors](https://github.com/go-co-op?q=-elector&type=all&language=&sort=) other instances checking to see if a new leader needs to be elected.
- [**Locker**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#WithDistributedLocker): - Implementations: [andoma-go electors](https://github.com/andoma-go?q=-elector&type=all&language=&sort=)
A locker can be used to lock each run of a job to a single instance of gocron. - [**Locker**](https://pkg.go.dev/github.com/andoma-go/gocron/v2#WithDistributedLocker):
- Implementations: [go-co-op lockers](https://github.com/go-co-op?q=-lock&type=all&language=&sort=) A locker can be used to lock each run of a job to a single instance of gocron.
- Implementations: [andoma-go lockers](https://github.com/andoma-go?q=-lock&type=all&language=&sort=)
### Events ### Events
Job events can trigger actions. Job events can trigger actions.
- [**Listeners**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#WithEventListeners):
Can be added to a job, with [event listeners](https://pkg.go.dev/github.com/go-co-op/gocron/v2#EventListener), - [**Listeners**](https://pkg.go.dev/github.com/andoma-go/gocron/v2#WithEventListeners):
or all jobs across the Can be added to a job, with [event listeners](https://pkg.go.dev/github.com/andoma-go/gocron/v2#EventListener),
[scheduler](https://pkg.go.dev/github.com/go-co-op/gocron/v2#WithGlobalJobOptions) or all jobs across the
to listen for job events and trigger actions. [scheduler](https://pkg.go.dev/github.com/andoma-go/gocron/v2#WithGlobalJobOptions)
to listen for job events and trigger actions.
### Options ### Options
Many job and scheduler options are available. Many job and scheduler options are available.
- [**Job options**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#JobOption):
Job options can be set when creating a job using `NewJob`. - [**Job options**](https://pkg.go.dev/github.com/andoma-go/gocron/v2#JobOption):
- [**Global job options**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#WithGlobalJobOptions): Job options can be set when creating a job using `NewJob`.
Global job options can be set when creating a scheduler using `NewScheduler` - [**Global job options**](https://pkg.go.dev/github.com/andoma-go/gocron/v2#WithGlobalJobOptions):
and the `WithGlobalJobOptions` option. Global job options can be set when creating a scheduler using `NewScheduler`
- [**Scheduler options**](https://pkg.go.dev/github.com/go-co-op/gocron/v2#SchedulerOption): and the `WithGlobalJobOptions` option.
Scheduler options can be set when creating a scheduler using `NewScheduler`. - [**Scheduler options**](https://pkg.go.dev/github.com/andoma-go/gocron/v2#SchedulerOption):
Scheduler options can be set when creating a scheduler using `NewScheduler`.
### Logging ### Logging
Logs can be enabled. Logs can be enabled.
- [Logger](https://pkg.go.dev/github.com/go-co-op/gocron/v2#Logger):
The Logger interface can be implemented with your desired logging library. - [Logger](https://pkg.go.dev/github.com/andoma-go/gocron/v2#Logger):
The provided NewLogger uses the standard library's log package. The Logger interface can be implemented with your desired logging library.
The provided NewLogger uses the standard library's log package.
### Testing ### Testing
The gocron library is set up to enable testing. The gocron library is set up to enable testing.
- Mocks are provided in [the mock package](mocks) using [gomock](https://github.com/uber-go/mock). - Mocks are provided in [the mock package](mocks) using [gomock](https://github.com/uber-go/mock).
- Time can be mocked by passing in a [FakeClock](https://pkg.go.dev/github.com/jonboulle/clockwork#FakeClock) - Time can be mocked by passing in a [FakeClock](https://pkg.go.dev/github.com/jonboulle/clockwork#FakeClock)
to [WithClock](https://pkg.go.dev/github.com/go-co-op/gocron/v2#WithClock) - to [WithClock](https://pkg.go.dev/github.com/andoma-go/gocron/v2#WithClock) -
see the [example on WithClock](https://pkg.go.dev/github.com/go-co-op/gocron/v2#example-WithClock). see the [example on WithClock](https://pkg.go.dev/github.com/andoma-go/gocron/v2#example-WithClock).
## Supporters ## Supporters
@@ -153,4 +166,4 @@ This project is supported by:
## Star History ## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=go-co-op/gocron&type=Date)](https://star-history.com/#go-co-op/gocron&Date) [![Star History Chart](https://api.star-history.com/svg?repos=andoma-go/gocron&type=Date)](https://star-history.com/#andoma-go/gocron&Date)
SECURITY.md
+1 -1
View File
@@ -10,6 +10,6 @@ The current plan is to maintain version 1 as long as possible incorporating any
## Reporting a Vulnerability ## Reporting a Vulnerability
Vulnerabilities can be reported by [opening an issue](https://github.com/go-co-op/gocron/issues/new/choose) or reaching out on Slack: [<img src="https://img.shields.io/badge/gophers-gocron-brightgreen?logo=slack">](https://gophers.slack.com/archives/CQ7T0T1FW) Vulnerabilities can be reported by [opening an issue](https://github.com/andoma-go/gocron/issues/new/choose) or reaching out on Slack: [<img src="https://img.shields.io/badge/gophers-gocron-brightgreen?logo=slack">](https://gophers.slack.com/archives/CQ7T0T1FW)
We will do our best to addrerss any vulnerabilities in an expeditious manner. We will do our best to addrerss any vulnerabilities in an expeditious manner.
example_test.go
+1 -1
View File
@@ -5,7 +5,7 @@ import (
"sync" "sync"
"time" "time"
. "github.com/go-co-op/gocron/v2" // nolint:revive . "github.com/andoma-go/gocron/v2" // nolint:revive
"github.com/google/uuid" "github.com/google/uuid"
"github.com/jonboulle/clockwork" "github.com/jonboulle/clockwork"
) )
go.mod
+1 -1
View File
@@ -1,4 +1,4 @@
module github.com/go-co-op/gocron/v2 module github.com/andoma-go/gocron/v2
go 1.20 go 1.20
mocks/README.md
+4 -3
View File
@@ -3,18 +3,19 @@
## Quick Start ## Quick Start
``` ```
go get github.com/go-co-op/gocronmocks/v2 go get github.com/andoma-go/gocronmocks/v2
``` ```
write a test write a test
```golang ```golang
package main package main
import ( import (
"testing" "testing"
"github.com/go-co-op/gocron/v2" "github.com/andoma-go/gocron/v2"
"github.com/go-co-op/gocronmocks/v2" "github.com/andoma-go/gocronmocks/v2"
"go.uber.org/mock/gomock" "go.uber.org/mock/gomock"
) )
mocks/distributed.go
+2 -2
View File
@@ -1,5 +1,5 @@
// Code generated by MockGen. DO NOT EDIT. // Code generated by MockGen. DO NOT EDIT.
// Source: github.com/go-co-op/gocron/v2 (interfaces: Elector,Locker,Lock) // Source: github.com/andoma-go/gocron/v2 (interfaces: Elector,Locker,Lock)
// //
// Generated by this command: // Generated by this command:
// //
@@ -12,7 +12,7 @@ import (
context "context" context "context"
reflect "reflect" reflect "reflect"
gocron "github.com/go-co-op/gocron/v2" gocron "github.com/andoma-go/gocron/v2"
gomock "go.uber.org/mock/gomock" gomock "go.uber.org/mock/gomock"
) )
mocks/go.mod
+2 -2
View File
@@ -1,9 +1,9 @@
module github.com/go-co-op/gocronmocks/v2 module github.com/andoma-go/gocronmocks/v2
go 1.20 go 1.20
require ( require (
github.com/go-co-op/gocron/v2 v2.0.0-rc4 github.com/andoma-go/gocron/v2 v2.0.0-rc4
github.com/golang/mock v1.6.0 github.com/golang/mock v1.6.0
github.com/google/uuid v1.4.0 github.com/google/uuid v1.4.0
go.uber.org/mock v0.3.0 go.uber.org/mock v0.3.0
mocks/go.sum
+2 -2
View File
@@ -1,6 +1,6 @@
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/go-co-op/gocron/v2 v2.0.0-rc4 h1:KFYg2CzyHZwPZL/uNnQKEyeL9oKEUQbiLThArcZaVmw= github.com/andoma-go/gocron/v2 v2.0.0-rc4 h1:KFYg2CzyHZwPZL/uNnQKEyeL9oKEUQbiLThArcZaVmw=
github.com/go-co-op/gocron/v2 v2.0.0-rc4/go.mod h1:3SLoqKnyORFVN0VvFFb1383hM4WD9XHBPn9aUUp7sQs= github.com/andoma-go/gocron/v2 v2.0.0-rc4/go.mod h1:3SLoqKnyORFVN0VvFFb1383hM4WD9XHBPn9aUUp7sQs=
github.com/golang/mock v1.6.0 h1:ErTB+efbowRARo13NNdxyJji2egdxLGQhRaY+DUumQc= github.com/golang/mock v1.6.0 h1:ErTB+efbowRARo13NNdxyJji2egdxLGQhRaY+DUumQc=
github.com/golang/mock v1.6.0/go.mod h1:p6yTPP+5HYm5mzsMV8JkE6ZKdX+/wYM6Hr+LicevLPs= github.com/golang/mock v1.6.0/go.mod h1:p6yTPP+5HYm5mzsMV8JkE6ZKdX+/wYM6Hr+LicevLPs=
github.com/google/uuid v1.4.0 h1:MtMxsa51/r9yyhkyLsVeVt0B+BGQZzpQiTQ4eHZ8bc4= github.com/google/uuid v1.4.0 h1:MtMxsa51/r9yyhkyLsVeVt0B+BGQZzpQiTQ4eHZ8bc4=
mocks/job.go
+1 -1
View File
@@ -1,5 +1,5 @@
// Code generated by MockGen. DO NOT EDIT. // Code generated by MockGen. DO NOT EDIT.
// Source: github.com/go-co-op/gocron/v2 (interfaces: Job) // Source: github.com/andoma-go/gocron/v2 (interfaces: Job)
// //
// Generated by this command: // Generated by this command:
// //
mocks/logger.go
+1 -1
View File
@@ -1,5 +1,5 @@
// Code generated by MockGen. DO NOT EDIT. // Code generated by MockGen. DO NOT EDIT.
// Source: github.com/go-co-op/gocron/v2 (interfaces: Logger) // Source: github.com/andoma-go/gocron/v2 (interfaces: Logger)
// //
// Generated by this command: // Generated by this command:
// //
mocks/scheduler.go
+2 -2
View File
@@ -1,5 +1,5 @@
// Code generated by MockGen. DO NOT EDIT. // Code generated by MockGen. DO NOT EDIT.
// Source: github.com/go-co-op/gocron/v2 (interfaces: Scheduler) // Source: github.com/andoma-go/gocron/v2 (interfaces: Scheduler)
// Package gocronmocks is a generated GoMock package. // Package gocronmocks is a generated GoMock package.
package gocronmocks package gocronmocks
@@ -7,7 +7,7 @@ package gocronmocks
import ( import (
reflect "reflect" reflect "reflect"
gocron "github.com/go-co-op/gocron/v2" gocron "github.com/andoma-go/gocron/v2"
gomock "github.com/golang/mock/gomock" gomock "github.com/golang/mock/gomock"
uuid "github.com/google/uuid" uuid "github.com/google/uuid"
) )