/* * SPDX-License-Identifier: Apache-2.0 * * The OpenSearch Contributors require contributions made to * this file be licensed under the Apache-2.0 license or a * compatible open source license. */ /* * Licensed to Elasticsearch under one or more contributor * license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright * ownership. Elasticsearch licenses this file to you under * the Apache License, Version 2.0 (the "License"); 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. */ /* * Modifications Copyright OpenSearch Contributors. See * GitHub history for details. */ package org.opensearch.script; import org.opensearch.common.settings.Settings; import org.opensearch.test.OpenSearchTestCase; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; import java.util.HashMap; import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.function.Function; import java.util.stream.Collectors; public class ScriptLanguagesInfoTests extends OpenSearchTestCase { public void testEmptyTypesAllowedReturnsAllTypes() { ScriptService ss = getMockScriptService(Settings.EMPTY); ScriptLanguagesInfo info = ss.getScriptLanguages(); ScriptType[] types = ScriptType.values(); assertEquals(types.length, info.typesAllowed.size()); for (ScriptType type : types) { assertTrue("[" + type.getName() + "] is allowed", info.typesAllowed.contains(type.getName())); } } public void testSingleTypesAllowedReturnsThatType() { for (ScriptType type : ScriptType.values()) { ScriptService ss = getMockScriptService(Settings.builder().put("script.allowed_types", type.getName()).build()); ScriptLanguagesInfo info = ss.getScriptLanguages(); assertEquals(1, info.typesAllowed.size()); assertTrue("[" + type.getName() + "] is allowed", info.typesAllowed.contains(type.getName())); } } public void testBothTypesAllowedReturnsBothTypes() { List types = Arrays.stream(ScriptType.values()).map(ScriptType::getName).collect(Collectors.toList()); Settings.Builder settings = Settings.builder().putList("script.allowed_types", types); ScriptService ss = getMockScriptService(settings.build()); ScriptLanguagesInfo info = ss.getScriptLanguages(); assertEquals(types.size(), info.typesAllowed.size()); for (String type : types) { assertTrue("[" + type + "] is allowed", info.typesAllowed.contains(type)); } } private ScriptService getMockScriptService(Settings settings) { MockScriptEngine scriptEngine = new MockScriptEngine( MockScriptEngine.NAME, Collections.singletonMap("test_script", script -> 1), Collections.emptyMap() ); Map engines = Collections.singletonMap(scriptEngine.getType(), scriptEngine); return new ScriptService(settings, engines, ScriptModule.CORE_CONTEXTS); } public interface MiscContext { void execute(); Object newInstance(); } public void testOnlyScriptEngineContextsReturned() { MockScriptEngine scriptEngine = new MockScriptEngine( MockScriptEngine.NAME, Collections.singletonMap("test_script", script -> 1), Collections.emptyMap() ); Map engines = Collections.singletonMap(scriptEngine.getType(), scriptEngine); Map> mockContexts = scriptEngine.getSupportedContexts() .stream() .collect(Collectors.toMap(c -> c.name, Function.identity())); String miscContext = "misc_context"; assertFalse(mockContexts.containsKey(miscContext)); Map> mockAndMiscContexts = new HashMap<>(mockContexts); mockAndMiscContexts.put(miscContext, new ScriptContext<>(miscContext, MiscContext.class)); ScriptService ss = new ScriptService(Settings.EMPTY, engines, mockAndMiscContexts); ScriptLanguagesInfo info = ss.getScriptLanguages(); assertTrue(info.languageContexts.containsKey(MockScriptEngine.NAME)); assertEquals(1, info.languageContexts.size()); assertEquals(mockContexts.keySet(), info.languageContexts.get(MockScriptEngine.NAME)); } public void testContextsAllowedSettingRespected() { MockScriptEngine scriptEngine = new MockScriptEngine( MockScriptEngine.NAME, Collections.singletonMap("test_script", script -> 1), Collections.emptyMap() ); Map engines = Collections.singletonMap(scriptEngine.getType(), scriptEngine); Map> mockContexts = scriptEngine.getSupportedContexts() .stream() .collect(Collectors.toMap(c -> c.name, Function.identity())); List allContexts = new ArrayList<>(mockContexts.keySet()); List allowed = allContexts.subList(0, allContexts.size() / 2); String miscContext = "misc_context"; allowed.add(miscContext); // check that allowing more than available doesn't pollute the returned contexts Settings.Builder settings = Settings.builder().putList("script.allowed_contexts", allowed); Map> mockAndMiscContexts = new HashMap<>(mockContexts); mockAndMiscContexts.put(miscContext, new ScriptContext<>(miscContext, MiscContext.class)); ScriptService ss = new ScriptService(settings.build(), engines, mockAndMiscContexts); ScriptLanguagesInfo info = ss.getScriptLanguages(); assertTrue(info.languageContexts.containsKey(MockScriptEngine.NAME)); assertEquals(1, info.languageContexts.size()); assertEquals(new HashSet<>(allContexts.subList(0, allContexts.size() / 2)), info.languageContexts.get(MockScriptEngine.NAME)); } }