agent-enviroments/builder/libs/seastar/tests/unit/sharded_test.cc

/*
 * This file is open source software, licensed to you under the terms
 * of the Apache License, Version 2.0 (the "License").  See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership.  You may not use this file except in compliance with the License.
 *
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
/*
 *  Copyright (C) 2018 Scylladb, Ltd.
 */

#include <seastar/testing/thread_test_case.hh>

#include <seastar/core/sharded.hh>

using namespace seastar;

namespace {
class invoke_on_during_stop final : public peering_sharded_service<invoke_on_during_stop> {
    bool flag = false;

public:
    future<> stop() {
        return container().invoke_on(0, [] (invoke_on_during_stop& instance) {
            instance.flag = true;
        });
    }

    ~invoke_on_during_stop() {
        if (this_shard_id() == 0) {
            assert(flag);
        }
    }
};
}

SEASTAR_THREAD_TEST_CASE(invoke_on_during_stop_test) {
    sharded<invoke_on_during_stop> s;
    s.start().get();
    s.stop().get();
}

class peering_counter : public peering_sharded_service<peering_counter> {
public:
    future<int> count() const {
        return container().map_reduce(adder<int>(), [] (auto& pc) { return 1; });
    }

    future<int> count_from(int base) const {
        return container().map_reduce0([] (auto& pc) { return 1; }, base, std::plus<int>());
    }

    future<int> count_from_const(int base) const {
        return container().map_reduce0(&peering_counter::get_1_c, base, std::plus<int>());
    }

    future<int> count_from_mutate(int base) {
        return container().map_reduce0(&peering_counter::get_1_m, base, std::plus<int>());
    }

    future<int> count_const() const {
        return container().map_reduce(adder<int>(), &peering_counter::get_1_c);
    }

    future<int> count_mutate() {
        return container().map_reduce(adder<int>(), &peering_counter::get_1_m);
    }

private:
    future<int> get_1_c() const {
        return make_ready_future<int>(1);
    }

    future<int> get_1_m() {
        return make_ready_future<int>(1);
    }
};

SEASTAR_THREAD_TEST_CASE(test_const_map_reduces) {
    sharded<peering_counter> c;
    c.start().get();

    BOOST_REQUIRE_EQUAL(c.local().count().get(), smp::count);
    BOOST_REQUIRE_EQUAL(c.local().count_from(1).get(), smp::count + 1);

    c.stop().get();
}

SEASTAR_THREAD_TEST_CASE(test_member_map_reduces) {
    sharded<peering_counter> c;
    c.start().get();

    BOOST_REQUIRE_EQUAL(std::as_const(c.local()).count_const().get(), smp::count);
    BOOST_REQUIRE_EQUAL(c.local().count_mutate().get(), smp::count);
    BOOST_REQUIRE_EQUAL(std::as_const(c.local()).count_from_const(1).get(), smp::count + 1);
    BOOST_REQUIRE_EQUAL(c.local().count_from_mutate(1).get(), smp::count + 1);
    c.stop().get();
}

class mydata {
public:
    int x = 1;
    future<> stop() {
        return make_ready_future<>();
    }
};

SEASTAR_THREAD_TEST_CASE(invoke_map_returns_non_future_value) {
    seastar::sharded<mydata> s;
    s.start().get();
    s.map([] (mydata& m) {
        return m.x;
    }).then([] (std::vector<int> results) {
        for (auto& x : results) {
            assert(x == 1);
        }
    }).get();
    s.stop().get();
};

SEASTAR_THREAD_TEST_CASE(invoke_map_returns_future_value) {
    seastar::sharded<mydata> s;
    s.start().get();
    s.map([] (mydata& m) {
        return make_ready_future<int>(m.x);
    }).then([] (std::vector<int> results) {
        for (auto& x : results) {
            assert(x == 1);
        }
    }).get();
    s.stop().get();
}

SEASTAR_THREAD_TEST_CASE(invoke_map_returns_future_value_from_thread) {
    seastar::sharded<mydata> s;
    s.start().get();
    s.map([] (mydata& m) {
        return seastar::async([&m] {
            return m.x;
        });
    }).then([] (std::vector<int> results) {
        for (auto& x : results) {
            assert(x == 1);
        }
    }).get();
    s.stop().get();
}

SEASTAR_THREAD_TEST_CASE(failed_sharded_start_doesnt_hang) {
    class fail_to_start {
    public:
        fail_to_start() { throw 0; }
    };

    seastar::sharded<fail_to_start> s;
    s.start().then_wrapped([] (auto&& fut) { fut.ignore_ready_future(); }).get();
}

class argument {
    int _x;
public:
    argument() : _x(this_shard_id()) {}
    int get() const { return _x; }
};

class service {
public:
    void fn_local(argument& arg) {
        BOOST_REQUIRE_EQUAL(arg.get(), this_shard_id());
    }

    void fn_sharded(sharded<argument>& arg) {
        BOOST_REQUIRE_EQUAL(arg.local().get(), this_shard_id());
    }

    void fn_sharded_param(int arg) {
        BOOST_REQUIRE_EQUAL(arg, this_shard_id());
    }
};

SEASTAR_THREAD_TEST_CASE(invoke_on_all_sharded_arg) {
    seastar::sharded<service> srv;
    srv.start().get();
    seastar::sharded<argument> arg;
    arg.start().get();

    srv.invoke_on_all(&service::fn_local, std::ref(arg)).get();
    srv.invoke_on_all(&service::fn_sharded, std::ref(arg)).get();
    srv.invoke_on_all(&service::fn_sharded_param, sharded_parameter([&arg] { return arg.local().get(); })).get();

    srv.stop().get();
    arg.stop().get();
}

SEASTAR_THREAD_TEST_CASE(invoke_on_modifiers) {
    class checker {
    public:
        future<> fn(int a) {
            return make_ready_future<>();
        }
    };

    seastar::sharded<checker> srv;
    srv.start().get();
    int a = 42;

    srv.invoke_on_all([a] (checker& s) { return s.fn(a); }).get();
    srv.invoke_on_all([a] (checker& s) mutable { return s.fn(a); }).get();
    srv.invoke_on_others([a] (checker& s) { return s.fn(a); }).get();
    srv.invoke_on_others([a] (checker& s) mutable { return s.fn(a); }).get();

    srv.stop().get();
}