19889: Update docs.
[arvados.git] / lib / controller / localdb / localdb_test.go
1 // Copyright (C) The Arvados Authors. All rights reserved.
2 //
3 // SPDX-License-Identifier: AGPL-3.0
4
5 package localdb
6
7 import (
8         "context"
9         "errors"
10
11         "git.arvados.org/arvados.git/lib/config"
12         "git.arvados.org/arvados.git/lib/controller/rpc"
13         "git.arvados.org/arvados.git/lib/ctrlctx"
14         "git.arvados.org/arvados.git/sdk/go/arvados"
15         "git.arvados.org/arvados.git/sdk/go/arvadostest"
16         "git.arvados.org/arvados.git/sdk/go/ctxlog"
17         "github.com/jmoiron/sqlx"
18         check "gopkg.in/check.v1"
19 )
20
21 type localdbSuite struct {
22         ctx         context.Context
23         cancel      context.CancelFunc
24         cluster     *arvados.Cluster
25         db          *sqlx.DB
26         dbConnector *ctrlctx.DBConnector
27         tx          *sqlx.Tx
28         txFinish    func(*error)
29         userctx     context.Context // uses ActiveUser token
30         localdb     *Conn
31         railsSpy    *arvadostest.Proxy
32 }
33
34 func (s *localdbSuite) SetUpSuite(c *check.C) {
35         arvadostest.StartKeep(2, true)
36 }
37
38 func (s *localdbSuite) TearDownSuite(c *check.C) {
39         // Undo any changes/additions to the user database so they
40         // don't affect subsequent tests.
41         arvadostest.ResetEnv()
42         c.Check(arvados.NewClientFromEnv().RequestAndDecode(nil, "POST", "database/reset", nil, nil), check.IsNil)
43 }
44
45 func (s *localdbSuite) SetUpTest(c *check.C) {
46         *s = localdbSuite{}
47         s.ctx, s.cancel = context.WithCancel(context.Background())
48         cfg, err := config.NewLoader(nil, ctxlog.TestLogger(c)).Load()
49         c.Assert(err, check.IsNil)
50         s.cluster, err = cfg.GetCluster("")
51         c.Assert(err, check.IsNil)
52         s.dbConnector = &ctrlctx.DBConnector{PostgreSQL: s.cluster.PostgreSQL}
53         s.db, err = s.dbConnector.GetDB(s.ctx)
54         c.Assert(err, check.IsNil)
55         s.ctx, s.txFinish = ctrlctx.New(s.ctx, s.dbConnector.GetDB)
56         s.tx, err = ctrlctx.CurrentTx(s.ctx)
57         c.Assert(err, check.IsNil)
58         s.localdb = NewConn(s.ctx, s.cluster, s.dbConnector.GetDB)
59         s.railsSpy = arvadostest.NewProxy(c, s.cluster.Services.RailsAPI)
60         *s.localdb.railsProxy = *rpc.NewConn(s.cluster.ClusterID, s.railsSpy.URL, true, rpc.PassthroughTokenProvider)
61         s.userctx = ctrlctx.NewWithToken(s.ctx, s.cluster, arvadostest.ActiveTokenV2)
62 }
63
64 var errRollbackAfterTest = errors.New("rollback after test")
65
66 func (s *localdbSuite) TearDownTest(c *check.C) {
67         if s.tx != nil {
68                 s.tx.Rollback()
69         }
70         if s.txFinish != nil {
71                 s.txFinish(&errRollbackAfterTest)
72         }
73         if s.railsSpy != nil {
74                 s.railsSpy.Close()
75         }
76         if s.dbConnector != nil {
77                 s.dbConnector.Close()
78         }
79         s.cancel()
80 }
81
82 func (s *localdbSuite) setUpVocabulary(c *check.C, testVocabulary string) {
83         if testVocabulary == "" {
84                 testVocabulary = `{
85                         "strict_tags": false,
86                         "tags": {
87                                 "IDTAGIMPORTANCES": {
88                                         "strict": true,
89                                         "labels": [{"label": "Importance"}, {"label": "Priority"}],
90                                         "values": {
91                                                 "IDVALIMPORTANCES1": { "labels": [{"label": "Critical"}, {"label": "Urgent"}, {"label": "High"}] },
92                                                 "IDVALIMPORTANCES2": { "labels": [{"label": "Normal"}, {"label": "Moderate"}] },
93                                                 "IDVALIMPORTANCES3": { "labels": [{"label": "Low"}] }
94                                         }
95                                 }
96                         }
97                 }`
98         }
99         voc, err := arvados.NewVocabulary([]byte(testVocabulary), []string{})
100         c.Assert(err, check.IsNil)
101         s.localdb.vocabularyCache = voc
102         s.cluster.API.VocabularyPath = "foo"
103 }