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 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
|
package api
import (
"encoding/json"
"errors"
"fmt"
"io"
"net"
"net/http"
"net/url"
"path/filepath"
"runtime/debug"
"strings"
"sync"
"testing"
"time"
"github.com/NebulousLabs/Sia/build"
"github.com/NebulousLabs/Sia/crypto"
"github.com/NebulousLabs/Sia/modules"
"github.com/NebulousLabs/Sia/modules/consensus"
"github.com/NebulousLabs/Sia/modules/explorer"
"github.com/NebulousLabs/Sia/modules/gateway"
"github.com/NebulousLabs/Sia/modules/host"
"github.com/NebulousLabs/Sia/modules/miner"
"github.com/NebulousLabs/Sia/modules/renter"
"github.com/NebulousLabs/Sia/modules/transactionpool"
"github.com/NebulousLabs/Sia/modules/wallet"
"github.com/NebulousLabs/Sia/persist"
"github.com/NebulousLabs/Sia/types"
)
// A Server is essentially a collection of modules and an API server to talk
// to them all.
type Server struct {
api *API
apiServer *http.Server
listener net.Listener
requiredUserAgent string
// wg is used to block Close() from returning until Serve() has finished. A
// WaitGroup is used instead of a chan struct{} so that Close() can be called
// without necessarily calling Serve() first.
wg sync.WaitGroup
}
// panicClose will cloae a Server, panicking if there is an error upon close.
func (srv *Server) panicClose() {
err := srv.Close()
if err != nil {
// Print the stack.
debug.PrintStack()
panic(err)
}
}
// Close closes the Server's listener, causing the HTTP server to shut down.
func (srv *Server) Close() error {
var errs []error
// Close the listener, which will cause Server.Serve() to return.
if err := srv.listener.Close(); err != nil {
errs = append(errs, fmt.Errorf("listener.Close failed: %v", err))
}
// Wait for Server.Serve() to exit. We wait so that it's guaranteed that the
// server has completely closed after Close() returns. This is particularly
// useful during testing so that we don't exit a test before Serve() finishes.
srv.wg.Wait()
// Safely close each module.
mods := []struct {
name string
c io.Closer
}{
{"explorer", srv.api.explorer},
{"host", srv.api.host},
{"renter", srv.api.renter},
{"miner", srv.api.miner},
{"wallet", srv.api.wallet},
{"tpool", srv.api.tpool},
{"consensus", srv.api.cs},
{"gateway", srv.api.gateway},
}
for _, mod := range mods {
if mod.c != nil {
if err := mod.c.Close(); err != nil {
errs = append(errs, fmt.Errorf("%v.Close failed: %v", mod.name, err))
}
}
}
return build.JoinErrors(errs, "\n")
}
// Serve listens for and handles API calls. It is a blocking function.
func (srv *Server) Serve() error {
// Block the Close() method until Serve() has finished.
srv.wg.Add(1)
defer srv.wg.Done()
// The server will run until an error is encountered or the listener is
// closed, via either the Close method or the signal handling above.
// Closing the listener will result in the benign error handled below.
err := srv.apiServer.Serve(srv.listener)
if err != nil && !strings.HasSuffix(err.Error(), "use of closed network connection") {
return err
}
return nil
}
// NewServer creates a new API server from the provided modules. The API will
// require authentication using HTTP basic auth if the supplied password is not
// the empty string. Usernames are ignored for authentication. This type of
// authentication sends passwords in plaintext and should therefore only be
// used if the APIaddr is localhost.
func NewServer(APIaddr string, requiredUserAgent string, requiredPassword string, cs modules.ConsensusSet, e modules.Explorer, g modules.Gateway, h modules.Host, m modules.Miner, r modules.Renter, tp modules.TransactionPool, w modules.Wallet) (*Server, error) {
l, err := net.Listen("tcp", APIaddr)
if err != nil {
return nil, err
}
a := New(requiredUserAgent, requiredPassword, cs, e, g, h, m, r, tp, w)
srv := &Server{
api: a,
listener: l,
requiredUserAgent: requiredUserAgent,
apiServer: &http.Server{
Handler: a,
},
}
return srv, nil
}
// serverTester contains a server and a set of channels for keeping all of the
// modules synchronized during testing.
type serverTester struct {
cs modules.ConsensusSet
explorer modules.Explorer
gateway modules.Gateway
host modules.Host
miner modules.TestMiner
renter modules.Renter
tpool modules.TransactionPool
wallet modules.Wallet
walletKey crypto.TwofishKey
server *Server
dir string
}
// assembleServerTester creates a bunch of modules and assembles them into a
// server tester, without creating any directories or mining any blocks.
func assembleServerTester(key crypto.TwofishKey, testdir string) (*serverTester, error) {
// assembleServerTester should not get called during short tests, as it
// takes a long time to run.
if testing.Short() {
panic("assembleServerTester called during short tests")
}
// Create the modules.
g, err := gateway.New("localhost:0", false, filepath.Join(testdir, modules.GatewayDir))
if err != nil {
return nil, err
}
cs, err := consensus.New(g, false, filepath.Join(testdir, modules.ConsensusDir))
if err != nil {
return nil, err
}
tp, err := transactionpool.New(cs, g, filepath.Join(testdir, modules.TransactionPoolDir))
if err != nil {
return nil, err
}
w, err := wallet.New(cs, tp, filepath.Join(testdir, modules.WalletDir))
if err != nil {
return nil, err
}
if !w.Encrypted() {
_, err = w.Encrypt(key)
if err != nil {
return nil, err
}
}
err = w.Unlock(key)
if err != nil {
return nil, err
}
m, err := miner.New(cs, tp, w, filepath.Join(testdir, modules.MinerDir))
if err != nil {
return nil, err
}
h, err := host.New(cs, tp, w, "localhost:0", filepath.Join(testdir, modules.HostDir))
if err != nil {
return nil, err
}
r, err := renter.New(g, cs, w, tp, filepath.Join(testdir, modules.RenterDir))
if err != nil {
return nil, err
}
srv, err := NewServer("localhost:0", "Sia-Agent", "", cs, nil, g, h, m, r, tp, w)
if err != nil {
return nil, err
}
// Assemble the serverTester.
st := &serverTester{
cs: cs,
gateway: g,
host: h,
miner: m,
renter: r,
tpool: tp,
wallet: w,
walletKey: key,
server: srv,
dir: testdir,
}
// TODO: A more reasonable way of listening for server errors.
go func() {
listenErr := srv.Serve()
if listenErr != nil {
panic(listenErr)
}
}()
return st, nil
}
// assembleAuthenticatedServerTester creates a bunch of modules and assembles
// them into a server tester that requires authentication with the given
// requiredPassword. No directories are created and no blocks are mined.
func assembleAuthenticatedServerTester(requiredPassword string, key crypto.TwofishKey, testdir string) (*serverTester, error) {
// assembleAuthenticatedServerTester should not get called during short
// tests, as it takes a long time to run.
if testing.Short() {
panic("assembleServerTester called during short tests")
}
// Create the modules.
g, err := gateway.New("localhost:0", false, filepath.Join(testdir, modules.GatewayDir))
if err != nil {
return nil, err
}
cs, err := consensus.New(g, false, filepath.Join(testdir, modules.ConsensusDir))
if err != nil {
return nil, err
}
tp, err := transactionpool.New(cs, g, filepath.Join(testdir, modules.TransactionPoolDir))
if err != nil {
return nil, err
}
w, err := wallet.New(cs, tp, filepath.Join(testdir, modules.WalletDir))
if err != nil {
return nil, err
}
if !w.Encrypted() {
_, err = w.Encrypt(key)
if err != nil {
return nil, err
}
}
err = w.Unlock(key)
if err != nil {
return nil, err
}
m, err := miner.New(cs, tp, w, filepath.Join(testdir, modules.MinerDir))
if err != nil {
return nil, err
}
h, err := host.New(cs, tp, w, "localhost:0", filepath.Join(testdir, modules.HostDir))
if err != nil {
return nil, err
}
r, err := renter.New(g, cs, w, tp, filepath.Join(testdir, modules.RenterDir))
if err != nil {
return nil, err
}
srv, err := NewServer("localhost:0", "Sia-Agent", requiredPassword, cs, nil, g, h, m, r, tp, w)
if err != nil {
return nil, err
}
// Assemble the serverTester.
st := &serverTester{
cs: cs,
gateway: g,
host: h,
miner: m,
renter: r,
tpool: tp,
wallet: w,
walletKey: key,
server: srv,
dir: testdir,
}
// TODO: A more reasonable way of listening for server errors.
go func() {
listenErr := srv.Serve()
if listenErr != nil {
panic(listenErr)
}
}()
return st, nil
}
// assembleExplorerServerTester creates all the explorer dependencies and
// explorer module without creating any directories. The user agent requirement
// is disabled.
func assembleExplorerServerTester(testdir string) (*serverTester, error) {
// assembleExplorerServerTester should not get called during short tests,
// as it takes a long time to run.
if testing.Short() {
panic("assembleServerTester called during short tests")
}
// Create the modules.
g, err := gateway.New("localhost:0", false, filepath.Join(testdir, modules.GatewayDir))
if err != nil {
return nil, err
}
cs, err := consensus.New(g, false, filepath.Join(testdir, modules.ConsensusDir))
if err != nil {
return nil, err
}
e, err := explorer.New(cs, filepath.Join(testdir, modules.ExplorerDir))
if err != nil {
return nil, err
}
srv, err := NewServer("localhost:0", "", "", cs, e, g, nil, nil, nil, nil, nil)
if err != nil {
return nil, err
}
// Assemble the serverTester.
st := &serverTester{
cs: cs,
explorer: e,
gateway: g,
server: srv,
dir: testdir,
}
// TODO: A more reasonable way of listening for server errors.
go func() {
listenErr := srv.Serve()
if listenErr != nil {
panic(listenErr)
}
}()
return st, nil
}
// blankServerTester creates a server tester object that is ready for testing,
// without mining any blocks.
func blankServerTester(name string) (*serverTester, error) {
// createServerTester is expensive, and therefore should not be called
// during short tests.
if testing.Short() {
panic("blankServerTester called during short tests")
}
// Create the server tester with key.
testdir := build.TempDir("api", name)
key := crypto.GenerateTwofishKey()
st, err := assembleServerTester(key, testdir)
if err != nil {
return nil, err
}
return st, nil
}
// createServerTester creates a server tester object that is ready for testing,
// including money in the wallet and all modules initialized.
func createServerTester(name string) (*serverTester, error) {
// createServerTester is expensive, and therefore should not be called
// during short tests.
if testing.Short() {
panic("createServerTester called during short tests")
}
// Create the testing directory.
testdir := build.TempDir("api", name)
key := crypto.GenerateTwofishKey()
st, err := assembleServerTester(key, testdir)
if err != nil {
return nil, err
}
// Mine blocks until the wallet has confirmed money.
for i := types.BlockHeight(0); i <= types.MaturityDelay; i++ {
_, err := st.miner.AddBlock()
if err != nil {
return nil, err
}
}
return st, nil
}
// createAuthenticatedServerTester creates an authenticated server tester
// object that is ready for testing, including money in the wallet and all
// modules initialized.
func createAuthenticatedServerTester(name string, password string) (*serverTester, error) {
// createAuthenticatedServerTester should not get called during short
// tests, as it takes a long time to run.
if testing.Short() {
panic("assembleServerTester called during short tests")
}
// Create the testing directory.
testdir := build.TempDir("authenticated-api", name)
key := crypto.GenerateTwofishKey()
st, err := assembleAuthenticatedServerTester(password, key, testdir)
if err != nil {
return nil, err
}
// Mine blocks until the wallet has confirmed money.
for i := types.BlockHeight(0); i <= types.MaturityDelay; i++ {
_, err := st.miner.AddBlock()
if err != nil {
return nil, err
}
}
return st, nil
}
// createExplorerServerTester creates a server tester object containing only
// the explorer and some presets that match standard explorer setups.
func createExplorerServerTester(name string) (*serverTester, error) {
testdir := build.TempDir("api", name)
st, err := assembleExplorerServerTester(testdir)
if err != nil {
return nil, err
}
return st, nil
}
// decodeError returns the api.Error from a API response. This method should
// only be called if the response's status code is non-2xx. The error returned
// may not be of type api.Error in the event of an error unmarshalling the
// JSON.
func decodeError(resp *http.Response) error {
var apiErr Error
err := json.NewDecoder(resp.Body).Decode(&apiErr)
if err != nil {
return err
}
return apiErr
}
// non2xx returns true for non-success HTTP status codes.
func non2xx(code int) bool {
return code < 200 || code > 299
}
// panicClose attempts to close a serverTester. If it fails, panic is called
// with the error.
func (st *serverTester) panicClose() {
st.server.panicClose()
}
// retry will retry a function multiple times until it returns 'nil'. It will
// sleep the specified duration between tries. If success is not achieved in the
// specified number of attempts, the final error is returned.
func retry(tries int, durationBetweenAttempts time.Duration, fn func() error) (err error) {
for i := 0; i < tries-1; i++ {
err = fn()
if err == nil {
return nil
}
time.Sleep(durationBetweenAttempts)
}
return fn()
}
// reloadedServerTester creates a server tester where all of the persistent
// data has been copied to a new folder and all of the modules re-initialized
// on the new folder. This gives an opportunity to see how modules will behave
// when they are relying on their persistent structures.
func (st *serverTester) reloadedServerTester() (*serverTester, error) {
// Copy the testing directory.
copiedDir := st.dir + " - " + persist.RandomSuffix()
err := build.CopyDir(st.dir, copiedDir)
if err != nil {
return nil, err
}
copyST, err := assembleServerTester(st.walletKey, copiedDir)
if err != nil {
return nil, err
}
return copyST, nil
}
// netAddress returns the NetAddress of the caller.
func (st *serverTester) netAddress() modules.NetAddress {
return st.server.api.gateway.Address()
}
// coinAddress returns a coin address that the caller is able to spend from.
func (st *serverTester) coinAddress() string {
var addr struct {
Address string
}
st.getAPI("/wallet/address", &addr)
return addr.Address
}
// acceptContracts instructs the host to begin accepting contracts.
func (st *serverTester) acceptContracts() error {
settingsValues := url.Values{}
settingsValues.Set("acceptingcontracts", "true")
return st.stdPostAPI("/host", settingsValues)
}
// setHostStorage adds a storage folder to the host.
func (st *serverTester) setHostStorage() error {
values := url.Values{}
values.Set("path", st.dir)
values.Set("size", "1048576")
return st.stdPostAPI("/host/storage/folders/add", values)
}
// announceHost announces the host, mines a block, and waits for the
// announcement to register.
func (st *serverTester) announceHost() error {
// Set the host to be accepting contracts.
acceptingContractsValues := url.Values{}
acceptingContractsValues.Set("acceptingcontracts", "true")
err := st.stdPostAPI("/host", acceptingContractsValues)
if err != nil {
return build.ExtendErr("couldn't make an api call to the host:", err)
}
announceValues := url.Values{}
announceValues.Set("address", string(st.host.ExternalSettings().NetAddress))
err = st.stdPostAPI("/host/announce", announceValues)
if err != nil {
return err
}
// mine block
_, err = st.miner.AddBlock()
if err != nil {
return err
}
// wait for announcement
var hosts HostdbActiveGET
err = st.getAPI("/hostdb/active", &hosts)
if err != nil {
return err
}
for i := 0; i < 50 && len(hosts.Hosts) == 0; i++ {
time.Sleep(100 * time.Millisecond)
err = st.getAPI("/hostdb/active", &hosts)
if err != nil {
return err
}
}
if len(hosts.Hosts) == 0 {
return errors.New("host announcement not seen")
}
return nil
}
// getAPI makes an API call and decodes the response.
func (st *serverTester) getAPI(call string, obj interface{}) error {
resp, err := HttpGET("http://" + st.server.listener.Addr().String() + call)
if err != nil {
return err
}
defer resp.Body.Close()
if non2xx(resp.StatusCode) {
return decodeError(resp)
}
// Return early because there is no content to decode.
if resp.StatusCode == http.StatusNoContent {
return nil
}
// Decode the response into 'obj'.
err = json.NewDecoder(resp.Body).Decode(obj)
if err != nil {
return err
}
return nil
}
// postAPI makes an API call and decodes the response.
func (st *serverTester) postAPI(call string, values url.Values, obj interface{}) error {
resp, err := HttpPOST("http://"+st.server.listener.Addr().String()+call, values.Encode())
if err != nil {
return err
}
defer resp.Body.Close()
if non2xx(resp.StatusCode) {
return decodeError(resp)
}
// Return early because there is no content to decode.
if resp.StatusCode == http.StatusNoContent {
return nil
}
// Decode the response into 'obj'.
err = json.NewDecoder(resp.Body).Decode(obj)
if err != nil {
return err
}
return nil
}
// stdGetAPI makes an API call and discards the response.
func (st *serverTester) stdGetAPI(call string) error {
resp, err := HttpGET("http://" + st.server.listener.Addr().String() + call)
if err != nil {
return err
}
defer resp.Body.Close()
if non2xx(resp.StatusCode) {
return decodeError(resp)
}
return nil
}
// stdGetAPIUA makes an API call with a custom user agent.
func (st *serverTester) stdGetAPIUA(call string, userAgent string) error {
req, err := http.NewRequest("GET", "http://"+st.server.listener.Addr().String()+call, nil)
if err != nil {
return err
}
req.Header.Set("User-Agent", userAgent)
resp, err := http.DefaultClient.Do(req)
if err != nil {
return err
}
defer resp.Body.Close()
if non2xx(resp.StatusCode) {
return decodeError(resp)
}
return nil
}
// stdPostAPI makes an API call and discards the response.
func (st *serverTester) stdPostAPI(call string, values url.Values) error {
resp, err := HttpPOST("http://"+st.server.listener.Addr().String()+call, values.Encode())
if err != nil {
return err
}
defer resp.Body.Close()
if non2xx(resp.StatusCode) {
return decodeError(resp)
}
return nil
}
|