Skip to content

Commit 8537de4

Browse files
spinfooserspinfooser
committed
Name consistency changes
- Also fixed a failing test
1 parent b5ec3fd commit 8537de4

34 files changed

+85
-85
lines changed

‎README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
# Virtual Dig - Feature Test Framework
2-
Virtual Dig is a feature testing framework for Java and Kotlin users that
1+
# VisualDig - Feature Test Framework
2+
Visual Dig is a feature testing framework for Java and Kotlin users that
33
does not use Selenium as a web driver. It was written fully from scratch
44
in Kotlin, Elm, and JavaScript.
55

66

77
### Setup
8-
Virtual Dig is currently not super user friendly to set up and import into
8+
Visual Dig is currently not super user friendly to set up and import into
99
your project. This will change at a future date with the introduction of a
1010
package at Maven Central.
1111

1212
For now, look at the feature-tests folder for information on how to use and
13-
set up Virtual Dig. **feature-tests** is a fully set up sample project that uses
14-
VirtualDig with Chrome.
13+
set up Visual Dig. **feature-tests** is a fully set up sample project that uses
14+
VisualDig with Chrome.
1515

1616

1717
### Design Approach
1818
Many popular feature testing frameworks that are available today often take up
1919
a lot of developers time due to poor error messages, and failures that are inconsistent.
2020

21-
Virtual Dig aims to reduce the amount of time that developers spend writing, diagnosing,
21+
Visual Dig aims to reduce the amount of time that developers spend writing, diagnosing,
2222
and understanding feature tests. Reducing this time would make TDD teams significantly more
2323
productive.
2424

25-
There are three major goals of the Virtual Dig framework:
25+
There are three major goals of the Visual Dig framework:
2626

2727
- Reduce or eliminate false negatives
2828
- Reduce the likelihood of needing to change a test when your site changes

‎build.gradle

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
group 'io.virtualdig'
1+
group 'io.visualdig'
22
version '0.1-SNAPSHOT'
33

