X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/65efe2535e49058ccf8250f93e958ea653f55cd8..bcf069c6a726e219bc40224653268d87776e54aa:/tools/keep-block-check/keep-block-check_test.go diff --git a/tools/keep-block-check/keep-block-check_test.go b/tools/keep-block-check/keep-block-check_test.go index 5bd606266c..a2000baefd 100644 --- a/tools/keep-block-check/keep-block-check_test.go +++ b/tools/keep-block-check/keep-block-check_test.go @@ -1,3 +1,7 @@ +// Copyright (C) The Arvados Authors. All rights reserved. +// +// SPDX-License-Identifier: AGPL-3.0 + package main import ( @@ -10,7 +14,9 @@ import ( "regexp" "strings" "testing" + "time" + "git.curoverse.com/arvados.git/sdk/go/arvadosclient" "git.curoverse.com/arvados.git/sdk/go/arvadostest" "git.curoverse.com/arvados.git/sdk/go/keepclient" @@ -30,10 +36,12 @@ type ServerRequiredSuite struct{} type DoMainTestSuite struct{} var kc *keepclient.KeepClient -var keepServicesJSON, blobSigningKey string +var logBuffer bytes.Buffer + var TestHash = "aaaa09c290d0fb1ca068ffaddf22cbd0" var TestHash2 = "aaaac516f788aec4f30932ffb6395c39" -var allLocators []string + +var blobSignatureTTL = time.Duration(2*7*24) * time.Hour func (s *ServerRequiredSuite) SetUpSuite(c *C) { arvadostest.StartAPI() @@ -44,12 +52,7 @@ func (s *ServerRequiredSuite) TearDownSuite(c *C) { arvadostest.ResetEnv() } -var logBuffer bytes.Buffer - func (s *ServerRequiredSuite) SetUpTest(c *C) { - blobSigningKey = "" - keepServicesJSON = "" - logOutput := io.MultiWriter(&logBuffer) log.SetOutput(logOutput) } @@ -63,43 +66,42 @@ func (s *ServerRequiredSuite) TearDownTest(c *C) { func (s *DoMainTestSuite) SetUpSuite(c *C) { } -var testArgs = []string{} - func (s *DoMainTestSuite) SetUpTest(c *C) { - blobSigningKey = "" - keepServicesJSON = "" - logOutput := io.MultiWriter(&logBuffer) log.SetOutput(logOutput) + keepclient.RefreshServiceDiscovery() } func (s *DoMainTestSuite) TearDownTest(c *C) { log.SetOutput(os.Stdout) log.Printf("%v", logBuffer.String()) - testArgs = []string{} } -func setupKeepBlockCheck(c *C, enforcePermissions bool) { +func setupKeepBlockCheck(c *C, enforcePermissions bool, keepServicesJSON string) { + setupKeepBlockCheckWithTTL(c, enforcePermissions, keepServicesJSON, blobSignatureTTL) +} + +func setupKeepBlockCheckWithTTL(c *C, enforcePermissions bool, keepServicesJSON string, ttl time.Duration) { var config apiConfig config.APIHost = os.Getenv("ARVADOS_API_HOST") config.APIToken = arvadostest.DataManagerToken - config.APIHostInsecure = matchTrue.MatchString(os.Getenv("ARVADOS_API_HOST_INSECURE")) - if enforcePermissions { - blobSigningKey = arvadostest.BlobSigningKey - } + config.APIHostInsecure = arvadosclient.StringBool(os.Getenv("ARVADOS_API_HOST_INSECURE")) // Start Keep servers arvadostest.StartKeep(2, enforcePermissions) // setup keepclients var err error - kc, err = setupKeepClient(config, keepServicesJSON) + kc, ttl, err = setupKeepClient(config, keepServicesJSON, ttl) + c.Assert(ttl, Equals, blobSignatureTTL) c.Check(err, IsNil) + + keepclient.RefreshServiceDiscovery() } // Setup test data -func setupTestData(c *C) { - allLocators = []string{} +func setupTestData(c *C) []string { + allLocators := []string{} // Put a few blocks for i := 0; i < 5; i++ { @@ -107,6 +109,8 @@ func setupTestData(c *C) { c.Check(err, IsNil) allLocators = append(allLocators, strings.Split(hash, "+A")[0]) } + + return allLocators } func setupConfigFile(c *C, fileName string) string { @@ -148,9 +152,8 @@ func setupBlockHashFile(c *C, name string, blocks []string) string { func checkErrorLog(c *C, blocks []string, prefix, suffix string) { for _, hash := range blocks { - expected := prefix + `.*` + hash + `.*` + suffix - match, _ := regexp.MatchString(expected, logBuffer.String()) - c.Assert(match, Equals, true) + expected := `(?ms).*` + prefix + `.*` + hash + `.*` + suffix + `.*` + c.Check(logBuffer.String(), Matches, expected) } } @@ -161,42 +164,50 @@ func checkNoErrorsLogged(c *C, prefix, suffix string) { } func (s *ServerRequiredSuite) TestBlockCheck(c *C) { - setupKeepBlockCheck(c, false) - setupTestData(c) - err := performKeepBlockCheck(kc, blobSigningKey, allLocators, true) + setupKeepBlockCheck(c, false, "") + allLocators := setupTestData(c) + err := performKeepBlockCheck(kc, blobSignatureTTL, "", allLocators, true) c.Check(err, IsNil) checkNoErrorsLogged(c, "Error verifying block", "Block not found") } func (s *ServerRequiredSuite) TestBlockCheckWithBlobSigning(c *C) { - setupKeepBlockCheck(c, true) - setupTestData(c) - err := performKeepBlockCheck(kc, blobSigningKey, allLocators, true) + setupKeepBlockCheck(c, true, "") + allLocators := setupTestData(c) + err := performKeepBlockCheck(kc, blobSignatureTTL, arvadostest.BlobSigningKey, allLocators, true) + c.Check(err, IsNil) + checkNoErrorsLogged(c, "Error verifying block", "Block not found") +} + +func (s *ServerRequiredSuite) TestBlockCheckWithBlobSigningAndTTLFromDiscovery(c *C) { + setupKeepBlockCheckWithTTL(c, true, "", 0) + allLocators := setupTestData(c) + err := performKeepBlockCheck(kc, blobSignatureTTL, arvadostest.BlobSigningKey, allLocators, true) c.Check(err, IsNil) checkNoErrorsLogged(c, "Error verifying block", "Block not found") } func (s *ServerRequiredSuite) TestBlockCheck_NoSuchBlock(c *C) { - setupKeepBlockCheck(c, false) - setupTestData(c) + setupKeepBlockCheck(c, false, "") + allLocators := setupTestData(c) allLocators = append(allLocators, TestHash) allLocators = append(allLocators, TestHash2) - err := performKeepBlockCheck(kc, blobSigningKey, allLocators, true) + err := performKeepBlockCheck(kc, blobSignatureTTL, "", allLocators, true) c.Check(err, NotNil) c.Assert(err.Error(), Equals, "Block verification failed for 2 out of 7 blocks with matching prefix.") checkErrorLog(c, []string{TestHash, TestHash2}, "Error verifying block", "Block not found") } func (s *ServerRequiredSuite) TestBlockCheck_NoSuchBlock_WithMatchingPrefix(c *C) { - setupKeepBlockCheck(c, false) - setupTestData(c) + setupKeepBlockCheck(c, false, "") + allLocators := setupTestData(c) allLocators = append(allLocators, TestHash) allLocators = append(allLocators, TestHash2) locatorFile := setupBlockHashFile(c, "block-hash", allLocators) defer os.Remove(locatorFile) locators, err := getBlockLocators(locatorFile, "aaa") c.Check(err, IsNil) - err = performKeepBlockCheck(kc, blobSigningKey, locators, true) + err = performKeepBlockCheck(kc, blobSignatureTTL, "", locators, true) c.Check(err, NotNil) // Of the 7 blocks in allLocators, only two match the prefix and hence only those are checked c.Assert(err.Error(), Equals, "Block verification failed for 2 out of 2 blocks with matching prefix.") @@ -204,26 +215,26 @@ func (s *ServerRequiredSuite) TestBlockCheck_NoSuchBlock_WithMatchingPrefix(c *C } func (s *ServerRequiredSuite) TestBlockCheck_NoSuchBlock_WithPrefixMismatch(c *C) { - setupKeepBlockCheck(c, false) - setupTestData(c) + setupKeepBlockCheck(c, false, "") + allLocators := setupTestData(c) allLocators = append(allLocators, TestHash) allLocators = append(allLocators, TestHash2) locatorFile := setupBlockHashFile(c, "block-hash", allLocators) defer os.Remove(locatorFile) locators, err := getBlockLocators(locatorFile, "999") c.Check(err, IsNil) - err = performKeepBlockCheck(kc, blobSigningKey, locators, true) - c.Check(err, IsNil) // there were no matching locators and hence no errors + err = performKeepBlockCheck(kc, blobSignatureTTL, "", locators, true) + c.Check(err, IsNil) // there were no matching locators in file and hence nothing was checked } func (s *ServerRequiredSuite) TestBlockCheck_BadSignature(c *C) { - setupKeepBlockCheck(c, true) + setupKeepBlockCheck(c, true, "") setupTestData(c) - err := performKeepBlockCheck(kc, "badblobsigningkey", []string{TestHash, TestHash2}, false) + err := performKeepBlockCheck(kc, blobSignatureTTL, "badblobsigningkey", []string{TestHash, TestHash2}, false) c.Assert(err.Error(), Equals, "Block verification failed for 2 out of 2 blocks with matching prefix.") checkErrorLog(c, []string{TestHash, TestHash2}, "Error verifying block", "HTTP 403") // verbose logging not requested - c.Assert(strings.Contains(logBuffer.String(), "Checking block 1 of 2"), Equals, false) + c.Assert(strings.Contains(logBuffer.String(), "Verifying block 1 of 2"), Equals, false) } var testKeepServicesJSON = `{ @@ -254,17 +265,15 @@ var testKeepServicesJSON = `{ // Setup block-check using keepServicesJSON with fake keepservers. // Expect error during performKeepBlockCheck due to unreachable keepservers. func (s *ServerRequiredSuite) TestErrorDuringKeepBlockCheck_FakeKeepservers(c *C) { - keepServicesJSON = testKeepServicesJSON - setupKeepBlockCheck(c, false) - err := performKeepBlockCheck(kc, blobSigningKey, []string{TestHash, TestHash2}, true) + setupKeepBlockCheck(c, false, testKeepServicesJSON) + err := performKeepBlockCheck(kc, blobSignatureTTL, "", []string{TestHash, TestHash2}, true) c.Assert(err.Error(), Equals, "Block verification failed for 2 out of 2 blocks with matching prefix.") checkErrorLog(c, []string{TestHash, TestHash2}, "Error verifying block", "") } // Test keep-block-check initialization with keepServicesJSON func (s *ServerRequiredSuite) TestKeepBlockCheck_InitializeWithKeepServicesJSON(c *C) { - keepServicesJSON = testKeepServicesJSON - setupKeepBlockCheck(c, false) + setupKeepBlockCheck(c, false, testKeepServicesJSON) found := 0 for k := range kc.LocalRoots() { if k == "zzzzz-bi6l4-123456789012340" || k == "zzzzz-bi6l4-123456789012341" { @@ -286,23 +295,21 @@ func (s *ServerRequiredSuite) TestLoadConfig(c *C) { c.Assert(config.APIHost, Equals, os.Getenv("ARVADOS_API_HOST")) c.Assert(config.APIToken, Equals, arvadostest.DataManagerToken) - c.Assert(config.APIHostInsecure, Equals, matchTrue.MatchString(os.Getenv("ARVADOS_API_HOST_INSECURE"))) + c.Assert(config.APIHostInsecure, Equals, arvadosclient.StringBool(os.Getenv("ARVADOS_API_HOST_INSECURE"))) c.Assert(config.ExternalClient, Equals, false) c.Assert(blobSigningKey, Equals, "abcdefg") } func (s *DoMainTestSuite) Test_doMain_WithNoConfig(c *C) { args := []string{"-prefix", "a"} - testArgs = append(testArgs, args...) - err := doMain(testArgs) + err := doMain(args) c.Check(err, NotNil) c.Assert(strings.Contains(err.Error(), "config file not specified"), Equals, true) } func (s *DoMainTestSuite) Test_doMain_WithNoSuchConfigFile(c *C) { args := []string{"-config", "no-such-file"} - testArgs = append(testArgs, args...) - err := doMain(testArgs) + err := doMain(args) c.Check(err, NotNil) c.Assert(strings.Contains(err.Error(), "no such file or directory"), Equals, true) } @@ -311,14 +318,12 @@ func (s *DoMainTestSuite) Test_doMain_WithNoBlockHashFile(c *C) { config := setupConfigFile(c, "config") defer os.Remove(config) - args := []string{"-config", config} - testArgs = append(testArgs, args...) - // Start keepservers. arvadostest.StartKeep(2, false) defer arvadostest.StopKeep(2) - err := doMain(testArgs) + args := []string{"-config", config} + err := doMain(args) c.Assert(strings.Contains(err.Error(), "block-hash-file not specified"), Equals, true) } @@ -326,14 +331,11 @@ func (s *DoMainTestSuite) Test_doMain_WithNoSuchBlockHashFile(c *C) { config := setupConfigFile(c, "config") defer os.Remove(config) - args := []string{"-config", config, "-block-hash-file", "no-such-file"} - testArgs = append(testArgs, args...) - - // Start keepservers. arvadostest.StartKeep(2, false) defer arvadostest.StopKeep(2) - err := doMain(testArgs) + args := []string{"-config", config, "-block-hash-file", "no-such-file"} + err := doMain(args) c.Assert(strings.Contains(err.Error(), "no such file or directory"), Equals, true) } @@ -349,11 +351,9 @@ func (s *DoMainTestSuite) Test_doMain(c *C) { defer os.Remove(locatorFile) args := []string{"-config", config, "-block-hash-file", locatorFile, "-v"} - testArgs = append(testArgs, args...) - - err := doMain(testArgs) + err := doMain(args) c.Check(err, NotNil) c.Assert(err.Error(), Equals, "Block verification failed for 2 out of 2 blocks with matching prefix.") checkErrorLog(c, []string{TestHash, TestHash2}, "Error verifying block", "Block not found") - c.Assert(strings.Contains(logBuffer.String(), "Checking block 1 of 2"), Equals, true) + c.Assert(strings.Contains(logBuffer.String(), "Verifying block 1 of 2"), Equals, true) }