23 |
34 |
24 |
25 |
26 |
33 |
7 | {{ .Page.TableOfContents }}
8 |
9 |
10 | {{- else -}}
11 | {{ .Page.TableOfContents }}
12 | {{- end -}}
13 | {{- end -}}
14 |
--------------------------------------------------------------------------------
/benchmarks/sysbench/read-only.yaml:
--------------------------------------------------------------------------------
1 | # https://square.github.io/finch/benchmark/examples/#sysbench
2 |
3 | stage:
4 | name: read-only
5 | runtime: 60s
6 | workload:
7 | - clients: 1
8 | trx:
9 | - file: trx/read-only.sql
10 | data:
11 | id:
12 | generator: "int"
13 | params:
14 | max: $params.rows
15 | dist: normal
16 | id_100:
17 | generator: "int-range"
18 | params:
19 | range: 100
20 | max: $params.rows
21 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/posts/single.html:
--------------------------------------------------------------------------------
1 | {{ define "main" }}
2 | 9 |
{{ partial "utils/title" . }}
5 | 8 |
9 | {{- range split .Inner "<--->" }}
10 |
15 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/static/print-735ccc12.min.css:
--------------------------------------------------------------------------------
1 | @media print{.gdoc-nav,.gdoc-footer .container span:not(:first-child),.gdoc-paging,.editpage{display:none}.gdoc-footer{border-top:1px solid #dee2e6}.gdoc-markdown pre{white-space:pre-wrap;overflow-wrap:break-word}.chroma code{border:1px solid #dee2e6;padding:.5rem !important;font-weight:normal !important}.gdoc-markdown code{font-weight:bold}a,a:visited{color:inherit !important;text-decoration:none !important}.gdoc-toc{flex:none}.gdoc-toc nav{position:relative;width:auto}.wrapper{display:block}.wrapper main{display:block}}
2 |
--------------------------------------------------------------------------------
/go.mod:
--------------------------------------------------------------------------------
1 | module github.com/square/finch
2 |
3 | go 1.20
4 |
5 | require (
6 | github.com/alexflint/go-arg v1.4.3
7 | github.com/dustin/go-humanize v1.0.0
8 | github.com/go-ini/ini v1.67.0
9 | github.com/go-mysql/errors v0.0.0-20180603193453-03314bea68e0
10 | github.com/go-sql-driver/mysql v1.7.1
11 | github.com/go-test/deep v1.0.8
12 | github.com/rs/xid v1.4.0
13 | golang.org/x/time v0.3.0
14 | gopkg.in/yaml.v2 v2.4.0
15 | )
16 |
17 | require (
18 | github.com/alexflint/go-scalar v1.1.0 // indirect
19 | github.com/stretchr/testify v1.8.0 // indirect
20 | )
21 |
--------------------------------------------------------------------------------
/docs/static/custom.css:
--------------------------------------------------------------------------------
1 | html {scroll-behavior: auto;} /* No animated scrolling on link click */
2 | code {overflow-x: scroll;} /* Horizontal scrolling for long code blocks */
3 |
4 | :root,
5 | :root[color-theme="light"],
6 | :root[color-theme="dark"]
7 | {
8 | --mark-color: lightyellow;
9 | }
10 |
11 | .tagline {
12 | font-style: italic;
13 | }
14 |
15 | table.compact.params {
16 | width: auto !important;
17 | }
18 |
19 | .gdoc-markdown h3 > code {
20 | border: none !important;
21 | background-color: unset !important;
22 | font-size: 0.9em !important;
23 | }
24 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/assets/search/config.json:
--------------------------------------------------------------------------------
1 | {{- $searchDataFile := printf "search/%s.data.json" .Language.Lang -}}
2 | {{- $searchData := resources.Get "search/data.json" | resources.ExecuteAsTemplate $searchDataFile . | resources.Minify -}}
3 | {
4 | "dataFile": {{ $searchData.RelPermalink | jsonify }},
5 | "indexConfig": {{ .Site.Params.GeekdocSearchConfig | jsonify }},
6 | "showParent": {{ if .Site.Params.GeekdocSearchShowParent }}true{{ else }}false{{ end }},
7 | "showDescription": {{ if .Site.Params.GeekdocSearchshowDescription }}true{{ else }}false{{ end }}
8 | }
9 |
--------------------------------------------------------------------------------
/test/mock/stats_reporter.go:
--------------------------------------------------------------------------------
1 | package mock
2 |
3 | import (
4 | "github.com/square/finch/stats"
5 | )
6 |
7 | type StatsReporter struct {
8 | ReportFunc func([]stats.Instance)
9 | StopFunc func()
10 | }
11 |
12 | func (r StatsReporter) Make(name string, opts map[string]string) (stats.Reporter, error) {
13 | return r, nil
14 | }
15 |
16 | func (r StatsReporter) Report(from []stats.Instance) {
17 | if r.ReportFunc != nil {
18 | r.ReportFunc(from)
19 | }
20 | }
21 |
22 | func (r StatsReporter) Stop() {
23 | if r.StopFunc != nil {
24 | r.StopFunc()
25 | }
26 | }
27 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/shortcodes/expand.html:
--------------------------------------------------------------------------------
1 | {{ $id := substr (sha1 .Inner) 0 8 }}
2 |
12 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/assets/search/data.json:
--------------------------------------------------------------------------------
1 | [
2 | {{ range $index, $page := (where .Site.Pages "Params.GeekdocProtected" "ne" true) }}
3 | {{ if ne $index 0 }},{{ end }}
4 | {
5 | "id": {{ $index }},
6 | "href": "{{ $page.RelPermalink }}",
7 | "title": {{ (partial "utils/title" $page) | jsonify }},
8 | "parent": {{ with $page.Parent }}{{ (partial "utils/title" .) | jsonify }}{{ else }}""{{ end }},
9 | "content": {{ $page.Plain | jsonify }},
10 | "description": {{ $page.Summary | plainify | jsonify }}
11 | }
12 | {{ end }}
13 | ]
14 |
--------------------------------------------------------------------------------
/benchmarks/aurora/setup.yaml:
--------------------------------------------------------------------------------
1 | # https://square.github.io/finch/benchmark/examples/#aurora
2 |
3 | stage:
4 | name: setup
5 | trx:
6 | - file: trx/create-tables.sql
7 | - file: trx/insert-rows.sql
8 | data:
9 | k:
10 | generator: "int"
11 | params:
12 | max: 65536
13 | c:
14 | generator: "str-fill-az"
15 | params:
16 | len: 119 # not a typo
17 | pad:
18 | generator: "str-fill-az"
19 | params:
20 | len: 59 # not a typo
21 | - file: trx/analyze-tables.sql
22 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/static/js/926-40cc1be5.chunk.min.js.LICENSE.txt:
--------------------------------------------------------------------------------
1 | /*!
2 | Embeddable Minimum Strictly-Compliant Promises/A+ 1.1.1 Thenable
3 | Copyright (c) 2013-2014 Ralf S. Engelschall (http://engelschall.com)
4 | Licensed under The MIT License (http://opensource.org/licenses/MIT)
5 | */
6 |
7 | /*! Bezier curve function generator. Copyright Gaetan Renaudeau. MIT License: http://en.wikipedia.org/wiki/MIT_License */
8 |
9 | /*! Runge-Kutta spring physics function generator. Adapted from Framer.js, copyright Koen Bok. MIT License: http://en.wikipedia.org/wiki/MIT_License */
10 |
--------------------------------------------------------------------------------
/test/run/columns/setup.sql:
--------------------------------------------------------------------------------
1 | CREATE DATABASE IF NOT EXISTS finch;
2 |
3 | USE finch;
4 |
5 | DROP TABLE IF EXISTS coltest1, coltest2, coltest3;
6 |
7 | CREATE TABLE coltest1 (
8 | a int unsigned not null auto_increment primary key,
9 | b int not null default 0
10 | );
11 |
12 | CREATE TABLE coltest2 (
13 | x int unsigned not null default 0,
14 | y varchar(10) not null default "",
15 | z int not null default 0,
16 | primary key (x)
17 | );
18 |
19 | CREATE TABLE coltest3 (
20 | x int unsigned not null default 0,
21 | y varchar(10) not null default "",
22 | primary key (x)
23 | );
24 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/partials/head/meta.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | {{ hugo.Generator }}
6 |
7 | {{ $keywords := default .Site.Params.Keywords .Keywords }}
8 |
9 | {{- with partial "utils/description" . }}
10 |
11 | {{- end }}
12 | {{- with $keywords }}
13 |
14 | {{- end }}
15 |
--------------------------------------------------------------------------------
/benchmarks/jcole-bug-97001/after.yaml:
--------------------------------------------------------------------------------
1 | # https://bugs.mysql.com/bug.php?id=97001
2 | # https://blog.jcole.us/2019/09/30/reconsidering-access-paths-for-index-ordering-a-dangerous-optimization-and-a-fix/
3 | # https://hackmysql.com/post/infamous-order-by-limit-query-optimizer-bug/
4 |
5 | stage:
6 | trx:
7 | - file: shift-rows.sql # UPDATE t SET id=id+1000000 WHERE other_id = 555
8 | - file: get-1-row.sql
9 | workload:
10 | - group: shift
11 | trx: [shift-rows.sql]
12 | iter: 1
13 | disable-stats: true
14 |
15 | - group: after
16 | trx: [get-1-row.sql]
17 | iter: 2
18 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/partials/microformats/twitter_cards.html:
--------------------------------------------------------------------------------
1 | {{- with partial "utils/featured" . }}
2 |
3 | {{- else }}
4 |
5 | {{- end }}
6 |
7 | {{- with partial "utils/featured" . }}
8 |
9 | {{- end }}
10 | {{- with partial "utils/description" . }}
11 |
12 | {{- end }}
13 |
--------------------------------------------------------------------------------
/benchmarks/jcole-bug-97001/setup.yaml:
--------------------------------------------------------------------------------
1 | # https://bugs.mysql.com/bug.php?id=97001
2 | # https://blog.jcole.us/2019/09/30/reconsidering-access-paths-for-index-ordering-a-dangerous-optimization-and-a-fix/
3 | # https://hackmysql.com/post/infamous-order-by-limit-query-optimizer-bug/
4 |
5 | stage:
6 | trx:
7 | - file: schema.sql
8 | - file: insert-rows.sql
9 | data:
10 | n:
11 | generator: auto-inc
12 | scope: client-group
13 | workload:
14 | - trx: [schema.sql]
15 | - trx: [insert-rows.sql] # 5k rows/insert
16 | iter-clients: 200 # x 200 inserts = 1,000,000 rows
17 | clients: 4
18 |
--------------------------------------------------------------------------------
/benchmarks/sysbench/setup.yaml:
--------------------------------------------------------------------------------
1 | # https://square.github.io/finch/benchmark/examples/#sysbench
2 |
3 | stage:
4 | name: "setup"
5 | stats:
6 | disable: true
7 | trx:
8 | # Executed in order:
9 | - file: trx/schema.sql
10 | - file: trx/insert-rows.sql
11 | data:
12 | k:
13 | generator: "int"
14 | params:
15 | max: 65536
16 | c:
17 | generator: "str-fill-az"
18 | params:
19 | len: 119 # not a typo
20 | pad:
21 | generator: "str-fill-az"
22 | params:
23 | len: 59 # not a typo
24 | - file: trx/secondary-index.sql
25 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/shortcodes/hint.html:
--------------------------------------------------------------------------------
1 | {{ $type := default "note" (.Get "type") }}
2 | {{ $icon := .Get "icon" }}
3 | {{ $title := default ($type | title) (.Get "title") }}
4 |
5 |
6 |
11 | {{ . | $.Page.RenderString -}}
12 |
13 | {{- end }}
14 | 7 |17 | -------------------------------------------------------------------------------- /docs/themes/hugo-geekdoc/layouts/shortcodes/include.html: -------------------------------------------------------------------------------- 1 | {{ $file := .Get "file" }} 2 | {{ $page := .Site.GetPage $file }} 3 | {{ $type := .Get "type" }} 4 | {{ $language := .Get "language" }} 5 | {{ $options :=.Get "options" }} 6 | 7 | 8 |8 | {{- with $icon -}} 9 | 10 | {{ $title }} 11 | {{- else -}} 12 | 13 | {{- end -}} 14 |15 |{{ .Inner | $.Page.RenderString }}16 |
9 | {{- if (.Get "language") -}}
10 | {{- highlight ($file | readFile) $language (default "linenos=table" $options) -}}
11 | {{- else if eq $type "html" -}}
12 | {{- $file | readFile | safeHTML -}}
13 | {{- else if eq $type "page" -}}
14 | {{- with $page }}{{ .Content }}{{ end -}}
15 | {{- else -}}
16 | {{- $file | readFile | $.Page.RenderString -}}
17 | {{- end -}}
18 |
19 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/partials/search.html:
--------------------------------------------------------------------------------
1 | {{ if default true .Site.Params.GeekdocSearch }}
2 |
3 |
4 |
14 |
16 | {{ end }}
17 |
--------------------------------------------------------------------------------
/docs/config.toml:
--------------------------------------------------------------------------------
1 | baseURL = "/finch"
2 | title = "Finch Docs"
3 | theme = "hugo-geekdoc"
4 | languageCode = 'en-us'
5 |
6 | pluralizeListTitles = false
7 |
8 | # Geekdoc required configuration
9 | pygmentsUseClasses = true
10 | pygmentsCodeFences = true
11 | disablePathToLower = true
12 |
13 | # Required if you want to render robots.txt template
14 | enableRobotsTXT = true
15 |
16 | # Needed for mermaid shortcodes
17 | [markup]
18 | [markup.goldmark.renderer]
19 | # Needed for mermaid shortcode
20 | unsafe = true
21 | [markup.tableOfContents]
22 | startLevel = 1
23 | endLevel = 9
24 | [markup.goldmark.parser.attribute]
25 | block = true
26 |
27 | [taxonomies]
28 | tag = "tags"
29 |
--------------------------------------------------------------------------------
/docs/content/api/data.md:
--------------------------------------------------------------------------------
1 | ---
2 | ---
3 |
4 | Implement `data.Generator`:
5 |
6 | ```go
7 | type Generator interface {
8 | Format() (uint, string)
9 | Copy() Generator
10 | Values(RunCount) []interface{}
11 | Scan(any interface{}) error
12 | Name() string
13 | }
14 | ```
15 |
16 | Your generator does _not_ have to handle data scope.
17 | When it's called, Finch expects new values.
18 |
19 | Implement `data.Factory` to create your data generator:
20 |
21 | ```go
22 | type Factory interface {
23 | Make(name, dataKey string, params map[string]string) (Generator, error)
24 | }
25 | ```
26 |
27 | Register your data generator and its factory by calling `data.Register(name string, f Factory) error`.
28 |
--------------------------------------------------------------------------------
/test/run/scope/workload_cg_alloc.yaml:
--------------------------------------------------------------------------------
1 | stage:
2 | name: test
3 | trx:
4 | - file: 001.sql
5 | data:
6 | a:
7 | scope: statement
8 | generator: auto-inc
9 | r:
10 | scope: statement
11 | generator: int
12 | params:
13 | dist: uniform
14 | max: 1,000,000
15 | clientid:
16 | scope: statement
17 | generator: client-id
18 | params:
19 | ids: exec-group,client-group,client,iter,trx,statement
20 | workload:
21 | # ###### Exec group __A__ #####
22 | - clients: 2 # Client group 1
23 | group: __A__ #
24 |
25 | - clients: 2 # Client group 2
26 | group: __A__ #
27 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/shortcodes/tabs.html:
--------------------------------------------------------------------------------
1 | {{- if .Inner }}{{ end }}
2 | {{- $id := .Get 0 }}
3 | {{- $group := printf "tabs-%s" $id }}
4 |
5 |
6 |
7 | {{- range $index, $tab := .Scratch.Get $group }}
8 |
15 |
18 |
23 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/shortcodes/katex.html:
--------------------------------------------------------------------------------
1 |
2 | {{ if not (.Page.Scratch.Get "katex") }}
3 |
4 |
8 |
9 | {{ .Page.Scratch.Set "katex" true }}
10 | {{ end }}
11 |
12 |
13 |
14 | {{ cond (in .Params "display") "\\[" "\\(" -}}
15 | {{- trim .Inner "\n" -}}
16 | {{- cond (in .Params "display") "\\]" "\\)" -}}
17 |
18 | {{- /* Drop trailing newlines */ -}}
19 |
--------------------------------------------------------------------------------
/limit/data_test.go:
--------------------------------------------------------------------------------
1 | package limit_test
2 |
3 | import (
4 | "testing"
5 |
6 | "github.com/square/finch/limit"
7 | )
8 |
9 | func TestOr(t *testing.T) {
10 | r1 := limit.NewRows(100, 0)
11 | r2 := limit.NewRows(50, 0)
12 |
13 | dl := limit.Or(r1, r2)
14 |
15 | // We can pass nil for the *sql.DB because Rows doesn't use it for More
16 | if dl.More(nil) == false {
17 | t.Error("More false, expected true before anything called")
18 | }
19 |
20 | r1.Affected(1) // 1/100
21 | r2.Affected(1) // 1/50
22 | if dl.More(nil) != true {
23 | t.Error("More false, expected true before either limit reached")
24 | }
25 |
26 | r2.Affected(49) // 50/50
27 | if dl.More(nil) != false {
28 | t.Error("More true, expected false when one limit reached")
29 | }
30 | }
31 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/shortcodes/button.html:
--------------------------------------------------------------------------------
1 | {{- $ref := "" }}
2 | {{- $class := "" }}
3 | {{- $size := default "regular" (.Get "size" | lower) }}
4 |
5 | {{- if not (in (slice "regular" "large") $size) }}
6 | {{- $size = "regular" }}
7 | {{- end }}
8 |
9 | {{- with .Get "href" }}
10 | {{- $ref = . }}
11 | {{- end }}
12 |
13 | {{- with .Get "relref" }}
14 | {{- $ref = relref $ . }}
15 | {{- end }}
16 |
17 | {{- with .Get "class" }}
18 | {{- $class = . }}
19 | {{- end }}
20 |
21 |
22 |
30 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/shortcodes/progress.html:
--------------------------------------------------------------------------------
1 | {{- $value := default 0 (.Get "value") -}}
2 | {{- $title := .Get "title" -}}
3 | {{- $icon := .Get "icon" -}}
4 |
5 |
6 |
19 | {{ .Content | $.Page.RenderString }}
20 |
21 | {{- end }}
22 |
7 |
24 |
--------------------------------------------------------------------------------
/data/string_test.go:
--------------------------------------------------------------------------------
1 | // Copyright 2024 Block, Inc.
2 |
3 | package data_test
4 |
5 | import (
6 | "strconv"
7 | "testing"
8 |
9 | "github.com/square/finch/data"
10 | )
11 |
12 | func TestString_StrFillAz(t *testing.T) {
13 | lens := []string{"1", "10", "100", "1000", "10000", "100000", "1000000"}
14 | for _, strlen := range lens {
15 | g, _ := data.NewStrFillAz(
16 | map[string]string{
17 | "len": strlen,
18 | },
19 | )
20 |
21 | r := data.RunCount{}
22 |
23 | v1 := g.Values(r)
24 | if len(v1) != 1 {
25 | t.Fatalf("len=%s: got %d values, expected 1: %v", strlen, len(v1), v1)
26 | }
27 | s1 := v1[0].(string)
28 | n, _ := strconv.Atoi(strlen)
29 | if len(s1) != n {
30 | t.Errorf("len=%s: got len %d, expected %s: %s", strlen, len(s1), strlen, s1)
31 | }
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/test/run/scope/statement.yaml:
--------------------------------------------------------------------------------
1 | stage:
2 | name: test
3 | trx:
4 | - file: 001.sql
5 | data:
6 | a:
7 | scope: statement
8 | generator: auto-inc
9 | r:
10 | scope: statement
11 | generator: int
12 | params:
13 | dist: uniform
14 | max: 1,000,000
15 | clientid:
16 | scope: statement
17 | generator: client-id
18 | params:
19 | ids: exec-group,client-group,client,iter,trx,statement
20 | - file: 002.sql
21 | # Same data keys as 001.sql
22 | workload:
23 | # ###### Exec group __A__ #####
24 | - group: __A__
25 | clients: 1
26 | iter: 2
27 | - group: __A__
28 | clients: 1
29 | iter: 1
30 | - group: __B__
31 | clients: 1
32 | iter: 1
33 |
--------------------------------------------------------------------------------
/benchmarks/sysbench/write-only.yaml:
--------------------------------------------------------------------------------
1 | # https://square.github.io/finch/benchmark/examples/#sysbench
2 |
3 | stage:
4 | name: write-only
5 | runtime: 60s
6 | workload:
7 | - clients: 1
8 | trx:
9 | - file: trx/write-only.sql
10 | data:
11 | id:
12 | generator: "int"
13 | params:
14 | max: $params.rows
15 | dist: normal
16 | del_id:
17 | generator: "int"
18 | scope: trx
19 | params:
20 | max: $params.rows
21 | dist: normal
22 | k:
23 | generator: "int"
24 | params:
25 | max: 65536
26 | c:
27 | generator: "str-fill-az"
28 | params:
29 | len: 119
30 | pad:
31 | generator: "str-fill-az"
32 | params:
33 | len: 59
34 |
--------------------------------------------------------------------------------
/compute/server_test.go:
--------------------------------------------------------------------------------
1 | package compute_test
2 |
3 | import (
4 | "context"
5 | "os"
6 | "testing"
7 |
8 | "github.com/square/finch/compute"
9 | "github.com/square/finch/config"
10 | "github.com/square/finch/test"
11 | )
12 |
13 | func TestServer_Run1Stage(t *testing.T) {
14 | if test.Build {
15 | t.Skip("GitHub Actions build")
16 | }
17 |
18 | dsn, db, err := test.Connection()
19 | if err != nil {
20 | t.Fatal(err)
21 | }
22 | defer db.Close()
23 |
24 | os.Setenv("PORT", test.MySQLPort)
25 | stages, err := config.Load(
26 | []string{"../test/run/select-1/test.yaml"},
27 | []string{},
28 | dsn,
29 | "", // default db
30 | )
31 | if err != nil {
32 | t.Fatal(err)
33 | }
34 |
35 | s := compute.NewServer("local", "", false)
36 |
37 | err = s.Run(context.Background(), stages)
38 | if err != nil {
39 | t.Error(err)
40 | }
41 | }
42 |
--------------------------------------------------------------------------------
/test/run/scope/client.yaml:
--------------------------------------------------------------------------------
1 | stage:
2 | name: test
3 | trx:
4 | - file: 001.sql
5 | data:
6 | a:
7 | scope: client #########
8 | generator: auto-inc #
9 | r: #
10 | scope: client #########
11 | generator: int
12 | params:
13 | dist: uniform
14 | max: 1,000,000
15 | clientid:
16 | scope: statement
17 | generator: client-id
18 | params:
19 | ids: exec-group,client-group,client,iter,trx,statement
20 | - file: 002.sql
21 | # Same data keys as 001.sql
22 | workload:
23 | # ###### Exec group __A__ #####
24 | - group: __A__
25 | clients: 1
26 | iter: 2
27 | - group: __A__
28 | clients: 1
29 | iter: 1
30 | - group: __B__
31 | clients: 1
32 | iter: 1
33 |
--------------------------------------------------------------------------------
/test/run/scope/iter.yaml:
--------------------------------------------------------------------------------
1 | stage:
2 | name: test
3 | trx:
4 | - file: 001.sql
5 | data:
6 | a:
7 | scope: iter ###########
8 | generator: auto-inc #
9 | r: #
10 | scope: iter ###########
11 | generator: int
12 | params:
13 | dist: uniform
14 | max: 1,000,000
15 | clientid:
16 | scope: statement
17 | generator: client-id
18 | params:
19 | ids: exec-group,client-group,client,iter,trx,statement
20 | - file: 002.sql
21 | # Same data keys as 001.sql
22 | workload:
23 | # ###### Exec group __A__ #####
24 | - group: __A__
25 | clients: 1
26 | iter: 2
27 | - group: __A__
28 | clients: 1
29 | iter: 1
30 | - group: __B__
31 | clients: 1
32 | iter: 1
33 |
--------------------------------------------------------------------------------
/test/run/scope/trx.yaml:
--------------------------------------------------------------------------------
1 | stage:
2 | name: test
3 | trx:
4 | - file: 001.sql
5 | data:
6 | a:
7 | scope: trx ############
8 | generator: auto-inc #
9 | r: #
10 | scope: trx ############
11 | generator: int
12 | params:
13 | dist: uniform
14 | max: 1,000,000
15 | clientid:
16 | scope: statement
17 | generator: client-id
18 | params:
19 | ids: exec-group,client-group,client,iter,trx,statement
20 | - file: 002.sql
21 | # Same data keys as 001.sql
22 | workload:
23 | # ###### Exec group __A__ #####
24 | - group: __A__
25 | clients: 1
26 | iter: 2
27 | - group: __A__
28 | clients: 1
29 | iter: 1
30 | - group: __B__
31 | clients: 1
32 | iter: 1
33 |
--------------------------------------------------------------------------------
/docs/content/syntax/values.md:
--------------------------------------------------------------------------------
1 | ---
2 | weight: 4
3 | title: Values
4 | ---
5 |
6 | ## String-int
7 |
8 | In Finch [stage]({{< relref "syntax/stage-file" >}}) and [\_all.yaml]({{< relref "syntax/all-file" >}}) files, most numerical values are YAML strings.
9 |
10 | |String Value|Numerical Value|
11 | |------------|---------------|
12 | |""|0 or default value|
13 | |"1"|1|
14 | |"1,000"|1000|
15 | |"1k"|1000|
16 | |"1KB"|1000|
17 | |"1KiB"|1024|
18 | |"$params.foo"|5 when `params.foo = "5"`|
19 |
20 | ## Time Duration
21 |
22 | Time durations (usually a configuration or parameter called `freq`) are [Go time duration](https://pkg.go.dev/time#ParseDuration) strings:
23 |
24 | >Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
25 |
26 | ## String-bool
27 |
28 | These strings evaluate to boolean true:
29 |
30 | * "true"
31 | * "yes"
32 | * "on"
33 | * "aye"
34 |
35 | All other strings, including empty strings, evaluate to boolean false.
36 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/partials/pagination.html:
--------------------------------------------------------------------------------
1 | {{ $pag := $.Paginator }}
2 |
3 |
4 |
23 |
--------------------------------------------------------------------------------
/docs/content/benchmark/error-handling.md:
--------------------------------------------------------------------------------
1 | ---
2 | weight: 6
3 | ---
4 |
5 | Finch handles these MySQL errors _without_ reconnecting:
6 |
7 | |Error|MySQL Error Code|Handling|
8 | |-----|----------------|--------|
9 | |Deadlock|1213|MySQL automatically rolls back|
10 | |Lock wait timeout|1205|Execute `ROLLBACK` because `innodb_rollback_on_timeout=OFF` by default|
11 | |Query killed|1317||
12 | |Read-only|1290, 1836||
13 | |Duplicate key|1062||
14 |
15 | After handling the errors above, Finch starts a new iteration from the first [assigned trx]({{< relref "benchmark/workload#trx" >}}).
16 |
17 | Other errors cause Finch to disconnect and reconnect to MySQL, then start a new iteration.
18 | Reconnect time is not directly measured or recorded, but if it's severe it will reduce reported throughput because Finch will spend time reconnecting rather than executing queries.
19 |
20 | Query [statistics]({{< relref "benchmark/statistics" >}}) are recorded when the query returns an error.
21 | This is usually correct because, for example, a lock wait timeout is part of query response time.
22 | However, for errors that cause a fast error-retry-error loop, it will skew statistics towards zero or artificially high values.
23 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2022 Robert Kaussow
8 |
16 |
9 | {{ with $icon -}}
10 |
11 | {{- end }}
12 | {{ with $title }}{{ . }}{{ end }}
13 |
14 | {{ $value }}%
15 |
17 |
22 |
23 |
7 |
11 | {{ .Text | safeHTML }}
12 |
13 |
14 |
15 |
16 |
17 | {{- else -}}
18 |
19 |
23 | {{ .Text | safeHTML }}
24 |
25 |
26 | {{- end -}}
27 |
28 |
--------------------------------------------------------------------------------
/test/mysql.go:
--------------------------------------------------------------------------------
1 | package test
2 |
3 | import (
4 | "context"
5 | "database/sql"
6 | "fmt"
7 | "os"
8 | )
9 |
10 | // Build is true when running in GitHub Actions. When true, database tests are
11 | // skipped because currently we don't run MySQL in GitHub Acitons, but other tests
12 | // and the Go build still run.
13 | var Build = os.Getenv("GITHUB_ACTION") != ""
14 |
15 | var MySQLPort = "33800" // test/docker/docker-compose.yaml
16 |
17 | func Connection() (string, *sql.DB, error) {
18 | dsn := fmt.Sprintf(
19 | "%s:%s@tcp(%s:%s)/?parseTime=true",
20 | "root",
21 | "test",
22 | "127.0.0.1",
23 | MySQLPort,
24 | )
25 | db, err := sql.Open("mysql", dsn)
26 | if err != nil {
27 | return "", nil, err
28 | }
29 | if err := db.Ping(); err != nil {
30 | db.Close()
31 | return "", nil, err
32 | }
33 | return dsn, db, nil
34 | }
35 |
36 | func OneRow(db *sql.DB, query string) (string, error) {
37 | var s string
38 | err := db.QueryRowContext(context.Background(), query).Scan(&s)
39 | return s, err
40 | }
41 |
42 | func Exec(db *sql.DB, queries []string) error {
43 | for _, q := range queries {
44 | if _, err := db.Exec(q); err != nil {
45 | return fmt.Errorf("%s: %s", q, err)
46 | }
47 | }
48 | return nil
49 | }
50 |
--------------------------------------------------------------------------------
/docs/content/intro/tldr.md:
--------------------------------------------------------------------------------
1 | ---
2 | weight: 3
3 | title: "TL;DR"
4 | ---
5 |
6 | * Finch benchmarks MySQL; other databases are not currently supported.
7 | * Benchmarks are written in SQL; write your queries in a `.sql` file.
8 | * Each SQL file is a [Finch trx]({{< relref "syntax/trx-file" >}})—"trx" for short.
9 | * Trx should [model]({{< relref "benchmark/trx" >}}) real MySQL transactions, but they don't have to.
10 | * In SQL statements, [data keys]({{< relref "data/keys" >}}) like @d inject fake/random/test data.
11 | * Data keys are configured in [stage files]({{< relref "syntax/stage-file" >}}) to use a [data generator]({{< relref "data/generators" >}}).
12 | * Data generators are plugins that generate data (e.g. random numbers).
13 | * At least one stage file is required to configure and run Finch.
14 | * A benchmark comprises one or more stages (defined by stage files).
15 | * After writing SQL files with data keys, write a stage file to configure and execute.
16 | * [Statistics]({{< relref "benchmark/statistics" >}}) are reported once at the end by default; periodic stats can be enabled.
17 | * Stats reporters are plugins, so you can report stats any way, any where.
18 | * Look in `benchmarks/sysbench/` for a complete and familiar example.
19 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/_default/terms.html:
--------------------------------------------------------------------------------
1 | {{ define "main" }}
2 | {{ range .Paginator.Pages.ByTitle }}
3 | 6 | {{ partial "utils/title" . }} 7 |
8 |
16 |
17 |
18 | {{ partial "site-header" (dict "Root" . "MenuEnabled" false) }}
19 |
20 |
21 |
22 |
35 |
36 | {{ partial "site-footer" . }}
37 |
38 |
39 |
40 |
41 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/i18n/zh-cn.yaml:
--------------------------------------------------------------------------------
1 | ---
2 | edit_page: 编辑页面
3 |
4 | nav_navigation: 导航
5 | nav_tags: 标签
6 | nav_more: 更多
7 | nav_top: 回到顶部
8 |
9 | form_placeholder_search: 搜索
10 |
11 | error_page_title: 迷路了？ 不用担心
12 | error_message_title: 迷路了？
13 | error_message_code: 错误 404
14 | error_message_text: >
15 | 好像找不到你要找的东西。 别担心，我们可以
16 | 带您回到主页。
17 |
18 | button_toggle_dark: 切换暗/亮/自动模式
19 | button_nav_open: 打开导航
20 | button_nav_close: 关闭导航
21 | button_menu_open: 打开菜单栏
22 | button_menu_close: 关闭菜单栏
23 | button_homepage: 返回首页
24 |
25 | title_anchor_prefix: "锚定到："
26 |
27 | posts_read_more: 阅读全文
28 | posts_read_time:
29 | one: "一分钟阅读时间"
30 | other: "{{ . }} 分钟阅读时间"
31 | posts_update_prefix: 更新时间
32 | posts_count:
33 | one: 一篇文章
34 | other: "{{ . }} 个帖子"
35 | posts_tagged_with: 所有带有“{{ . }}”标签的帖子。
36 |
37 | footer_build_with: >
38 | 基于 Hugo
39 | 制作
40 | footer_legal_notice: "法律声明"
41 | footer_privacy_policy: "隐私政策"
42 | footer_content_license_prefix: >
43 | 内容许可证
44 |
45 | language_switch_no_tranlation_prefix: "页面未翻译："
46 |
47 | propertylist_required: 需要
48 | propertylist_optional: 可选
49 | propertylist_default: 默认值
50 |
51 | pagination_page_prev: 以前
52 | pagination_page_next: 下一个
53 | pagination_page_state: "{{ .PageNumber }}/{{ .TotalPages }}"
54 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/partials/menu-extra.html:
--------------------------------------------------------------------------------
1 | {{ $current := .current }}
2 | {{ template "menu-extra" dict "sect" .source "current" $current "site" $current.Site "target" .target }}
3 |
4 |
5 |
6 | {{ define "menu-extra" }}
7 | {{ $current := .current }}
8 | {{ $site := .site }}
9 | {{ $target := .target }}
10 | {{ $sect := .sect }}
11 |
12 | {{ range sort (default (seq 0) $sect) "weight" }}
13 | {{ if isset . "ref" }}
14 | {{ $this := $site.GetPage .ref }}
15 | {{ $isCurrent := eq $current $this }}
16 | {{ $icon := default false .icon }}
17 |
18 | {{ $name := .name }}
19 | {{ if reflect.IsMap .name }}
20 | {{ $name = (index .name $site.Language.Lang) }}
21 | {{ end }}
22 |
23 | {{ if not .icon }}
24 | {{ errorf "Missing 'icon' attribute in data file for '%s' menu item '%s'" $target $name }}
25 | {{ end }}
26 |
27 | {{ if eq $target "header" }}
28 |
29 |
37 |
41 |
42 |
43 | {{ end }}
44 | {{ end }}
45 | {{ end }}
46 | {{ end }}
47 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/posts/list.html:
--------------------------------------------------------------------------------
1 | {{ define "main" }}
2 | {{ range .Paginator.Pages }}
3 | 6 | {{ partial "utils/title" . }} 7 |
8 |
13 | {{ if .Truncated }}
14 |
19 | {{ i18n "posts_read_more" }}
20 | gdoc_arrow_right_alt
21 |
22 | {{ end }}
23 |
24 |
25 |
30 | 6 | {{ partial "utils/title" . }} 7 |
8 |
15 | {{ if .Truncated }}
16 |
21 | {{ i18n "posts_read_more" }}
22 | gdoc_arrow_right_alt
23 |
24 | {{ end }}
25 |
26 |
27 |
32 |
5 | {{ template "toc-tree" dict "sect" .Page.Pages }}
6 |
7 | {{- end }}
8 |
9 |
10 |
11 | {{- define "toc-tree" }}
12 | -
13 | {{- range .sect.GroupBy "Weight" }}
14 | {{- range .ByTitle }}
15 | {{- if or (not .Params.GeekdocHidden) (not (default true .Params.GeekdocHiddenTocTree)) }}
16 |
- 17 | {{- if or .Content .Params.GeekdocFlatSection }} 18 | 19 | 20 | {{- partial "utils/title" . }}{{ with .Params.GeekdocDescription }}:{{ end }} 21 | 22 | {{- with .Params.GeekdocDescription }}{{ . }}{{ end }} 23 | 24 | {{- else -}} 25 | 26 | {{- partial "utils/title" . }}{{ with .Params.GeekdocDescription }}: {{ . }}{{ end }} 27 | 28 | {{- end -}} 29 | 30 | {{- $numberOfPages := (add (len .Pages) (len .Sections)) }} 31 | {{- if and (ne $numberOfPages 0) (not .Params.GeekdocFlatSection) }} 32 | {{- template "toc-tree" dict "sect" .Pages }} 33 | {{- end }} 34 | 35 | {{- end }} 36 | {{- end }} 37 | {{- end }} 38 |
31 |
32 |
33 | {{ $navEnabled := default true .Page.Params.GeekdocNav }}
34 | {{ partial "site-header" (dict "Root" . "MenuEnabled" $navEnabled) }}
35 |
36 |
37 |
38 | {{ if $navEnabled }}
39 |
42 | {{ end }}
43 |
44 |
45 |
54 |
55 | {{ partial "site-footer" . }}
56 |
57 |
58 | {{ partial "foot" . }}
59 |
60 |
61 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/i18n/it.yaml:
--------------------------------------------------------------------------------
1 | ---
2 | edit_page: Modifica la pagina
3 |
4 | nav_navigation: Navigazione
5 | nav_tags: Etichette
6 | nav_more: Altro
7 | nav_top: Torna su
8 |
9 | form_placeholder_search: Cerca
10 |
11 | error_page_title: Perso? Non ti preoccupare
12 | error_message_title: Perso?
13 | error_message_code: Errore 404
14 | error_message_text: >
15 | Sembra che non sia possibile trovare quello che stavi cercando. Non ti preoccupare,
16 | possiamo riportarti alla pagina iniziale.
17 |
18 | button_toggle_dark: Seleziona il tema Chiaro/Scuro/Automatico
19 | button_nav_open: Apri la Navigazione
20 | button_nav_close: Chiudi la Navigazione
21 | button_menu_open: Apri la Barra del Menu
22 | button_menu_close: Chiudi la Barra del Menu
23 | button_homepage: Torna alla pagina iniziale
24 |
25 | title_anchor_prefix: "Ancora a:"
26 |
27 | posts_read_more: Leggi tutto il post
28 | posts_read_time:
29 | one: "Tempo di lettura: un minuto"
30 | other: "Tempo di lettura: {{ . }} minuti"
31 | posts_update_prefix: Aggiornato il
32 | posts_count:
33 | one: "Un post"
34 | other: "{{ . }} post"
35 | posts_tagged_with: Tutti i post etichettati con '{{ . }}'
36 |
37 | footer_build_with: >
38 | Realizzato con Hugo e
39 |
40 | footer_legal_notice: Avviso Legale
41 | footer_privacy_policy: Politica sulla Privacy
42 | footer_content_license_prefix: >
43 | Contenuto sotto licenza
44 |
45 | language_switch_no_tranlation_prefix: "Pagina non tradotta:"
46 |
47 | propertylist_required: richiesto
48 | propertylist_optional: opzionale
49 | propertylist_default: valore predefinito
50 |
51 | pagination_page_prev: precedente
52 | pagination_page_next: prossimo
53 | pagination_page_state: "{{ .PageNumber }}/{{ .TotalPages }}"
54 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/partials/language.html:
--------------------------------------------------------------------------------
1 | {{ if hugo.IsMultilingual }}
2 |
3 |
46 | {{ template "main" . }}
47 |
48 |
49 |
52 |
53 | -
4 |
-
5 | {{ range .Site.Languages }}
6 | {{ if eq . $.Site.Language }}
7 |
8 |
9 | {{ .Lang | upper }}
10 |
11 | {{ end }}
12 | {{ end }}
13 |
14 |
15 |
-
16 | {{ if $.Translations }}
17 | {{ range $.Translations }}
18 |
- 19 | 26 | {{ .Language.LanguageName }} 27 | 28 | 29 | {{ end }} 30 | {{ else }} 31 | {{ range .Site.Languages -}} 32 | {{ if ne $.Site.Language.Lang .Lang }} 33 |
- 34 | 41 | {{ .LanguageName }}* 42 | 43 | 44 | {{ end -}} 45 | {{ end -}} 46 | {{ end }} 47 |
49 |
-
7 | {{- with (index .Site.Data.properties (split $name ".")) }}
8 | {{- $properties := .properties }}
9 | {{- with $sort }}
10 | {{- $properties = (sort $properties . $order) }}
11 | {{- end }}
12 | {{- range $properties }}
13 |
34 |
-
35 | 36 | {{- with .description }} 37 | {{- $desc := . }} 38 | {{- if reflect.IsMap $desc }} 39 | {{- $desc = (index $desc $.Site.Language.Lang) }} 40 | {{- end }} 41 | 42 | {{ $desc | $.Page.RenderString }} 43 | {{ end }} 44 |45 |46 | {{- with default "none" (.defaultValue | string) }} 47 | {{ i18n "propertylist_default" | title }}: 48 | {{ . }} 49 | {{- end }} 50 |51 |
52 | {{- end }}
53 | {{- end }}
54 |
34 | {{ if $showBreadcrumb }}
35 |
58 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/shortcodes/img.html:
--------------------------------------------------------------------------------
1 | {{- $source := ($.Page.Resources.ByType "image").GetMatch (printf "%s" (.Get "name")) }}
2 | {{- $customAlt := .Get "alt" }}
3 | {{- $customSize := .Get "size" | lower }}
4 | {{- $lazyLoad := default (default true $.Site.Params.GeekdocImageLazyLoading) (.Get "lazy") }}
5 | {{- $data := newScratch }}
6 |
7 | {{- with $source }}
8 | {{- $caption := default .Title $customAlt }}
9 | {{- $isSVG := (eq .MediaType.SubType "svg") }}
10 |
11 | {{- $origin := .Permalink }}
12 | {{- if $isSVG }}
13 | {{- $data.SetInMap "size" "profile" "180" }}
14 | {{- $data.SetInMap "size" "tiny" "320" }}
15 | {{- $data.SetInMap "size" "small" "600" }}
16 | {{- $data.SetInMap "size" "medium" "1200" }}
17 | {{- $data.SetInMap "size" "large" "1800" }}
18 | {{- else }}
19 | {{- $data.SetInMap "size" "profile" (.Fill "180x180 Center").Permalink }}
20 | {{- $data.SetInMap "size" "tiny" (.Resize "320x").Permalink }}
21 | {{- $data.SetInMap "size" "small" (.Resize "600x").Permalink }}
22 | {{- $data.SetInMap "size" "medium" (.Resize "1200x").Permalink }}
23 | {{- $data.SetInMap "size" "large" (.Resize "1800x").Permalink }}
24 | {{- end }}
25 |
26 |
27 |
36 |
37 |
43 |
44 | {{ end }}
45 | {{ if $showEdit }}
46 |
47 |
48 |
49 |
52 | {{ i18n "edit_page" }}
53 |
54 |
55 |
56 | {{ end }}
57 |
28 |
32 |
33 |
34 | {{- $size := $data.Get "size" }}
35 | {{- if not $isSVG }}
36 | 
57 |
58 |
59 | {{- if not (eq $customSize "profile") }}
60 | {{- with $caption }}
61 |
62 | {{ . }}
63 | {{- with $source.Params.credits }}
64 | {{ printf " (%s)" . | $.Page.RenderString }}
65 | {{- end }}
66 |
67 | {{- end }}
68 | {{- end }}
69 |
70 |
71 | {{- end }}
72 |
--------------------------------------------------------------------------------
/dbconn/mycnf.go:
--------------------------------------------------------------------------------
1 | // Copyright 2023 Block, Inc.
2 |
3 | package dbconn
4 |
5 | import (
6 | "strings"
7 |
8 | "github.com/go-ini/ini"
9 |
10 | "github.com/square/finch"
11 | "github.com/square/finch/config"
12 | )
13 |
14 | // ParseMyCnf parses a MySQL my.cnf file. It only reads the "[client]" section,
15 | // same as the mysql CLI.
16 | func ParseMyCnf(file string) (config.MySQL, error) {
17 | opts := ini.LoadOptions{AllowBooleanKeys: true}
18 | mycnf, err := ini.LoadSources(opts, file)
19 | if err != nil {
20 | return config.MySQL{}, err
21 | }
22 |
23 | cfg := config.MySQL{
24 | Username: mycnf.Section("client").Key("user").String(),
25 | Password: mycnf.Section("client").Key("password").String(),
26 | Hostname: mycnf.Section("client").Key("host").String(),
27 | Socket: mycnf.Section("client").Key("socket").String(),
28 | }
29 |
30 | port := mycnf.Section("client").Key("port").String()
31 | if port != "" {
32 | cfg.Hostname += ":" + port
33 | }
34 |
35 | // Translate MySQL ssl-* vars to config.TLS. The vars don't line up
36 | // perfectly because MySQL has several levels of TLS verification:
37 | // https://dev.mysql.com/doc/refman/8.0/en/connection-options.html#option_general_ssl-mode
38 | // But Go tls.Config (which is derived from config.TLS) has only two
39 | // options: specify tls.Confg.ServerName _or_ .InsecureSkipVerify=true.
40 | mysqlTLS(file, mycnf, &cfg)
41 |
42 | finch.Debug("mycnf %s: %s %+v", file, cfg.Redacted())
43 | return cfg, nil
44 | }
45 |
46 | func mysqlTLS(file string, mycnf *ini.File, cfg *config.MySQL) (tls config.TLS) {
47 | // USING IMPLICIT RETURN -----------------------------------^
48 |
49 | tls.MySQLMode = strings.ToUpper(mycnf.Section("client").Key("ssl-mode").String())
50 | if tls.MySQLMode == "" {
51 | tls.MySQLMode = "PREFERRED" // MySQL default
52 | }
53 |
54 | // Explicitly disabled = not TLS even if other vars set
55 | if tls.MySQLMode == "DISABLED" {
56 | finch.Debug("mycnf %s: ssl-mode=DISABLED", file)
57 | return
58 | }
59 |
60 | // As per the MySQL manual:
61 | // "Connections over Unix socket files are not encrypted with a mode of PREFERRED.
62 | // To enforce encryption for Unix socket-file connections, use a mode of REQUIRED or stricter.
63 | if cfg.Socket != "" && tls.MySQLMode == "PREFERRED" {
64 | finch.Debug("mycnf %s: ignoring TLS on socket %s", file, cfg.Socket)
65 | return
66 | }
67 |
68 | // Not TLS unless at least 1 of the 3 files is set (no validation yet)
69 | tls.CA = mycnf.Section("client").Key("ssl-ca").String()
70 | tls.Cert = mycnf.Section("client").Key("ssl-cert").String()
71 | tls.Key = mycnf.Section("client").Key("ssl-key").String()
72 | if !tls.Set() {
73 | finch.Debug("mycnf %s: TLS not set", file)
74 | return
75 | }
76 |
77 | // Probably legit/normal MySQL TLS config: hostname + at least 1 file.
78 | // But it's unclear if, for example, PREFERRED = SkipVerify=true?
79 | return
80 | }
81 |
--------------------------------------------------------------------------------
/config/config_test.go:
--------------------------------------------------------------------------------
1 | package config_test
2 |
3 | import (
4 | "os"
5 | "path/filepath"
6 | "testing"
7 |
8 | "github.com/go-test/deep"
9 |
10 | "github.com/square/finch/config"
11 | )
12 |
13 | func TestValidate_Stage(t *testing.T) {
14 | c := config.Stage{}
15 | err := c.Validate()
16 | if err == nil {
17 | t.Error("stage with disable=false and zero trx returned err=nil, expected validation error")
18 | }
19 |
20 | c.Disable = true
21 | err = c.Validate()
22 | if err != nil {
23 | t.Errorf("stage with disable=true and zero trx returned an error, experted err=nil: %v", err)
24 | }
25 | }
26 |
27 | func TestVars(t *testing.T) {
28 | params := map[string]string{
29 | "foo": "bar",
30 | "n": "100",
31 | "a-b": "val",
32 | }
33 |
34 | home := os.Getenv("HOME")
35 |
36 | var tests = []struct {
37 | s, expect string
38 | numbers bool
39 | }{
40 | // numbers=true (humanize numbers: 1k -> 1000)
41 | {"rows: 5", "rows: 5", true},
42 | {"rows: $params.n", "rows: 100", true},
43 | {"rows: ${params.n}", "rows: 100", true},
44 | {`p: "${params.foo}"`, `p: "bar"`, true},
45 | {`p: _${params.foo}_`, `p: _bar_`, true},
46 | {`r: $params.a-b`, `r: val`, true},
47 | {"key: $params.n $params.foo", "key: 100 bar", true},
48 | {"home: $HOME", "home: " + home, true}, // env var
49 | {"rows: 1K", "rows: 1000", true},
50 | {"rows: 1,000", "rows: 1000", true},
51 | {"size: 1GiB", "size: 1073741824", true},
52 | {"(1, 2, 'foo')", "(1, 2, 'foo')", true},
53 | // numbers=false
54 | {"db.abd6b.us-east-1.rds.amazonaws.com", "db.abd6b.us-east-1.rds.amazonaws.com", false},
55 | }
56 | for _, tt := range tests {
57 | t.Run(tt.s, func(t *testing.T) {
58 | got, err := config.Vars(tt.s, params, tt.numbers)
59 | if err != nil {
60 | t.Errorf("got an error, expected nil: %v", err)
61 | }
62 | if got != tt.expect {
63 | t.Errorf("got '%s', expected '%s'", got, tt.expect)
64 | }
65 | })
66 | }
67 | }
68 |
69 | func TestLoadWithBase(t *testing.T) {
70 | stages, err := config.Load([]string{"../test/config/b1/stage.yaml"}, nil, "", "")
71 | if err != nil {
72 | t.Error(err)
73 | }
74 | if len(stages) == 0 {
75 | t.Fatalf("got 0 stages, expected 1")
76 | }
77 | fileName, _ := filepath.Abs("../test/config/b1/stage.yaml")
78 | expect := config.Stage{
79 | N: 1,
80 | Name: "test",
81 | File: fileName,
82 | Compute: config.Compute{
83 | Instances: "1",
84 | },
85 | Params: map[string]string{
86 | "foo": "test",
87 | },
88 | Stats: config.Stats{
89 | Freq: "0s",
90 | Report: map[string]map[string]string{
91 | "stdout": map[string]string{
92 | "each-instance": "true",
93 | },
94 | },
95 | },
96 | Trx: []config.Trx{
97 | {
98 | Name: "trx.sql",
99 | File: "trx.sql",
100 | },
101 | },
102 | }
103 | if diff := deep.Equal(stages[0], expect); diff != nil {
104 | t.Error(diff)
105 | }
106 | }
107 |
--------------------------------------------------------------------------------
/limit/rate.go:
--------------------------------------------------------------------------------
1 | // Copyright 2023 Block, Inc.
2 |
3 | package limit
4 |
5 | import (
6 | "context"
7 | "fmt"
8 |
9 | gorate "golang.org/x/time/rate"
10 |
11 | "github.com/square/finch"
12 | )
13 |
14 | type Rate interface {
15 | Adjust(byte)
16 | Current() (byte, string)
17 | Allow() <-chan bool
18 | Stop()
19 | }
20 |
21 | type rate struct {
22 | c chan bool
23 | n uint
24 | rl *gorate.Limiter
25 | stopChan chan struct{}
26 | }
27 |
28 | var _ Rate = &rate{}
29 |
30 | func NewRate(perSecond uint) Rate {
31 | if perSecond == 0 {
32 | return nil
33 | }
34 | finch.Debug("new rate: %d/s", perSecond)
35 | lm := &rate{
36 | rl: gorate.NewLimiter(gorate.Limit(perSecond), 1),
37 | c: make(chan bool, 1),
38 | stopChan: make(chan struct{}),
39 | }
40 | go lm.run()
41 | return lm
42 | }
43 |
44 | func (lm *rate) Adjust(p byte) {
45 | }
46 |
47 | func (lm *rate) Current() (p byte, s string) {
48 | return 0, ""
49 | }
50 |
51 | func (lm *rate) Stop() {
52 | }
53 |
54 | func (lm *rate) Allow() <-chan bool {
55 | return lm.c
56 | }
57 |
58 | func (lm *rate) run() {
59 | var err error
60 | for {
61 | err = lm.rl.Wait(context.Background())
62 | if err != nil {
63 | // burst limit exceeded?
64 | continue
65 | }
66 | select {
67 | case lm.c <- true:
68 | case <-lm.stopChan:
69 | return
70 | default:
71 | // dropped
72 | }
73 | }
74 | }
75 |
76 | // --------------------------------------------------------------------------
77 |
78 | type and struct {
79 | c chan bool
80 | n uint
81 | a Rate
82 | b Rate
83 | }
84 |
85 | var _ Rate = &and{}
86 |
87 | // And makes a Rate limiter that allows execution when both a and b allow it.
88 | // This is used to combine QPS and TPS rate limits to keep clients at or below
89 | // both rates.
90 | func And(a, b Rate) Rate {
91 | if a == nil && b == nil {
92 | return nil
93 | }
94 | if a == nil && b != nil {
95 | return b
96 | }
97 | if a != nil && b == nil {
98 | return a
99 | }
100 | lm := &and{
101 | a: a,
102 | b: b,
103 | c: make(chan bool, 1),
104 | }
105 | go lm.run()
106 | return lm
107 | }
108 |
109 | func (lm *and) Allow() <-chan bool {
110 | return lm.c
111 | }
112 |
113 | func (lm *and) N(_ uint) {
114 | }
115 |
116 | func (lm *and) Adjust(p byte) {
117 | lm.a.Adjust(p)
118 | lm.b.Adjust(p)
119 | }
120 |
121 | func (lm *and) Current() (p byte, s string) {
122 | p1, s1 := lm.a.Current()
123 | p2, s2 := lm.a.Current()
124 | if p1 != p2 {
125 | panic(fmt.Sprintf("lm.A %d != lm.B %d", p1, p2))
126 | }
127 | return p1, s1 + " and " + s2
128 | }
129 |
130 | func (lm *and) Stop() {
131 | lm.a.Stop()
132 | lm.b.Stop()
133 | }
134 |
135 | func (lm *and) run() {
136 | a := false
137 | b := false
138 | for {
139 | select {
140 | case <-lm.a.Allow():
141 | a = true
142 | case <-lm.b.Allow():
143 | b = true
144 | }
145 | if a && b {
146 | select {
147 | case lm.c <- true:
148 | default:
149 | // dropped
150 | }
151 | a = false
152 | b = false
153 | }
154 | }
155 | }
156 |
--------------------------------------------------------------------------------
/docs/themes/hugo-geekdoc/layouts/partials/site-header.html:
--------------------------------------------------------------------------------
1 |
3 | {{ if .MenuEnabled }}
4 |
14 | {{ end }}
15 |
27 |
77 |
78 |