org.nlpcraft.model.test.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nlpcraft Show documentation

An API to convert natural language into actions.

There is a newer version: 0.8.2

/*
 * "Commons Clause" License, https://commonsclause.com/
 *
 * The Software is provided to you by the Licensor under the License,
 * as defined below, subject to the following condition.
 *
 * Without limiting other conditions in the License, the grant of rights
 * under the License will not include, and the License does not grant to
 * you, the right to Sell the Software.
 *
 * For purposes of the foregoing, "Sell" means practicing any or all of
 * the rights granted to you under the License to provide to third parties,
 * for a fee or other consideration (including without limitation fees for
 * hosting or consulting/support services related to the Software), a
 * product or service whose value derives, entirely or substantially, from
 * the functionality of the Software. Any license notice or attribution
 * required by the License must also include this Commons Clause License
 * Condition notice.
 *
 * Software:    NLPCraft
 * License:     Apache 2.0, https://www.apache.org/licenses/LICENSE-2.0
 * Licensor:    Copyright (C) 2018 DataLingvo, Inc. https://www.datalingvo.com
 *
 *     _   ____      ______           ______
 *    / | / / /___  / ____/________ _/ __/ /_
 *   /  |/ / / __ \/ /   / ___/ __ `/ /_/ __/
 *  / /|  / / /_/ / /___/ /  / /_/ / __/ /_
 * /_/ |_/_/ .___/\____/_/   \__,_/_/  \__/
 *        /_/
 */

/**
 * Contains model testing framework.
 * 
 * Here's an code snippet from Alarm Clock example illustrating
 * the usage of test framework together with JUnit 5:
 * 
 * public class AlarmTest {
 *     private NCTestClient client;
 *
 *     @BeforeEach
 *     void setUp() throws NCException, IOException {
 *         client = new NCTestClientBuilder().newBuilder().build();
 *
 *         client.open("nlpcraft.alarm.ex");
 *     }
 *
 *     @AfterEach
 *     void tearDown() throws NCException, IOException {
 *         client.close();
 *     }
 *
 *     @Test
 *     public void test() throws NCException, IOException {
 *         // Empty parameter.
 *         assertTrue(client.ask("").isFailed());
 *
 *         // Only latin charset is supported.
 *         assertTrue(client.ask("El tiempo en España").isFailed());
 *
 *         // Should be passed.
 *         assertTrue(client.ask("Ping me in 3 minutes").isOk());
 *         assertTrue(client.ask("Buzz me in an hour and 15mins").isOk());
 *         assertTrue(client.ask("Set my alarm for 30s").isOk());
 *     }
 * }
 * 
 */
package org.nlpcraft.model.test;