Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test: add integration test of lsp and Konfig #714

Merged
merged 2 commits into from
Sep 18, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 2 additions & 34 deletions kclvm/tools/src/LSP/src/goto_def.rs
Original file line number Diff line number Diff line change
@@ -374,45 +374,13 @@ pub(crate) fn get_identifier_last_name(id: &Identifier) -> String {

#[cfg(test)]
mod tests {
use super::goto_definition;
use crate::tests::{compare_goto_res, compile_test_file};
use indexmap::IndexSet;
use kclvm_error::Position as KCLPos;
use lsp_types::{request::GotoTypeDefinitionResponse, Position};
use proc_macro_crate::bench_test;
use std::path::PathBuf;

use crate::tests::compile_test_file;

use super::goto_definition;

fn compare_goto_res(
res: Option<GotoTypeDefinitionResponse>,
pos: (&String, u32, u32, u32, u32),
) {
match res.unwrap() {
lsp_types::GotoDefinitionResponse::Scalar(loc) => {
let got_path = loc.uri.path();
assert_eq!(got_path, pos.0);

let (got_start, got_end) = (loc.range.start, loc.range.end);

let expected_start = Position {
line: pos.1, // zero-based
character: pos.2,
};

let expected_end = Position {
line: pos.3, // zero-based
character: pos.4,
};
assert_eq!(got_start, expected_start);
assert_eq!(got_end, expected_end);
}
_ => {
unreachable!("test error")
}
}
}

#[test]
#[bench_test]
fn goto_import_pkg_test() {
433 changes: 433 additions & 0 deletions kclvm/tools/src/LSP/src/tests.rs
Original file line number Diff line number Diff line change
@@ -3,6 +3,7 @@ use crossbeam_channel::select;
use indexmap::IndexSet;
use lsp_server::Response;
use lsp_types::notification::Exit;
use lsp_types::request::GotoTypeDefinitionResponse;
use lsp_types::CompletionContext;
use lsp_types::CompletionItem;
use lsp_types::CompletionParams;
@@ -24,6 +25,7 @@ use serde::Serialize;
use std::cell::Cell;
use std::cell::RefCell;
use std::env;
use std::path::Path;
use std::path::PathBuf;
use std::process::Command;
use std::sync::Arc;
@@ -46,9 +48,13 @@ use proc_macro_crate::bench_test;

use lsp_server::{Connection, Message, Notification, Request};

use crate::completion::completion;
use crate::completion::into_completion_items;
use crate::completion::KCLCompletionItem;
use crate::config::Config;
use crate::from_lsp::file_path_from_url;

use crate::hover::hover;
use crate::main_loop::main_loop;
use crate::to_lsp::kcl_diag_to_lsp_diags;
use crate::util::to_json;
@@ -57,6 +63,35 @@ use crate::{
util::{apply_document_changes, parse_param_and_compile, Param},
};

pub(crate) fn compare_goto_res(
res: Option<GotoTypeDefinitionResponse>,
pos: (&String, u32, u32, u32, u32),
) {
match res.unwrap() {
lsp_types::GotoDefinitionResponse::Scalar(loc) => {
let got_path = loc.uri.path();
assert_eq!(got_path, pos.0);

let (got_start, got_end) = (loc.range.start, loc.range.end);

let expected_start = Position {
line: pos.1, // zero-based
character: pos.2,
};

let expected_end = Position {
line: pos.3, // zero-based
character: pos.4,
};
assert_eq!(got_start, expected_start);
assert_eq!(got_end, expected_end);
}
_ => {
unreachable!("test error")
}
}
}

pub(crate) fn compile_test_file(
testfile: &str,
) -> (String, Program, ProgramScope, IndexSet<KCLDiagnostic>) {
@@ -772,3 +807,401 @@ fn formatting_test() {
.unwrap()
)
}

// Integration testing of lsp and konfig
fn konfig_path() -> PathBuf {
let konfig_path = Path::new(".")
.canonicalize()
.unwrap()
.parent()
.unwrap()
.parent()
.unwrap()
.parent()
.unwrap()
.parent()
.unwrap()
.join("test")
.join("integration")
.join("konfig");
konfig_path
}

#[test]
fn konfig_goto_def_test_base() {
let konfig_path = konfig_path();
let mut base_path = konfig_path.clone();
base_path.push("appops/nginx-example/base/base.k");
let base_path_str = base_path.to_str().unwrap().to_string();
let (program, prog_scope, _) = parse_param_and_compile(
Param {
file: base_path_str.clone(),
},
Some(Arc::new(RwLock::new(Default::default()))),
)
.unwrap();

// schema def
let pos = KCLPos {
filename: base_path_str.clone(),
line: 7,
column: Some(30),
};
let res = goto_definition(&program, &pos, &prog_scope);
let mut expected_path = konfig_path.clone();
expected_path.push("base/pkg/kusion_models/kube/frontend/server.k");
compare_goto_res(
res,
(&expected_path.to_str().unwrap().to_string(), 12, 0, 142, 31),
);

// schema def
let pos = KCLPos {
filename: base_path_str.clone(),
line: 9,
column: Some(32),
};
let res = goto_definition(&program, &pos, &prog_scope);
let mut expected_path = konfig_path.clone();
expected_path.push("base/pkg/kusion_models/kube/frontend/container/container.k");
compare_goto_res(
res,
(&expected_path.to_str().unwrap().to_string(), 5, 0, 80, 111),
);

// schema attr
let pos = KCLPos {
filename: base_path_str.clone(),
line: 9,
column: Some(9),
};
let res = goto_definition(&program, &pos, &prog_scope);
let mut expected_path = konfig_path.clone();
expected_path.push("base/pkg/kusion_models/kube/frontend/server.k");
compare_goto_res(
res,
(
&expected_path.to_str().unwrap().to_string(),
115,
4,
115,
17,
),
);

// schema attr
let pos = KCLPos {
filename: base_path_str.clone(),
line: 10,
column: Some(10),
};
let res = goto_definition(&program, &pos, &prog_scope);
let mut expected_path = konfig_path.clone();
expected_path.push("base/pkg/kusion_models/kube/frontend/container/container.k");
compare_goto_res(
res,
(&expected_path.to_str().unwrap().to_string(), 69, 4, 69, 9),
);

// import pkg
let pos = KCLPos {
filename: base_path_str.clone(),
line: 2,
column: Some(49),
};
let res = goto_definition(&program, &pos, &prog_scope);
let mut expected_path = konfig_path.clone();
expected_path.push("base/pkg/kusion_models/kube/frontend/service/service.k");
compare_goto_res(
res,
(&expected_path.to_str().unwrap().to_string(), 0, 0, 0, 0),
);
}

#[test]
fn konfig_goto_def_test_main() {
let konfig_path = konfig_path();
let mut main_path = konfig_path.clone();
main_path.push("appops/nginx-example/dev/main.k");
let main_path_str = main_path.to_str().unwrap().to_string();
let (program, prog_scope, _) = parse_param_and_compile(
Param {
file: main_path_str.clone(),
},
Some(Arc::new(RwLock::new(Default::default()))),
)
.unwrap();

// schema def
let pos = KCLPos {
filename: main_path_str.clone(),
line: 6,
column: Some(31),
};
let res = goto_definition(&program, &pos, &prog_scope);
let mut expected_path = konfig_path.clone();
expected_path.push("base/pkg/kusion_models/kube/frontend/server.k");
compare_goto_res(
res,
(&expected_path.to_str().unwrap().to_string(), 12, 0, 142, 31),
);

// schema attr
let pos = KCLPos {
filename: main_path_str.clone(),
line: 7,
column: Some(14),
};
let res = goto_definition(&program, &pos, &prog_scope);
let mut expected_path = konfig_path.clone();
expected_path.push("base/pkg/kusion_models/kube/frontend/server.k");
compare_goto_res(
res,
(
&expected_path.to_str().unwrap().to_string(),
112,
4,
112,
22,
),
);

// import pkg
let pos = KCLPos {
filename: main_path_str.clone(),
line: 2,
column: Some(61),
};
let res = goto_definition(&program, &pos, &prog_scope);
let mut expected_path = konfig_path.clone();
expected_path.push("base/pkg/kusion_models/kube/templates/resource.k");
compare_goto_res(
res,
(&expected_path.to_str().unwrap().to_string(), 0, 0, 0, 0),
);
}

#[test]
fn konfig_completion_test_main() {
let konfig_path = konfig_path();
let mut main_path = konfig_path.clone();
main_path.push("appops/nginx-example/dev/main.k");
let main_path_str = main_path.to_str().unwrap().to_string();
let (program, prog_scope, _) = parse_param_and_compile(
Param {
file: main_path_str.clone(),
},
Some(Arc::new(RwLock::new(Default::default()))),
)
.unwrap();

// pkg's definition(schema) completion
let pos = KCLPos {
filename: main_path_str.clone(),
line: 6,
column: Some(27),
};
let got = completion(Some('.'), &program, &pos, &prog_scope).unwrap();
let mut items: IndexSet<KCLCompletionItem> = IndexSet::new();
items.insert(KCLCompletionItem {
label: "Job".to_string(),
});
items.insert(KCLCompletionItem {
label: "Server".to_string(),
});

let expect: CompletionResponse = into_completion_items(&items).into();
assert_eq!(got, expect);
items.clear();

// schema attr completion
let pos = KCLPos {
filename: main_path_str.clone(),
line: 7,
column: Some(4),
};
let got = completion(None, &program, &pos, &prog_scope).unwrap();
let attrs = [
"frontend",
"service",
"container",
"res_tpl",
"rbac",
"backend",
"resource",
"metadata",
"apis",
"corev1",
"monitoringv1",
"monitoringv1alpha1",
"kubevelav1beta1",
"commons",
"vaultv1",
"manifests",
"__META_APP_NAME",
"__META_ENV_TYPE_NAME",
"__META_CLUSTER_NAME",
"appConfiguration",
"checkIdentical",
"manifestsResourceMap",
"remove_duplicated_iter",
"__renderServerFrontendInstances__",
"__renderServerBackendInstances__",
"__renderJobFrontendInstances__",
"__renderJobBackendInstances__",
"__renderFrontendInstances__",
"__renderBackendInstances__",
"__rbac_map__",
"__prometheus_map__",
"__vault_map__",
"__k8s__",
"__array_of_resource_map___",
"__resource_map_original___",
"_providerResource",
"_providerResourceMapping",
"__resource_map___",
"__is_kubevela_application__",
"getId",
"kubevela_app",
"kubevela_output",
"server_output",
"__settings__",
"name",
"workloadType",
"renderType",
"replicas",
"image",
"schedulingStrategy",
"mainContainer",
"sidecarContainers",
"initContainers",
"useBuiltInLabels",
"labels",
"annotations",
"useBuiltInSelector",
"selector",
"podMetadata",
"volumes",
"needNamespace",
"enableMonitoring",
"configMaps",
"secrets",
"services",
"ingresses",
"serviceAccount",
"storage",
"database",
];
items.extend(attrs.iter().map(|item| KCLCompletionItem {
label: item.to_string(),
}));
let expect: CompletionResponse = into_completion_items(&items).into();
assert_eq!(got, expect);
items.clear();

// import path completion
let pos = KCLPos {
filename: main_path_str.clone(),
line: 1,
column: Some(35),
};
let got = completion(Some('.'), &program, &pos, &prog_scope).unwrap();
let pkgs = [
"common",
"configmap",
"container",
"ingress",
"job",
"rbac",
"resource",
"secret",
"server",
"service",
"serviceaccount",
"sidecar",
"storage",
"strategy",
"volume",
];
items.extend(pkgs.iter().map(|item| KCLCompletionItem {
label: item.to_string(),
}));
let expect: CompletionResponse = into_completion_items(&items).into();

assert_eq!(got, expect);
}

#[test]
fn konfig_hover_test_main() {
let konfig_path = konfig_path();
let mut main_path = konfig_path.clone();
main_path.push("appops/nginx-example/dev/main.k");
let main_path_str = main_path.to_str().unwrap().to_string();
let (program, prog_scope, _) = parse_param_and_compile(
Param {
file: main_path_str.clone(),
},
Some(Arc::new(RwLock::new(Default::default()))),
)
.unwrap();

// schema def hover
let pos = KCLPos {
filename: main_path_str.clone(),
line: 6,
column: Some(32),
};
let got = hover(&program, &pos, &prog_scope).unwrap();
match got.contents {
HoverContents::Array(arr) => {
let expect: Vec<MarkedString> = vec![
"base.pkg.kusion_models.kube.frontend\n\nschema Server",
"Server is abstaction of Deployment and StatefulSet.",
"Attributes:\n\n__settings__?: {str:any}\n\nname?: str\n\nworkloadType: str(Deployment)|str(StatefulSet)\n\nrenderType?: str(Server)|str(KubeVelaApplication)\n\nreplicas: int\n\nimage: str\n\nschedulingStrategy: SchedulingStrategy\n\nmainContainer: Main\n\nsidecarContainers?: [Sidecar]\n\ninitContainers?: [Sidecar]\n\nuseBuiltInLabels?: bool\n\nlabels?: {str:str}\n\nannotations?: {str:str}\n\nuseBuiltInSelector?: bool\n\nselector?: {str:str}\n\npodMetadata?: ObjectMeta\n\nvolumes?: [Volume]\n\nneedNamespace?: bool\n\nenableMonitoring?: bool\n\nconfigMaps?: [ConfigMap]\n\nsecrets?: [Secret]\n\nservices?: [Service]\n\ningresses?: [Ingress]\n\nserviceAccount?: ServiceAccount\n\nstorage?: ObjectStorage\n\ndatabase?: DataBase"
]
.iter()
.map(|s| MarkedString::String(s.to_string()))
.collect();
assert_eq!(expect, arr);
}
_ => unreachable!("test error"),
}

// schema attr def hover
let pos = KCLPos {
filename: main_path_str.clone(),
line: 7,
column: Some(15),
};
let got = hover(&program, &pos, &prog_scope).unwrap();
match got.contents {
HoverContents::Array(arr) => {
let expect: Vec<MarkedString> = vec![
"schedulingStrategy: SchedulingStrategy",
"SchedulingStrategy represents scheduling strategy.",
]
.iter()
.map(|s| MarkedString::String(s.to_string()))
.collect();
assert_eq!(expect, arr);
}
_ => unreachable!("test error"),
}

// variable hover
let pos = KCLPos {
filename: main_path_str.clone(),
line: 6,
column: Some(3),
};
let got = hover(&program, &pos, &prog_scope).unwrap();
match got.contents {
HoverContents::Scalar(s) => {
assert_eq!(
s,
MarkedString::String("appConfiguration: Server".to_string())
);
}
_ => unreachable!("test error"),
}
}
1 change: 1 addition & 0 deletions kclvm/tools/src/format/tests.rs
Original file line number Diff line number Diff line change
@@ -177,6 +177,7 @@ fn test_format_integration_konfig() -> Result<()> {
.parent()
.unwrap()
.join("test")
.join("integration")
.join("konfig");
let files = get_files(konfig_path, true, true, ".k");
for file in &files {