forked from sorbet/sorbet
-
Notifications
You must be signed in to change notification settings - Fork 5
/
pipeline_test_runner.cc
920 lines (782 loc) · 38.8 KB
/
pipeline_test_runner.cc
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
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
#include "doctest/doctest.h"
#include <cxxopts.hpp>
// has to go first as it violates our requirements
// has to go first, as it violates poisons
#include "core/proto/proto.h"
#include "absl/strings/match.h"
#include "absl/strings/str_split.h"
#include "ast/ast.h"
#include "ast/desugar/Desugar.h"
#include "ast/treemap/treemap.h"
#include "cfg/CFG.h"
#include "cfg/builder/builder.h"
#include "class_flatten/class_flatten.h"
#include "common/FileOps.h"
#include "common/common.h"
#include "common/sort/sort.h"
#include "common/strings/formatting.h"
#include "common/web_tracer_framework/tracing.h"
#include "core/Error.h"
#include "core/ErrorCollector.h"
#include "core/ErrorQueue.h"
#include "core/Unfreeze.h"
#include "core/errors/namer.h"
#include "core/errors/resolver.h"
#include "core/serialize/serialize.h"
#include "definition_validator/validator.h"
#include "infer/infer.h"
#include "local_vars/local_vars.h"
#include "main/autogen/autogen.h"
#include "main/autogen/crc_builder.h"
#include "main/autogen/data/definitions.h"
#include "main/autogen/data/version.h"
#include "main/minimize/minimize.h"
#include "main/pipeline/pipeline.h"
#include "namer/namer.h"
#include "packager/packager.h"
#include "packager/rbi_gen.h"
#include "parser/parser.h"
#include "payload/binary/binary.h"
#include "resolver/resolver.h"
#include "rewriter/rewriter.h"
#include "spdlog/sinks/stdout_color_sinks.h"
#include "spdlog/spdlog.h"
#include "test/helpers/expectations.h"
#include "test/helpers/position_assertions.h"
#include <algorithm>
#include <cstdio>
#include <fstream>
#include <memory>
#include <regex>
#include <sstream>
#include <string>
#include <sys/types.h>
#include <vector>
namespace sorbet::test {
using namespace std;
string singleTest;
realmain::options::Parser parser;
constexpr string_view whitelistedTypedNoneTest = "missing_typed_sigil.rb"sv;
constexpr string_view packageFileName = "__package.rb"sv;
class CFGCollectorAndTyper {
public:
vector<unique_ptr<cfg::CFG>> cfgs;
void preTransformMethodDef(core::Context ctx, ast::ExpressionPtr &tree) {
auto &m = ast::cast_tree_nonnull<ast::MethodDef>(tree);
if (!infer::Inference::willRun(ctx, m.declLoc, m.symbol)) {
return;
}
auto cfg = cfg::CFGBuilder::buildFor(ctx.withOwner(m.symbol), m);
auto symbol = cfg->symbol;
cfg = infer::Inference::run(ctx.withOwner(symbol), move(cfg));
if (cfg) {
for (auto &extension : ctx.state.semanticExtensions) {
extension->typecheck(ctx, ctx.file, *cfg, m);
}
}
cfgs.push_back(move(cfg));
}
};
UnorderedSet<string> knownExpectations = {"parse-tree",
"parse-tree-json",
"parse-tree-json-with-locs",
"parse-tree-whitequark",
"desugar-tree",
"desugar-tree-raw",
"rewrite-tree",
"rewrite-tree-raw",
"index-tree",
"index-tree-raw",
"symbol-table",
"symbol-table-raw",
"name-tree",
"name-tree-raw",
"resolve-tree",
"resolve-tree-raw",
"flatten-tree",
"flatten-tree-raw",
"cfg",
"cfg-raw",
"cfg-text",
"autogen",
"document-symbols",
"package-tree",
"document-formatting-rubyfmt",
"autocorrects",
"minimized-rbi",
"rbi-gen"};
ast::ParsedFile testSerialize(core::GlobalState &gs, ast::ParsedFile expr) {
auto &savedFile = expr.file.data(gs);
auto saved = core::serialize::Serializer::storeTree(savedFile, expr);
auto restored = core::serialize::Serializer::loadTree(gs, savedFile, saved.data());
return {move(restored), expr.file};
}
/** Converts a Sorbet Error object into an equivalent LSP Diagnostic object. */
unique_ptr<Diagnostic> errorToDiagnostic(const core::GlobalState &gs, const core::Error &error) {
if (!error.loc.exists()) {
return nullptr;
}
return make_unique<Diagnostic>(Range::fromLoc(gs, error.loc), error.header);
}
class ExpectationHandler {
Expectations &test;
shared_ptr<core::ErrorQueue> &errorQueue;
shared_ptr<core::ErrorCollector> &errorCollector;
public:
vector<unique_ptr<core::Error>> errors;
UnorderedMap<string_view, string> got;
ExpectationHandler(Expectations &test, shared_ptr<core::ErrorQueue> &errorQueue,
shared_ptr<core::ErrorCollector> &errorCollector)
: test(test), errorQueue(errorQueue), errorCollector(errorCollector){};
void addObserved(const core::GlobalState &gs, string_view expectationType, std::function<string()> mkExp,
bool addNewline = true) {
if (test.expectations.contains(expectationType)) {
got[expectationType].append(mkExp());
if (addNewline) {
got[expectationType].append("\n");
}
drainErrors(gs);
}
}
void checkExpectations(string prefix = "") const {
for (const auto &gotPhase : got) {
auto expectation = test.expectations.find(gotPhase.first);
REQUIRE_MESSAGE(expectation != test.expectations.end(),
prefix << "missing expectation for " << gotPhase.first);
REQUIRE_MESSAGE(expectation->second.size() == 1,
prefix << "found unexpected multiple expectations of type " << gotPhase.first);
auto checker = test.folder + expectation->second.begin()->second;
auto expect = FileOps::read(checker);
CHECK_EQ_DIFF(expect, gotPhase.second,
fmt::format("{}Mismatch on: {}\n"
"\n"
"If these changes are expected, run this script and commit the results:\n"
"tools/scripts/update_testdata_exp.sh\n",
prefix, checker));
if (expect == gotPhase.second) {
MESSAGE(gotPhase.first << " OK");
}
}
}
void drainErrors(const core::GlobalState &gs) {
// Moves errors from being owned by GlobalState to having been flushed by the flusher
// In our case, errorCollector is our error flusher (accumulates a vector, instead of
// printing to stdout).
errorQueue->flushAllErrors(gs);
// Retrieves the collected errors, and sets it to empty again
auto newErrors = errorCollector->drainErrors();
// Stores them in ourself, for use with ErrorAssertion::checkAll at a later point.
errors.insert(errors.end(), make_move_iterator(newErrors.begin()), make_move_iterator(newErrors.end()));
}
void dropErrors(const core::GlobalState &gs) {
// Moves errors from being owned by GlobalState to having been flushed by the flusher
// In our case, errorCollector is our error flusher (accumulates a vector, instead of
// printing to stdout).
errorQueue->flushAllErrors(gs);
// Retrieves the collected errors, sets it to empty again, and then drops those errors.
auto _newErrors = errorCollector->drainErrors();
}
void clear(const core::GlobalState &gs) {
got.clear();
errorQueue->flushAllErrors(gs);
auto _newErrors = errorCollector->drainErrors();
}
};
vector<ast::ParsedFile> index(unique_ptr<core::GlobalState> &gs, absl::Span<core::FileRef> files,
ExpectationHandler &handler, Expectations &test) {
vector<ast::ParsedFile> trees;
for (auto file : files) {
auto fileName = FileOps::getFileName(file.data(*gs).path());
if (fileName != whitelistedTypedNoneTest && (fileName != packageFileName || !file.data(*gs).source().empty()) &&
file.data(*gs).source().find("# typed:") == string::npos) {
ADD_FAIL_CHECK_AT(file.data(*gs).path().data(), 1, "Add a `# typed: strict` line to the top of this file");
}
// if a file is typed: ignore, then we shouldn't try to parse
// it or do anything with it at all
if (file.data(*gs).strictLevel == core::StrictLevel::Ignore) {
ast::ParsedFile pf{ast::make_expression<ast::EmptyTree>(), file};
trees.emplace_back(move(pf));
continue;
}
unique_ptr<parser::Node> nodes;
if (parser == realmain::options::Parser::SORBET) {
std::cout << "Parsing with sorbet" << std::endl;
core::UnfreezeNameTable nameTableAccess(*gs); // enters original strings
auto settings = parser::Parser::Settings{};
nodes = parser::Parser::run(*gs, file, settings);
} else if (parser == realmain::options::Parser::PRISM) {
std::cout << "Parsing with prism" << std::endl;
nodes = realmain::pipeline::runPrismParser(*gs, file, false, {});
}
handler.drainErrors(*gs);
handler.addObserved(*gs, "parse-tree", [&]() { return nodes->toString(*gs); });
handler.addObserved(*gs, "parse-tree-whitequark", [&]() { return nodes->toWhitequark(*gs); });
handler.addObserved(*gs, "parse-tree-json", [&]() { return nodes->toJSON(*gs); });
handler.addObserved(*gs, "parse-tree-json-with-locs", [&]() { return nodes->toJSONWithLocs(*gs, file); });
// Desugarer
ast::ParsedFile desugared;
{
core::UnfreezeNameTable nameTableAccess(*gs); // enters original strings
core::MutableContext ctx(*gs, core::Symbols::root(), file);
desugared = testSerialize(*gs, ast::ParsedFile{ast::desugar::node2Tree(ctx, move(nodes)), file});
}
handler.addObserved(*gs, "desugar-tree", [&]() { return desugared.tree.toString(*gs); });
handler.addObserved(*gs, "desugar-tree-raw", [&]() { return desugared.tree.showRaw(*gs); });
ast::ParsedFile localNamed;
// Rewriter
ast::ParsedFile rewritten;
{
core::UnfreezeNameTable nameTableAccess(*gs); // enters original strings
core::MutableContext ctx(*gs, core::Symbols::root(), desugared.file);
bool previous = gs->runningUnderAutogen;
gs->runningUnderAutogen = test.expectations.contains("autogen");
rewritten =
testSerialize(*gs, ast::ParsedFile{rewriter::Rewriter::run(ctx, move(desugared.tree)), desugared.file});
gs->runningUnderAutogen = previous;
}
handler.addObserved(*gs, "rewrite-tree", [&]() { return rewritten.tree.toString(*gs); });
handler.addObserved(*gs, "rewrite-tree-raw", [&]() { return rewritten.tree.showRaw(*gs); });
core::MutableContext ctx(*gs, core::Symbols::root(), desugared.file);
localNamed = testSerialize(*gs, local_vars::LocalVars::run(ctx, move(rewritten)));
handler.addObserved(*gs, "index-tree", [&]() { return localNamed.tree.toString(*gs); });
handler.addObserved(*gs, "index-tree-raw", [&]() { return localNamed.tree.showRaw(*gs); });
trees.emplace_back(move(localNamed));
}
return trees;
}
void setupPackager(unique_ptr<core::GlobalState> &gs, vector<shared_ptr<RangeAssertion>> &assertions) {
vector<std::string> extraPackageFilesDirectoryUnderscorePrefixes;
vector<std::string> extraPackageFilesDirectorySlashDeprecatedPrefixes;
vector<std::string> extraPackageFilesDirectorySlashPrefixes;
vector<std::string> skipRBIExportEnforcementDirs;
vector<std::string> allowRelaxedPackagerChecksFor;
auto extraDirUnderscore =
StringPropertyAssertion::getValue("extra-package-files-directory-prefix-underscore", assertions);
if (extraDirUnderscore.has_value()) {
extraPackageFilesDirectoryUnderscorePrefixes.emplace_back(extraDirUnderscore.value());
}
auto extraDirSlashDeprecated =
StringPropertyAssertion::getValue("extra-package-files-directory-prefix-slash-deprecated", assertions);
if (extraDirSlashDeprecated.has_value()) {
extraPackageFilesDirectorySlashDeprecatedPrefixes.emplace_back(extraDirSlashDeprecated.value());
}
auto extraDirSlash = StringPropertyAssertion::getValue("extra-package-files-directory-prefix-slash", assertions);
if (extraDirSlash.has_value()) {
extraPackageFilesDirectorySlashPrefixes.emplace_back(extraDirSlash.value());
}
auto allowRelaxedPackager = StringPropertyAssertion::getValue("allow-relaxed-packager-checks-for", assertions);
if (allowRelaxedPackager.has_value()) {
allowRelaxedPackagerChecksFor.emplace_back(allowRelaxedPackager.value());
}
{
core::UnfreezeNameTable packageNS(*gs);
core::packages::UnfreezePackages unfreezeToEnterPackagerOptionsPackageDB = gs->unfreezePackages();
gs->setPackagerOptions(
extraPackageFilesDirectoryUnderscorePrefixes, extraPackageFilesDirectorySlashDeprecatedPrefixes,
extraPackageFilesDirectorySlashPrefixes, {}, allowRelaxedPackagerChecksFor, "PACKAGE_ERROR_HINT");
}
}
void package(unique_ptr<core::GlobalState> &gs, unique_ptr<WorkerPool> &workers, absl::Span<ast::ParsedFile> trees,
ExpectationHandler &handler, vector<shared_ptr<RangeAssertion>> &assertions) {
auto enablePackager = BooleanPropertyAssertion::getValue("enable-packager", assertions).value_or(false);
if (!enablePackager) {
return;
}
// Packager runs over all trees.
packager::Packager::run(*gs, *workers, trees);
for (auto &tree : trees) {
handler.addObserved(*gs, "package-tree", [&]() {
return fmt::format("# -- {} --\n{}", tree.file.data(*gs).path(), tree.tree.toString(*gs));
});
}
}
void name(core::GlobalState &gs, absl::Span<ast::ParsedFile> trees, WorkerPool &workers) {
core::UnfreezeNameTable nameTableAccess(gs); // creates singletons and class names
core::UnfreezeSymbolTable symbolTableAccess(gs); // enters symbols
auto foundHashes = nullptr;
auto canceled = namer::Namer::run(gs, trees, workers, foundHashes);
ENFORCE(!canceled);
}
TEST_CASE("PerPhaseTest") { // NOLINT
Expectations test = Expectations::getExpectations(singleTest);
auto inputPath = test.folder + test.basename;
auto rbName = test.basename + ".rb";
for (auto &exp : test.expectations) {
if (!knownExpectations.contains(exp.first)) {
FAIL_CHECK("Unknown pass: " << exp.first);
}
}
auto logger = spdlog::stderr_color_mt("fixtures: " + inputPath);
auto errorCollector = make_shared<core::ErrorCollector>();
auto errorQueue = make_shared<core::ErrorQueue>(*logger, *logger, errorCollector);
auto gs = make_unique<core::GlobalState>(errorQueue);
for (auto provider : sorbet::pipeline::semantic_extension::SemanticExtensionProvider::getProviders()) {
gs->semanticExtensions.emplace_back(provider->defaultInstance());
}
gs->censorForSnapshotTests = true;
auto workers = WorkerPool::create(0, gs->tracer());
auto assertions = RangeAssertion::parseAssertions(test.sourceFileContents);
gs->requiresAncestorEnabled =
BooleanPropertyAssertion::getValue("enable-experimental-requires-ancestor", assertions).value_or(false);
gs->ruby3KeywordArgs =
BooleanPropertyAssertion::getValue("experimental-ruby3-keyword-args", assertions).value_or(false);
gs->typedSuper = BooleanPropertyAssertion::getValue("typed-super", assertions).value_or(true);
// TODO(jez) Allow allow suppressPayloadSuperclassRedefinitionFor in a testdata test assertion?
if (!BooleanPropertyAssertion::getValue("uniquely-defined-behavior", assertions).value_or(false)) {
gs->suppressErrorClass(core::errors::Namer::MultipleBehaviorDefs.code);
}
if (!BooleanPropertyAssertion::getValue("check-out-of-order-constant-references", assertions).value_or(false)) {
gs->suppressErrorClass(core::errors::Resolver::OutOfOrderConstantAccess.code);
}
if (BooleanPropertyAssertion::getValue("no-stdlib", assertions).value_or(false)) {
gs->initEmpty();
} else {
core::serialize::Serializer::loadGlobalState(*gs, getNameTablePayload);
}
if (BooleanPropertyAssertion::getValue("enable-suggest-unsafe", assertions).value_or(false)) {
gs->suggestUnsafe = "T.unsafe";
}
unique_ptr<core::GlobalState> emptyGs;
if (!test.minimizeRBI.empty() || test.expectations.contains("rbi-gen")) {
// Copy GlobalState after initializing it, but before rest of pipeline, so that it
// represents an "empty" GlobalState.
emptyGs = gs->deepCopy();
}
// Read files
vector<core::FileRef> files;
{
core::UnfreezeFileTable fileTableAccess(*gs);
for (auto &sourceFile : test.sourceFiles) {
auto fref = gs->enterFile(test.sourceFileContents[test.folder + sourceFile]);
if (FileOps::getFileName(sourceFile) == whitelistedTypedNoneTest) {
fref.data(*gs).strictLevel = core::StrictLevel::False;
}
if (FileOps::getFileName(sourceFile) == packageFileName && fref.data(*gs).source().empty()) {
fref.data(*gs).strictLevel = core::StrictLevel::False;
}
files.emplace_back(fref);
}
}
ExpectationHandler handler(test, errorQueue, errorCollector);
auto enablePackager = BooleanPropertyAssertion::getValue("enable-packager", assertions).value_or(false);
vector<ast::ParsedFile> trees;
auto filesSpan = absl::Span<core::FileRef>(files);
if (enablePackager) {
setupPackager(gs, assertions);
auto numPackageFiles = realmain::pipeline::partitionPackageFiles(*gs, filesSpan);
auto inputPackageFiles = filesSpan.first(numPackageFiles);
filesSpan = filesSpan.subspan(numPackageFiles);
trees = index(gs, inputPackageFiles, handler, test);
// First run: only the __package.rb files. This populates the packageDB
package(gs, workers, absl::Span<ast::ParsedFile>(trees), handler, assertions);
name(*gs, absl::Span<ast::ParsedFile>(trees), *workers);
}
auto nonPackageTrees = index(gs, filesSpan, handler, test);
package(gs, workers, absl::Span<ast::ParsedFile>(nonPackageTrees), handler, assertions);
name(*gs, absl::Span<ast::ParsedFile>(nonPackageTrees), *workers);
realmain::pipeline::unpartitionPackageFiles(trees, move(nonPackageTrees));
if (enablePackager) {
if (test.expectations.contains("rbi-gen")) {
auto rbiGenGs = emptyGs->deepCopy();
rbiGenGs->errorQueue = make_shared<core::ErrorQueue>(*logger, *logger, errorCollector);
// If there is a rbi-gen exp file, we need to retypecheck the files w/o packager mode and run RBI
// generation for every package.
vector<core::FileRef> files;
{
core::UnfreezeFileTable fileTableAccess(*rbiGenGs);
for (auto &sourceFile : test.sourceFiles) {
auto fref = rbiGenGs->enterFile(test.sourceFileContents[test.folder + sourceFile]);
files.emplace_back(fref);
}
}
vector<ast::ParsedFile> trees;
vector<ast::ParsedFile> packageTrees;
// Index
for (auto file : files) {
core::UnfreezeNameTable nameTableAccess(*rbiGenGs); // enters original strings
auto settings = parser::Parser::Settings{};
auto nodes = parser::Parser::run(*rbiGenGs, file, settings);
core::MutableContext ctx(*rbiGenGs, core::Symbols::root(), file);
auto tree = ast::ParsedFile{ast::desugar::node2Tree(ctx, move(nodes)), file};
tree = ast::ParsedFile{rewriter::Rewriter::run(ctx, move(tree.tree)), tree.file};
tree = testSerialize(*rbiGenGs, local_vars::LocalVars::run(ctx, move(tree)));
if (tree.file.data(*rbiGenGs).isPackage()) {
packageTrees.emplace_back(move(tree));
} else {
trees.emplace_back(move(tree));
}
}
// Initialize the package DB
packager::Packager::findPackages(*rbiGenGs, absl::Span<ast::ParsedFile>(packageTrees));
packager::Packager::setPackageNameOnFiles(*rbiGenGs, packageTrees);
packager::Packager::setPackageNameOnFiles(*rbiGenGs, trees);
// Namer
{
core::UnfreezeNameTable nameTableAccess(*rbiGenGs); // creates singletons and class names
core::UnfreezeSymbolTable symbolTableAccess(*rbiGenGs); // enters symbols
auto foundHashes = nullptr;
auto canceled = namer::Namer::run(*rbiGenGs, absl::Span<ast::ParsedFile>(trees), *workers, foundHashes);
ENFORCE(!canceled);
}
// Resolver
{
core::UnfreezeNameTable nameTableAccess(*rbiGenGs); // Resolver::defineAttr
core::UnfreezeSymbolTable symbolTableAccess(*rbiGenGs); // enters stubs
trees = move(resolver::Resolver::run(*rbiGenGs, move(trees), *workers).result());
}
// RBI generation
{
auto packageNamespaces = packager::RBIGenerator::buildPackageNamespace(*rbiGenGs, *workers);
for (auto &package : rbiGenGs->packageDB().packages()) {
auto output = packager::RBIGenerator::runOnce(*rbiGenGs, package, packageNamespaces);
if (!output.rbi.empty()) {
handler.addObserved(*rbiGenGs, "rbi-gen", [&]() {
return absl::StrCat("# ", test.folder, output.baseFilePath, ".rbi\n", output.rbi);
});
}
if (!output.testRBI.empty()) {
handler.addObserved(*rbiGenGs, "rbi-gen", [&]() {
return absl::StrCat("# ", test.folder, output.baseFilePath, ".test.rbi\n", output.testRBI);
});
}
}
}
}
}
for (auto &tree : trees) {
// Namer
auto namedTree = testSerialize(*gs, move(tree));
handler.addObserved(*gs, "name-tree", [&]() { return namedTree.tree.toString(*gs); });
handler.addObserved(*gs, "name-tree-raw", [&]() { return namedTree.tree.showRaw(*gs); });
tree = move(namedTree);
}
if (test.expectations.contains("autogen")) {
{
core::UnfreezeNameTable nameTableAccess(*gs);
core::UnfreezeSymbolTable symbolAccess(*gs);
trees = resolver::Resolver::runConstantResolution(*gs, move(trees), *workers);
}
handler.addObserved(
*gs, "autogen",
[&]() {
stringstream payload;
auto crcBuilder = autogen::CRCBuilder::create();
for (auto &tree : trees) {
core::Context ctx(*gs, core::Symbols::root(), tree.file);
auto pf = autogen::Autogen::generate(ctx, move(tree), autogen::AutogenConfig{{}}, *crcBuilder);
tree = move(pf.tree);
payload << pf.toString(ctx, autogen::AutogenVersion::MAX_VERSION);
}
return payload.str();
},
false);
handler.checkExpectations();
// Autogen forces you to to put --stop-after=namer so lets not run
// anything else
return;
} else {
core::UnfreezeNameTable nameTableAccess(*gs); // Resolver::defineAttr
core::UnfreezeSymbolTable symbolTableAccess(*gs); // enters stubs
trees = move(resolver::Resolver::run(*gs, move(trees), *workers).result());
if (enablePackager) {
trees = packager::VisibilityChecker::run(*gs, *workers, move(trees));
}
handler.drainErrors(*gs);
}
handler.addObserved(*gs, "symbol-table", [&]() { return gs->toString(); });
handler.addObserved(*gs, "symbol-table-raw", [&]() { return gs->showRaw(); });
for (auto &resolvedTree : trees) {
handler.addObserved(*gs, "resolve-tree", [&]() { return resolvedTree.tree.toString(*gs); });
handler.addObserved(*gs, "resolve-tree-raw", [&]() { return resolvedTree.tree.showRaw(*gs); });
}
if (!test.minimizeRBI.empty()) {
auto gsForMinimize = emptyGs->deepCopy();
auto opts = realmain::options::Options{};
auto minimizeRBI = test.folder + test.minimizeRBI;
realmain::Minimize::indexAndResolveForMinimize(gs, gsForMinimize, opts, *workers, minimizeRBI);
auto printerConfig = realmain::options::PrinterConfig{};
printerConfig.enabled = true;
printerConfig.outputPath = "/dev/null"; // tricks PrinterConfig::print into buffering
printerConfig.supportsFlush = true;
realmain::Minimize::writeDiff(*gs, *gsForMinimize, printerConfig);
auto addNewline = false;
handler.addObserved(
*gs, "minimized-rbi", [&]() { return printerConfig.flushToString(); }, addNewline);
}
// Simulate what pipeline.cc does: We want to start typeckecking big files first because it helps with better work
// distribution
fast_sort(trees, [&](const auto &lhs, const auto &rhs) -> bool {
return lhs.file.data(*gs).source().size() > rhs.file.data(*gs).source().size();
});
for (auto &resolvedTree : trees) {
auto file = resolvedTree.file;
core::Context ctx(*gs, core::Symbols::root(), file);
resolvedTree = class_flatten::runOne(ctx, move(resolvedTree));
resolvedTree = definition_validator::runOne(ctx, move(resolvedTree));
handler.drainErrors(*gs);
handler.addObserved(*gs, "flatten-tree", [&]() { return resolvedTree.tree.toString(*gs); });
handler.addObserved(*gs, "flatten-tree-raw", [&]() { return resolvedTree.tree.showRaw(*gs); });
// Don't run typecheck on RBI files.
if (resolvedTree.file.data(ctx).isRBI()) {
continue;
}
auto checkTree = [&]() {
if (resolvedTree.tree == nullptr) {
auto path = file.data(*gs).path();
ADD_FAIL_CHECK_AT(path.begin(), 1, "Already used tree. You can only have 1 CFG-ish .exp file");
}
};
auto checkPragma = [&](string ext) {
if (file.data(*gs).strictLevel < core::StrictLevel::True) {
auto path = file.data(*gs).path();
ADD_FAIL_CHECK_AT(path.begin(), 1,
"Missing `# typed:` pragma. Sources with ." << ext
<< ".exp files must specify # typed:");
}
};
// CFG
if (test.expectations.contains("cfg") || test.expectations.contains("cfg-raw") ||
test.expectations.contains("cfg-text")) {
checkTree();
checkPragma("cfg");
CFGCollectorAndTyper collector;
core::Context ctx(*gs, core::Symbols::root(), resolvedTree.file);
ast::ShallowWalk::apply(ctx, collector, resolvedTree.tree);
for (auto &extension : ctx.state.semanticExtensions) {
extension->finishTypecheckFile(ctx, file);
}
resolvedTree.tree.reset();
handler.addObserved(*gs, "cfg", [&]() {
stringstream dot;
dot << "digraph \"" << rbName << "\" {" << '\n';
for (auto &cfg : collector.cfgs) {
dot << cfg->toString(ctx) << '\n' << '\n';
}
dot << "}" << '\n';
return dot.str();
});
handler.addObserved(*gs, "cfg-raw", [&]() {
stringstream dot;
dot << "digraph \"" << rbName << "\" {" << '\n';
dot << " graph [fontname = \"Courier\"];\n";
dot << " node [fontname = \"Courier\"];\n";
dot << " edge [fontname = \"Courier\"];\n";
for (auto &cfg : collector.cfgs) {
dot << cfg->showRaw(ctx) << '\n' << '\n';
}
dot << "}" << '\n';
return dot.str();
});
handler.addObserved(
*gs, "cfg-text",
[&]() {
stringstream dot;
for (auto &cfg : collector.cfgs) {
dot << cfg->toTextualString(ctx) << '\n' << '\n';
}
return dot.str();
},
false);
}
// If there is a tree left with a typed: pragma, run the inferencer
if (resolvedTree.tree != nullptr && file.data(*gs).originalSigil >= core::StrictLevel::True) {
checkTree();
CFGCollectorAndTyper collector;
core::Context ctx(*gs, core::Symbols::root(), resolvedTree.file);
ast::ShallowWalk::apply(ctx, collector, resolvedTree.tree);
for (auto &extension : ctx.state.semanticExtensions) {
extension->finishTypecheckFile(ctx, file);
}
resolvedTree.tree.reset();
handler.drainErrors(*gs);
}
}
for (auto &extension : gs->semanticExtensions) {
extension->finishTypecheck(*gs);
}
// Check autocorrects
{
auto autocorrects = vector<core::AutocorrectSuggestion>{};
for (const auto &error : handler.errors) {
if (error->isSilenced) {
continue;
}
for (const auto &autocorrect : error->autocorrects) {
autocorrects.push_back(autocorrect);
}
}
auto fs = OSFileSystem{};
auto applied = core::AutocorrectSuggestion::apply(*gs, fs, autocorrects);
auto toWrite = UnorderedMap<core::FileRef, string>{};
for (const auto &[file, editedSource] : applied) {
toWrite[file] = move(editedSource);
}
auto addNewline = false;
handler.addObserved(
*gs, "autocorrects",
[&]() {
fmt::memory_buffer buf;
for (const auto &file : files) {
string editedSource;
if (toWrite.contains(file)) {
editedSource = toWrite[file];
} else {
editedSource = file.data(*gs).source();
}
fmt::format_to(std::back_inserter(buf), "# -- {} --\n{}# ------------------------------\n",
core::File::censorFilePathForSnapshotTests(file.data(*gs).path()), editedSource);
}
return to_string(buf);
},
addNewline);
}
handler.checkExpectations();
if (test.expectations.contains("symbol-table")) {
string table = gs->toString() + '\n';
CHECK_EQ_DIFF(handler.got["symbol-table"], table, "symbol-table should not be mutated by CFG+inference");
}
if (test.expectations.contains("symbol-table-raw")) {
string table = gs->showRaw() + '\n';
CHECK_EQ_DIFF(handler.got["symbol-table-raw"], table,
"symbol-table-raw should not be mutated by CFG+inference");
}
// Check warnings and errors
{
map<string, vector<unique_ptr<Diagnostic>>> diagnostics;
for (auto &error : handler.errors) {
if (error->isSilenced) {
continue;
}
auto diag = errorToDiagnostic(*gs, *error);
ENFORCE(diag != nullptr, "Error was given no valid location - '{}'", error->toString(*gs));
auto path = error->loc.file().data(*gs).path();
diagnostics[string(path.begin(), path.end())].push_back(std::move(diag));
}
ErrorAssertion::checkAll(test.sourceFileContents, RangeAssertion::getErrorAssertions(assertions), diagnostics);
}
// Allow later phases to have errors that we didn't test for
errorQueue->flushAllErrors(*gs);
{ auto _ = errorCollector->drainErrors(); }
// now we test the incremental resolver
auto disableStressIncremental =
BooleanPropertyAssertion::getValue("disable-stress-incremental", assertions).value_or(false);
if (disableStressIncremental) {
MESSAGE("errors OK");
return;
}
handler.clear(*gs);
auto symbolsBefore = gs->symbolsUsedTotal();
vector<ast::ParsedFile> newTrees;
for (auto &f : trees) {
if (f.file.data(*gs).strictLevel == core::StrictLevel::Ignore) {
newTrees.emplace_back(move(f));
continue;
}
const int prohibitedLines = f.file.data(*gs).source().size();
auto newSource = absl::StrCat(string(prohibitedLines + 1, '\n'), f.file.data(*gs).source());
auto newFile =
make_shared<core::File>(string(f.file.data(*gs).path()), move(newSource), f.file.data(*gs).sourceType);
gs->replaceFile(f.file, move(newFile));
// this replicates the logic of pipeline::indexOne
unique_ptr<parser::Node> nodes;
if (parser == realmain::options::Parser::SORBET) {
auto settings = parser::Parser::Settings{};
nodes = parser::Parser::run(*gs, f.file, settings);
} else if (parser == realmain::options::Parser::PRISM) {
nodes = realmain::pipeline::runPrismParser(*gs, f.file, false, {});
}
handler.addObserved(*gs, "parse-tree", [&]() { return nodes->toString(*gs); });
handler.addObserved(*gs, "parse-tree-json", [&]() { return nodes->toJSON(*gs); });
core::MutableContext ctx(*gs, core::Symbols::root(), f.file);
ast::ParsedFile file = testSerialize(*gs, ast::ParsedFile{ast::desugar::node2Tree(ctx, move(nodes)), f.file});
handler.addObserved(*gs, "desguar-tree", [&]() { return file.tree.toString(*gs); });
handler.addObserved(*gs, "desugar-tree-raw", [&]() { return file.tree.showRaw(*gs); });
// Rewriter pass
file = testSerialize(*gs, ast::ParsedFile{rewriter::Rewriter::run(ctx, move(file.tree)), file.file});
handler.addObserved(*gs, "rewrite-tree", [&]() { return file.tree.toString(*gs); });
handler.addObserved(*gs, "rewrite-tree-raw", [&]() { return file.tree.showRaw(*gs); });
// local vars
file = testSerialize(*gs, local_vars::LocalVars::run(ctx, move(file)));
handler.addObserved(*gs, "index-tree", [&]() { return file.tree.toString(*gs); });
handler.addObserved(*gs, "index-tree-raw", [&]() { return file.tree.showRaw(*gs); });
newTrees.emplace_back(move(file));
}
trees = move(newTrees);
fast_sort(trees, [](auto &lhs, auto &rhs) { return lhs.file < rhs.file; });
if (enablePackager) {
absl::c_stable_partition(trees, [&](const auto &pf) { return pf.file.isPackage(*gs); });
trees = packager::Packager::runIncremental(*gs, move(trees));
for (auto &tree : trees) {
handler.addObserved(*gs, "package-tree", [&]() {
return fmt::format("# -- {} --\n{}", tree.file.data(*gs).path(), tree.tree.toString(*gs));
});
}
}
bool ranIncrementalNamer = false;
{
// namer
for (auto &tree : trees) {
core::UnfreezeSymbolTable symbolTableAccess(*gs);
vector<ast::ParsedFile> vTmp;
vTmp.emplace_back(move(tree));
core::FoundDefHashes foundHashes; // out param, compute this just for test coverage
// The lsp_test_runner will turn every testdata test into a test of
// Namer::runIncremental by way of creating a file update with leading whitespace.
//
// Here, to complement those tests, we just run Namer::run (not Namer::runIncremental)
// to stress the codepath where Namer is not tasked with deleting anything when run for
// the fast path.
ENFORCE(!ranIncrementalNamer);
auto canceled = namer::Namer::run(*gs, absl::Span<ast::ParsedFile>(vTmp), *workers, &foundHashes);
ENFORCE(!canceled);
tree = testSerialize(*gs, move(vTmp[0]));
handler.addObserved(*gs, "name-tree", [&]() { return tree.tree.toString(*gs); });
handler.addObserved(*gs, "name-tree-raw", [&]() { return tree.tree.showRaw(*gs); });
}
}
// resolver
{
core::UnfreezeNameTable nameTableAccess(*gs);
core::UnfreezeSymbolTable symbolTableAccess(*gs);
trees = move(resolver::Resolver::runIncremental(*gs, move(trees), ranIncrementalNamer, *workers).result());
}
if (enablePackager) {
trees = packager::VisibilityChecker::run(*gs, *workers, move(trees));
}
for (auto &resolvedTree : trees) {
handler.addObserved(*gs, "resolve-tree", [&]() { return resolvedTree.tree.toString(*gs); });
handler.addObserved(*gs, "resolve-tree-raw", [&]() { return resolvedTree.tree.showRaw(*gs); });
}
handler.checkExpectations("[stress-incremental] ");
// and drain all the remaining errors
errorQueue->flushAllErrors(*gs);
{ auto _ = errorCollector->drainErrors(); }
{
INFO("the incremental resolver should not add new symbols");
CHECK_EQ(symbolsBefore, gs->symbolsUsedTotal());
}
}
} // namespace sorbet::test
int main(int argc, char *argv[]) {
cxxopts::Options options("test_corpus", "Test corpus for Sorbet typechecker");
options.allow_unrecognised_options().add_options()("single_test", "run over single test.",
cxxopts::value<std::string>()->default_value(""), "testpath");
options.allow_unrecognised_options().add_options()("parser", "The parser to use while testing.",
cxxopts::value<std::string>()->default_value("sorbet"),
"{prism, sorbet}");
auto res = options.parse(argc, argv);
if (res.count("single_test") != 1) {
printf("--single_test=<filename> argument expected\n");
return 1;
}
sorbet::test::singleTest = res["single_test"].as<std::string>();
std::string parserOpt = res["parser"].as<std::string>();
for (auto &known : sorbet::realmain::options::parser_options) {
if (known.option == parserOpt) {
sorbet::test::parser = known.flag;
break;
}
}
doctest::Context context(argc, argv);
return context.run();
}