File: test_xhelper.cpp

package info (click to toggle)
xeus 6.0.2-2
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 9,780 kB
  • sloc: cpp: 7,646; makefile: 157; python: 25
file content (204 lines) | stat: -rw-r--r-- 7,877 bytes parent folder | download
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
/***************************************************************************
* Copyright (c) 2016, Johan Mabille, Sylvain Corlay, Martin Renou          *
* Copyright (c) 2016, QuantStack                                           *
*                                                                          *
* Distributed under the terms of the BSD 3-Clause License.                 *
*                                                                          *
* The full license is in the file LICENSE, distributed with this software. *
****************************************************************************/

#include "doctest/doctest.h"

#include <string>
#include <vector>

#include "nlohmann/json.hpp"

#include "xeus/xhelper.hpp"
#include "xeus/xkernel_configuration.hpp"

namespace nl = nlohmann;

namespace xeus
{
    TEST_SUITE("xhelper")
    {
        TEST_CASE("get_start_message")
        {
            xkernel_configuration config;
            config.m_transport = "tcp";
            config.m_ip = "127.0.0.1";
            config.m_control_port = "50160";
            config.m_shell_port = "57503";
            config.m_stdin_port = "52597";
            config.m_iopub_port = "43072";
            config.m_hb_port = "50931";
            config.m_signature_scheme = "hmac-sha256";
            config.m_key = "a0436f6c-1916-498b-8eb9-e81ab9368e84";

            std::string msg = get_start_message(config);

            REQUIRE(msg.find("tcp") != std::string::npos);
            REQUIRE(msg.find("127.0.0.1") != std::string::npos);
            REQUIRE(msg.find("50160") != std::string::npos);
            REQUIRE(msg.find("57503") != std::string::npos);
            REQUIRE(msg.find("52597") != std::string::npos);
            REQUIRE(msg.find("43072") != std::string::npos);
            REQUIRE(msg.find("50931") != std::string::npos);
            REQUIRE(msg.find("hmac-sha256") != std::string::npos);
            REQUIRE(msg.find("a0436f6c-1916-498b-8eb9-e81ab9368e84") != std::string::npos);
        }

        TEST_CASE("extract_filename")
        {
            int argc = 3;
            char arg0[] = "program";
            char arg1[] = "-f";
            char arg2[] = "kernel.json";
            char* argv[] = { arg0, arg1, arg2 };

            std::string filename = extract_filename(argc, argv);

            REQUIRE_EQ(filename, "kernel.json");
            REQUIRE_EQ(argc, 1);
        }

        TEST_CASE("should_print_version")
        {
            char arg0[] = "program";
            char arg1[] = "--version";
            char* argv[] = { arg0, arg1 };

            REQUIRE_EQ(should_print_version(2, argv), true);

            char arg2[] = "--help";
            char* argv2[] = { arg0, arg2 };

            REQUIRE_EQ(should_print_version(2, argv2), false);
        }

        TEST_CASE("create_error_reply")
        {
            std::string ename = "RuntimeError";
            std::string evalue = "something went wrong";
            nl::json traceback = nl::json::array({"line 1", "line 2"});

            nl::json res = create_error_reply(ename, evalue, traceback);

            REQUIRE_EQ(res["status"], "error");
            REQUIRE_EQ(res["ename"], ename);
            REQUIRE_EQ(res["evalue"], evalue);
            REQUIRE_EQ(res["traceback"], traceback);
        }

        TEST_CASE("create_successful_reply")
        {
            nl::json payload = nl::json::array();
            payload.push_back({{"source", "page"}, {"start", 0}});
            nl::json user_expressions = {{"x", "42"}};

            nl::json res = create_successful_reply(payload, user_expressions);

            REQUIRE_EQ(res["status"], "ok");
            REQUIRE_EQ(res["payload"], payload);
            REQUIRE_EQ(res["user_expressions"], user_expressions);
        }

        TEST_CASE("create_complete_reply")
        {
            nl::json matches = nl::json::array({"foo", "foobar"});
            int cursor_start = 2;
            int cursor_end = 5;
            nl::json metadata = {{"_jupyter_types_experimental", true}};

            nl::json res = create_complete_reply(matches, cursor_start, cursor_end, metadata);

            REQUIRE_EQ(res["status"], "ok");
            REQUIRE_EQ(res["matches"], matches);
            REQUIRE_EQ(res["cursor_start"], cursor_start);
            REQUIRE_EQ(res["cursor_end"], cursor_end);
            REQUIRE_EQ(res["metadata"], metadata);
        }

        TEST_CASE("create_inspect_reply")
        {
            bool found = true;
            nl::json data = {{"text/plain", "int x = 42;"}};
            nl::json metadata = {{"text/plain", ""}};

            nl::json res = create_inspect_reply(found, data, metadata);

            REQUIRE_EQ(res["status"], "ok");
            REQUIRE_EQ(res["found"], found);
            REQUIRE_EQ(res["data"], data);
            REQUIRE_EQ(res["metadata"], metadata);
        }

        TEST_CASE("create_is_complete_reply")
        {
            std::string status = "incomplete";
            std::string indent = "    ";

            nl::json res = create_is_complete_reply(status, indent);

            REQUIRE_EQ(res["status"], status);
            REQUIRE_EQ(res["indent"], indent);
        }

        TEST_CASE("create_info_reply")
        {
            std::string implementation = "my_kernel";
            std::string implementation_version = "2.0.0";
            std::string language_name = "python";
            std::string language_version = "3.11.0";
            std::string language_mimetype = "text/x-python";
            std::string language_file_extension = ".py";
            std::string pygments_lexer = "python3";
            std::string codemirror_mode = "python";
            std::string nbconvert_exporter = "python";
            std::string banner = "Welcome to my_kernel!";
            nl::json help_links = nl::json::array({{{"text", "Help"}, {"url", "https://example.com"}}});
            std::vector<std::string> supported_features = {"kernel_interrupt"};

            nl::json res = create_info_reply(
                implementation, implementation_version,
                language_name, language_version,
                language_mimetype, language_file_extension,
                pygments_lexer, codemirror_mode,
                nbconvert_exporter, banner,
                help_links, supported_features
            );

            REQUIRE_EQ(res["status"], "ok");
            REQUIRE_EQ(res["implementation"], implementation);
            REQUIRE_EQ(res["implementation_version"], implementation_version);
            REQUIRE_EQ(res["language_info"]["name"], language_name);
            REQUIRE_EQ(res["language_info"]["version"], language_version);
            REQUIRE_EQ(res["language_info"]["mimetype"], language_mimetype);
            REQUIRE_EQ(res["language_info"]["file_extension"], language_file_extension);
            REQUIRE_EQ(res["language_info"]["pygments_lexer"], pygments_lexer);
            REQUIRE_EQ(res["language_info"]["codemirror_mode"], codemirror_mode);
            REQUIRE_EQ(res["language_info"]["nbconvert_exporter"], nbconvert_exporter);
            REQUIRE_EQ(res["banner"], banner);
            REQUIRE_EQ(res["help_links"], help_links);
            REQUIRE_EQ(res["supported_features"], supported_features);
        }

        TEST_CASE("create_shutdown_reply")
        {
            nl::json res_restart = create_shutdown_reply(true);
            REQUIRE_EQ(res_restart["status"], "ok");
            REQUIRE_EQ(res_restart["restart"], true);

            nl::json res_no_restart = create_shutdown_reply(false);
            REQUIRE_EQ(res_no_restart["status"], "ok");
            REQUIRE_EQ(res_no_restart["restart"], false);
        }

        TEST_CASE("create_interrupt_reply")
        {
            nl::json res = create_interrupt_reply();
            REQUIRE_EQ(res["status"], "ok");
        }
    }
}