44
task wrapper(type: Wrapper) {

‎dig/build.gradle

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
group 'io.virtualdig'
1+
group 'io.visualdig'
22
version '0.1-SNAPSHOT'
33

44
buildscript {

‎dig/src/main/io/virtualdig/BrowserLauncher.kt renamed to ‎dig/src/main/io/visualdig/BrowserLauncher.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package io.virtualdig
1+
package io.visualdig
22

33
import java.io.File
44
import java.net.URI

‎dig/src/main/io/virtualdig/CommandRunner.kt renamed to ‎dig/src/main/io/visualdig/CommandRunner.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package io.virtualdig
1+
package io.visualdig
22

33
import java.io.File
44
import java.util.*

‎dig/src/main/io/virtualdig/Dig.kt renamed to ‎dig/src/main/io/visualdig/Dig.kt

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
package io.virtualdig
1+
package io.visualdig
22

3-
import io.virtualdig.element.DigTextQuery
4-
import io.virtualdig.element.DigWebElement
5-
import io.virtualdig.exceptions.DigFatalException
3+
import io.visualdig.element.DigTextQuery
4+
import io.visualdig.element.DigWebElement
5+
import io.visualdig.exceptions.DigFatalException
66
import org.springframework.boot.SpringApplication
77
import org.springframework.context.ConfigurableApplicationContext
88
import java.net.URI

‎dig/src/main/io/virtualdig/DigController.kt renamed to ‎dig/src/main/io/visualdig/DigController.kt

+14-14
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
package io.virtualdig
1+
package io.visualdig
22

33

44
import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
55
import com.fasterxml.jackson.module.kotlin.readValue
6-
import io.virtualdig.actions.ClickAction
7-
import io.virtualdig.actions.GoToAction
8-
import io.virtualdig.element.DigElementQuery
9-
import io.virtualdig.element.DigTextQuery
10-
import io.virtualdig.exceptions.DigPreviousQueryFailedException
11-
import io.virtualdig.exceptions.DigTextNotFoundException
12-
import io.virtualdig.exceptions.DigWebsiteException
13-
import io.virtualdig.results.FindTextResult
14-
import io.virtualdig.results.Result
15-
import io.virtualdig.results.TestResult
16-
import io.virtualdig.results.isFailure
6+
import io.visualdig.actions.ClickAction
7+
import io.visualdig.actions.GoToAction
8+
import io.visualdig.element.DigElementQuery
9+
import io.visualdig.element.DigTextQuery
10+
import io.visualdig.exceptions.DigPreviousQueryFailedException
11+
import io.visualdig.exceptions.DigTextNotFoundException
12+
import io.visualdig.exceptions.DigWebsiteException
13+
import io.visualdig.results.FindTextResult
14+
import io.visualdig.results.Result
15+
import io.visualdig.results.TestResult
16+
import io.visualdig.results.isFailure
1717
import org.springframework.beans.factory.config.BeanDefinition.SCOPE_SINGLETON
1818
import org.springframework.context.annotation.Scope
1919
import org.springframework.web.socket.TextMessage
@@ -50,7 +50,7 @@ class DigController : TextWebSocketHandler() {
5050
@Throws(Exception::class)
5151
override fun afterConnectionEstablished(session: WebSocketSession) {
5252
if (futureSession.isDone && futureSession.get().id != session.id) {
53-
throw Exception("Session ids do not match. VirtualDig does not support multiple websocket connections at once")
53+
throw Exception("Session ids do not match. VisualDig does not support multiple websocket connections at once")
5454
}
5555

5656
if (!futureSession.isDone) {
@@ -67,7 +67,7 @@ class DigController : TextWebSocketHandler() {
6767
}
6868

6969
if (futureSession.isDone && futureSession.get().id != session.id) {
70-
throw Exception("Session ids do not match. VirtualDig does not support multiple websocket connections at once")
70+
throw Exception("Session ids do not match. VisualDig does not support multiple websocket connections at once")
7171
}
7272

7373
if (message.payload == null) {

‎dig/src/main/io/virtualdig/OperatingSystem.kt renamed to ‎dig/src/main/io/visualdig/OperatingSystem.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package io.virtualdig
1+
package io.visualdig
22

33
import java.util.Locale.ENGLISH
44

‎dig/src/main/io/virtualdig/SocketWaiter.kt renamed to ‎dig/src/main/io/visualdig/SocketWaiter.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package io.virtualdig
1+
package io.visualdig
22

33
import org.apache.coyote.http2.ConnectionException
44
import java.net.Socket

‎dig/src/main/io/virtualdig/WebSocketConfig.kt renamed to ‎dig/src/main/io/visualdig/WebSocketConfig.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package io.virtualdig
1+
package io.visualdig
22

33

44
import org.springframework.boot.autoconfigure.EnableAutoConfiguration

‎dig/src/main/io/virtualdig/actions/ActionOnElementInterface.kt renamed to ‎dig/src/main/io/visualdig/actions/ActionOnElementInterface.kt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
package io.virtualdig.actions
1+
package io.visualdig.actions
22

3-
import io.virtualdig.element.DigTextQuery
3+
import io.visualdig.element.DigTextQuery
44

55
interface ActionOnElementInterface : UsedQueryInterface {
66
val digId: Int

‎dig/src/main/io/virtualdig/actions/ClickAction.kt renamed to ‎dig/src/main/io/visualdig/actions/ClickAction.kt

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
package io.virtualdig.actions
1+
package io.visualdig.actions
22

3-
import io.virtualdig.element.DigElementQuery
4-
import io.virtualdig.element.DigTextQuery
5-
import io.virtualdig.exceptions.DigFatalException
3+
import io.visualdig.element.DigElementQuery
4+
import io.visualdig.element.DigTextQuery
5+
import io.visualdig.exceptions.DigFatalException
66

77

88
data class ClickAction (

‎dig/src/main/io/virtualdig/actions/FindSingleClassAction.kt renamed to ‎dig/src/main/io/visualdig/actions/FindSingleClassAction.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package io.virtualdig.actions
1+
package io.visualdig.actions
22

33
data class FindSingleClassAction(val singleClass: String) : TestActionInterface {
44
override val action: TestAction = TestAction(FindSingleClassAction.actionType())

‎dig/src/main/io/virtualdig/actions/FindTextAction.kt renamed to ‎dig/src/main/io/visualdig/actions/FindTextAction.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package io.virtualdig.actions
1+
package io.visualdig.actions
22

33

44
data class FindTextAction(val text: String) : TestActionInterface {

‎dig/src/main/io/virtualdig/actions/GoToAction.kt renamed to ‎dig/src/main/io/visualdig/actions/GoToAction.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package io.virtualdig.actions
1+
package io.visualdig.actions
22

33
data class GoToAction(val uri: String) : TestActionInterface {
44
override val action: TestAction = TestAction(GoToAction.actionType())

‎dig/src/main/io/virtualdig/actions/TestAction.kt renamed to ‎dig/src/main/io/visualdig/actions/TestAction.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package io.virtualdig.actions
1+
package io.visualdig.actions
22

33
data class TestAction (
44
val actionType : String

‎dig/src/main/io/virtualdig/actions/UsedQueryInterface.kt renamed to ‎dig/src/main/io/visualdig/actions/UsedQueryInterface.kt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
package io.virtualdig.actions
1+
package io.visualdig.actions
22

3-
import io.virtualdig.element.DigTextQuery
3+
import io.visualdig.element.DigTextQuery
44

55
interface UsedQueryInterface {
66
val usedQueryType : String

‎dig/src/main/io/virtualdig/element/DigElement.kt renamed to ‎dig/src/main/io/visualdig/element/DigElement.kt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
package io.virtualdig.element
1+
package io.visualdig.element
22

3-
import io.virtualdig.DigController
3+
import io.visualdig.DigController
44

55
data class DigWebElement(val digId : Int,
66
val queryUsed: DigElementQuery,

‎dig/src/main/io/virtualdig/element/DigElementQuery.kt renamed to ‎dig/src/main/io/visualdig/element/DigElementQuery.kt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
package io.virtualdig.element
1+
package io.visualdig.element
22

3-
import io.virtualdig.actions.TestActionInterface
3+
import io.visualdig.actions.TestActionInterface
44
import java.lang.reflect.Type
55

66
interface DigElementQuery {

‎dig/src/main/io/virtualdig/element/DigSingleClassQuery.kt renamed to ‎dig/src/main/io/visualdig/element/DigSingleClassQuery.kt

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
package io.virtualdig.element
1+
package io.visualdig.element
22

3-
import io.virtualdig.actions.FindSingleClassAction
4-
import io.virtualdig.actions.TestActionInterface
3+
import io.visualdig.actions.FindSingleClassAction
4+
import io.visualdig.actions.TestActionInterface
55

66
data class DigSingleClassQuery(private val singleClass : String) : DigImplElementQuery<FindSingleClassAction>
77
{

‎dig/src/main/io/virtualdig/element/DigTextQuery.kt renamed to ‎dig/src/main/io/visualdig/element/DigTextQuery.kt

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
package io.virtualdig.element
1+
package io.visualdig.element
22

3-
import io.virtualdig.actions.FindTextAction
4-
import io.virtualdig.actions.TestActionInterface
3+
import io.visualdig.actions.FindTextAction
4+
import io.visualdig.actions.TestActionInterface
55

66
data class DigTextQuery(val text : String) : DigImplElementQuery<FindTextAction>
77
{

‎dig/src/main/io/virtualdig/exceptions/DigFatalException.kt renamed to ‎dig/src/main/io/visualdig/exceptions/DigFatalException.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package io.virtualdig.exceptions
1+
package io.visualdig.exceptions
22

33
class DigFatalException(message: String)
44
: Exception(getDetailedMessage(message)) {

‎dig/src/main/io/virtualdig/exceptions/DigPreviousQueryFailedException.kt renamed to ‎dig/src/main/io/visualdig/exceptions/DigPreviousQueryFailedException.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
package io.virtualdig.exceptions
1+
package io.visualdig.exceptions
22

33
class DigPreviousQueryFailedException(message: String) : Exception(message)

‎dig/src/main/io/virtualdig/exceptions/DigTextNotFoundException.kt renamed to ‎dig/src/main/io/visualdig/exceptions/DigTextNotFoundException.kt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
package io.virtualdig.exceptions
1+
package io.visualdig.exceptions
22

3-
import io.virtualdig.element.DigTextQuery
3+
import io.visualdig.element.DigTextQuery
44

55
class DigTextNotFoundException(query: DigTextQuery, closestText: String)
66
: Exception(getDetailedMessage(query, closestText)) {

‎dig/src/main/io/virtualdig/exceptions/DigWebsiteException.kt renamed to ‎dig/src/main/io/visualdig/exceptions/DigWebsiteException.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
package io.virtualdig.exceptions
1+
package io.visualdig.exceptions
22

33
class DigWebsiteException(errorText: String) : Exception(errorText)

‎dig/src/main/io/virtualdig/results/FindTextResult.kt renamed to ‎dig/src/main/io/visualdig/results/FindTextResult.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package io.virtualdig.results
1+
package io.visualdig.results
22

33
data class FindTextResult(override val result: Result,
44
val digId: Int?,

‎dig/src/main/io/virtualdig/results/TestResult.kt renamed to ‎dig/src/main/io/visualdig/results/TestResult.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package io.virtualdig.results
1+
package io.visualdig.results
22

33
enum class Result(val result: String) {
44
Failure("Failure"),

‎dig/src/test/io/virtualdig/BrowserLauncherTest.kt renamed to ‎dig/src/test/io/visualdig/BrowserLauncherTest.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package io.virtualdig
1+
package io.visualdig
22

33
import com.nhaarman.mockito_kotlin.*
44
import io.damo.aspen.Test

‎dig/src/test/io/virtualdig/ClientTestHelper.kt renamed to ‎dig/src/test/io/visualdig/ClientTestHelper.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package io.virtualdig
1+
package io.visualdig
22

33
import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
44
import com.fasterxml.jackson.module.kotlin.readValue

‎dig/src/test/io/virtualdig/CommandRunnerTest.kt renamed to ‎dig/src/test/io/visualdig/CommandRunnerTest.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package io.virtualdig
1+
package io.visualdig
22

33
import io.damo.aspen.Test
44
import org.assertj.core.api.Assertions.assertThat

‎dig/src/test/io/virtualdig/DigSocketTest.kt renamed to ‎dig/src/test/io/visualdig/DigSocketTest.kt

+16-16
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
package io.virtualdig
1+
package io.visualdig
22

33
import com.nhaarman.mockito_kotlin.any
44
import com.nhaarman.mockito_kotlin.mock
55
import com.nhaarman.mockito_kotlin.verify
66
import com.nhaarman.mockito_kotlin.whenever
77
import io.damo.aspen.Test
8-
import io.virtualdig.ClientTestHelper.Companion.assertMatchingMessage
9-
import io.virtualdig.actions.ClickAction
10-
import io.virtualdig.actions.FindTextAction
11-
import io.virtualdig.actions.GoToAction
12-
import io.virtualdig.actions.TestAction
13-
import io.virtualdig.element.DigTextQuery
14-
import io.virtualdig.element.DigWebElement
15-
import io.virtualdig.exceptions.DigPreviousQueryFailedException
16-
import io.virtualdig.exceptions.DigTextNotFoundException
17-
import io.virtualdig.exceptions.DigWebsiteException
18-
import io.virtualdig.results.FindTextResult
19-
import io.virtualdig.results.Result
20-
import io.virtualdig.results.TestResult
8+
import io.visualdig.ClientTestHelper.Companion.assertMatchingMessage
9+
import io.visualdig.actions.ClickAction
10+
import io.visualdig.actions.FindTextAction
11+
import io.visualdig.actions.GoToAction
12+
import io.visualdig.actions.TestAction
13+
import io.visualdig.element.DigTextQuery
14+
import io.visualdig.element.DigWebElement
15+
import io.visualdig.exceptions.DigPreviousQueryFailedException
16+
import io.visualdig.exceptions.DigTextNotFoundException
17+
import io.visualdig.exceptions.DigWebsiteException
18+
import io.visualdig.results.FindTextResult
19+
import io.visualdig.results.Result
20+
import io.visualdig.results.TestResult
2121
import org.assertj.core.api.Assertions.assertThat
2222
import org.assertj.core.api.Assertions.assertThatExceptionOfType
2323
import java.net.MalformedURLException
@@ -162,7 +162,7 @@ class DigSocketTest : Test({
162162

163163
assertThatExceptionOfType(DigTextNotFoundException::class.java)
164164
.isThrownBy { dig!!.findText("fo text") }
165-
.withMessageContaining("Could not find the text 'fo text' when doing a find text queryUsed.")
165+
.withMessageContaining("Could not find the text 'fo text' when doing a find text query.")
166166
.withMessageContaining("Did you possibly mean to search for 'foo text'?")
167167
}
168168

@@ -178,7 +178,7 @@ class DigSocketTest : Test({
178178

179179
assertThatExceptionOfType(DigWebsiteException::class.java)
180180
.isThrownBy { dig!!.findText("fo text") }
181-
.withMessage("Call Dig.goTo before calling any queryUsed or interaction methods.")
181+
.withMessage("Call Dig.goTo before calling any query or interaction methods.")
182182
}
183183
}
184184

‎feature-test/src/main/io/virtualdig/featuretest/Application.kt renamed to ‎feature-test/src/main/io/visualdig/featuretest/Application.kt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package io.virtualdig.featuretest
1+
package io.visualdig.featuretest
22

33
import org.springframework.boot.SpringApplication
44
import org.springframework.boot.autoconfigure.SpringBootApplication

‎feature-test/src/test/io/virtualdig/featuretest/DigFeatureTests.kt renamed to ‎feature-test/src/test/io/visualdig/featuretest/DigFeatureTests.kt

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
package io.virtualdig.featuretest
1+
package io.visualdig.featuretest
22

33
import io.damo.aspen.Test
4-
import io.virtualdig.Dig
5-
import io.virtualdig.exceptions.DigTextNotFoundException
4+
import io.visualdig.Dig
5+
import io.visualdig.exceptions.DigTextNotFoundException
66
import org.assertj.core.api.Assertions.assertThatExceptionOfType
77
import org.springframework.boot.SpringApplication
88
import org.springframework.context.ConfigurableApplicationContext

‎settings.gradle

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
rootProject.name = "virtualdig"
1+
rootProject.name = "visualdig"
22

33
include "elm-app"
44
include "feature-test"

0 commit comments

Comments
 (0)