Script code vanished when a test case is renamed

kazurayam · March 2, 2022, 12:20pm

Katalon Studio v8.3.0.beta
macOS Monterey 12.2.1

I created a GitHub project where you can see the bug reproduced.

step1 I created a script Test Case/sub/TC1, this had no problem
step2 I moved the script to Test Cases/sub/subsub/TC1, this had no problem
step3 I renamed the script to Test Cases/sub/subsub/Main
step4 I renamed the script to Test Cases/sub/subsub/Test, Test Cases/sub/subsub/TestTest, Test Cases/sub/subsub/testesttest ---- and found that the script code has vanished.

The GitHub repository has 4 tags, so you can trace what I did.

I looked at the 2 folders <projectDir>Test Cases and <projectDir>/Script and found that 2 folders has become inconsistent.

I looked at the Katalon’s .log file, where I found a StackTrace:

!ENTRY org.eclipse.e4.ui.workbench 4 0 2022-03-02 20:55:53.947
!MESSAGE 
!STACK 1
org.eclipse.core.internal.resources.ResourceException(/%Users%kazuakiurayama%katalon-workspace%CodeVanishedWhenTestCaseRenamed%CodeVanishedWhenTestCaseRenamed.prj/Scripts/sub/subsub/TestTest/Script1646222137979.groovy)[368]: java.lang.Exception: File not found: /Users/kazuakiurayama/katalon-workspace/CodeVanishedWhenTestCaseRenamed/Scripts/sub/subsub/TestTest/Script1646222137979.groovy.
	at org.eclipse.core.internal.resources.ResourceException.provideStackTrace(ResourceException.java:42)
	at org.eclipse.core.internal.resources.ResourceException.<init>(ResourceException.java:38)
	at org.eclipse.core.internal.localstore.FileSystemResourceManager.read(FileSystemResourceManager.java:835)
	at org.eclipse.core.internal.resources.File.getContents(File.java:275)
	at org.eclipse.core.internal.resources.File.getContents(File.java:266)
	at com.kms.katalon.groovy.reference.TestArtifactScriptRefactor.getScriptContent(TestArtifactScriptRefactor.java:208)
	at com.kms.katalon.groovy.reference.TestArtifactScriptRefactor.replace(TestArtifactScriptRefactor.java:159)
	at com.kms.katalon.groovy.reference.TestArtifactScriptRefactor.updateReferences(TestArtifactScriptRefactor.java:281)
	at com.kms.katalon.groovy.reference.TestArtifactScriptRefactor.updateReferenceForTestCaseFolder(TestArtifactScriptRefactor.java:261)
	at com.kms.katalon.groovy.reference.TestArtifactScriptRefactor.updateReferenceForProject(TestArtifactScriptRefactor.java:247)
	at com.kms.katalon.dal.fileservice.manager.TestCaseFileServiceManager.updateTestCase(TestCaseFileServiceManager.java:131)
	at com.kms.katalon.dal.fileservice.dataprovider.TestCaseFileServiceDataProvider.updateTestCase(TestCaseFileServiceDataProvider.java:27)
	at com.kms.katalon.controller.TestCaseController.updateTestCase(TestCaseController.java:126)
	at com.kms.katalon.composer.testcase.handlers.RenameTestCaseHandler$2.run(RenameTestCaseHandler.java:83)
	at org.eclipse.jface.operation.ModalContext$ModalContextThread.run(ModalContext.java:122)
!SUBENTRY 1 org.eclipse.core.resources 4 368 2022-03-02 20:55:53.947
!MESSAGE File not found: /Users/kazuakiurayama/katalon-workspace/CodeVanishedWhenTestCaseRenamed/Scripts/sub/subsub/TestTest/Script1646222137979.groovy.
!STACK 0
java.lang.Exception: File not found: /Users/kazuakiurayama/katalon-workspace/CodeVanishedWhenTestCaseRenamed/Scripts/sub/subsub/TestTest/Script1646222137979.groovy.
	at org.eclipse.core.internal.resources.ResourceException.provideStackTrace(ResourceException.java:42)
	at org.eclipse.core.internal.resources.ResourceException.<init>(ResourceException.java:38)
	at org.eclipse.core.internal.localstore.FileSystemResourceManager.read(FileSystemResourceManager.java:835)
	at org.eclipse.core.internal.resources.File.getContents(File.java:275)
	at org.eclipse.core.internal.resources.File.getContents(File.java:266)
	at com.kms.katalon.groovy.reference.TestArtifactScriptRefactor.getScriptContent(TestArtifactScriptRefactor.java:208)
	at com.kms.katalon.groovy.reference.TestArtifactScriptRefactor.replace(TestArtifactScriptRefactor.java:159)
	at com.kms.katalon.groovy.reference.TestArtifactScriptRefactor.updateReferences(TestArtifactScriptRefactor.java:281)
	at com.kms.katalon.groovy.reference.TestArtifactScriptRefactor.updateReferenceForTestCaseFolder(TestArtifactScriptRefactor.java:261)
	at com.kms.katalon.groovy.reference.TestArtifactScriptRefactor.updateReferenceForProject(TestArtifactScriptRefactor.java:247)
	at com.kms.katalon.dal.fileservice.manager.TestCaseFileServiceManager.updateTestCase(TestCaseFileServiceManager.java:131)
	at com.kms.katalon.dal.fileservice.dataprovider.TestCaseFileServiceDataProvider.updateTestCase(TestCaseFileServiceDataProvider.java:27)
	at com.kms.katalon.controller.TestCaseController.updateTestCase(TestCaseController.java:126)
	at com.kms.katalon.composer.testcase.handlers.RenameTestCaseHandler$2.run(RenameTestCaseHandler.java:83)
	at org.eclipse.jface.operation.ModalContext$ModalContextThread.run(ModalContext.java:122)

Conclusion

This bug has a fatal impact. This looks too silly.

I suppose that the v8.3.0 must not be released before this issue is fixed.

Otherwise I am afraid you would lose many customers.

@Jass
@duyluong

Appendix 25 May 2022

I looked the above sample project directory at the state of step4.

A Katalon Project has <projectDir>/Test Cases folder and <projectDir>/Scripts folder. Theoretically these 2 folders should be always in sync. However at the step4, the Scripts folder is corructed. See the following screenshot.

There is Scripts/sub/TestTest folder; but there is not Test Cases/sub/TestTest.tc file. This must be a falt.

~/katalon-workspace/CodeVanishedWhenTestCaseRenamed $ tree Scripts
Scripts
`-- sub
    |-- TestTest
    |   `-- Script1646222137979.groovy
    `-- testesttest
        `-- Script1653476524706.groovy

I looked at the files under the Scripts folder. See the following screenshot.

Scripts/sub/testesttest/Script1653476524706.groovy file is effectively empty.
The Scripts/sub/TestTest/Script1646222137979.groovy file contains the code I wrote.

I expected the Script/sub/testesttest/Script*.groovy to keep the code I wrote, and I expected there remains not TestTest/Script*.groovy. ---- These did not happened.

I see this is a bug of Katalon Studio.

kazurayam · March 4, 2022, 3:23am

I noticed that V8.2.5 has the same problem.

loc.nguyen · March 7, 2022, 4:18am

@kazurayam: For a serial of actions with rename and moving, before moving/rename it, please help to close the test test case, refresh the project. System works fine after that.

Could you please help to try again and let us know the result after refresh project

Note: Like other system, we users have a serial actions to the source data, refresh is required for next actions, example : Solr search engine.

Hope this information is useful.

kazurayam · March 7, 2022, 5:03am

No I won’t.

I would refuse your advice.

Jass · March 7, 2022, 5:07am

Hi @kazurayam

Thanks for reporting this bug. It is a regression bug reported by some other users as well. We’ll consider fixing it.

Happy Testing
Jass

kazurayam · March 7, 2022, 5:09am

I have never seen such fragility in IntelliJ IDEA.

I would never compare a GUI software like KS with a text search engine like Lucene.

loc.nguyen · March 7, 2022, 6:10am

Thanks @Jass,

Hope to see the issue fixed soon

FYI.

kazurayam · May 20, 2022, 2:07am

This bug still persists in the v8.3.0.

Carelessly enough, I renamed a test case script. And once renamed, my code in the test case script went away!

I regret that I forgot adding and committing the test case script into the local Git repository before renaming it.

kazurayam · May 20, 2022, 12:14pm

I checked the latest v8.3.5. The bug still persists.

I would warn all Katalon Studio users.

DO NOT RENAME TEST CASES.

You may lose your codes.

If necessary, take a backup of your project before renaming your test cases.

nam.nguyen · June 13, 2022, 4:47am

Hi @kazurayam,

The ticket corresponding to this issue is in our backlog and we’ll try to fix them in the soonest release.
Sorry for the inconvenience.

Nam Nguyen.

manpreet.mukkar · July 5, 2022, 5:24pm

Hello Team,

Any solution ? There should be a hot fix for this problem and it should not be in backlog.

This might cause some users to lose there work entirely. Katalon is a testing tool and looks like the tool itslef is not getting tested.

kazurayam · July 5, 2022, 11:53pm

I can’t believe that Katalon Team is not providing us a hot fix to this issue yet.

yingji.huang · January 10, 2023, 5:00pm

I just experienced the same thing. After renamed test case the script disappeared.
I am using Katalon Studio 8.4.1

MarkBC · February 6, 2023, 1:37pm

Katalon Studio v8.5.5 still has this bug.

I’ve lost 6 scripts in the last two days to this issue before figuring out what the cause was.

kazurayam · February 6, 2023, 1:42pm

macOS 12.6
Katalon Studio 8.3.0

I reproduced this problem.

(1) I created a new project
(2) I created a test case at Test Cases/sub/subsub/TC1. I wrote the script as follows:

import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUI

WebUI.comment("Hello, I am TC1!")

The folder tree looked as follows:

$ tree .
.
├── Checkpoints
├── Data Files
├── Drivers
├── Include
│   ├── config
│   │   └── log.properties
│   ├── features
│   └── scripts
│       └── groovy
├── Keywords
├── Libs
│   ├── CustomKeywords.groovy
│   └── internal
│       └── GlobalVariable.groovy
├── Object Repository
├── Plugins
├── Profiles
│   └── default.glbl
├── Reports
│   └── Self-healing
│       └── broken-test-objects.json
├── Scripts
│   └── sub
│       └── subsub
│           └── TC1
│               └── Script1675690524595.groovy
├── Test Cases
│   └── sub
│       └── subsub
│           └── TC1.tc
├── Test Listeners
├── Test Suites
├── TestScritVanishesWhenRenamed.prj
├── bin
│   ├── groovy
│   ├── keyword
│   ├── lib
│   │   ├── CustomKeywords.class
│   │   └── internal
│   │       └── GlobalVariable.class
│   ├── listener
│   └── testcase
├── build.gradle
├── console.properties
└── settings
    ├── external
    │   ├── com.kms.katalon.composer.execution.settings.properties
    │   └── com.kms.katalon.core.db.DatabaseSettings.properties
    └── internal
        ├── com.kms.katalon.composer.testcase.properties
        ├── com.kms.katalon.execution.properties
        ├── com.kms.katalon.execution.webui.properties
        ├── com.kms.katalon.integration.analytics.properties
        └── com.kms.katalon.integration.qtest.properties

36 directories, 19 files

This seemed OK.

(3) I tried to renamed Test Cases/sub/subsub/TC1 to Test Cases/sub/subsub/Main. Then I got a error dialog, which said Unable to renamed the test case.

I looked at the folder tree:

$ tree .
.
├── Checkpoints
...
├── Scripts
│   └── sub
│       └── subsub
│           └── TC1
│               └── Script1675690524595.groovy
├── Test Cases
│   └── sub
│       └── subsub
│           └── Main.tc
...

Interesting enough.

Test Cases/sub/subsub/TC1.tc has been already renamed to Test Cases/sub/subsub/Main.tc;
but the Scripts/sub/subsub/TC1/*.groovy file was left un-renamed

Obviously you can see, the renaming operation partially failed.

A Test Case in Katalon Studio is implemented as a combination of 2 physical files: one in the Test Cases folder, another in the Scripts folder. When I tried renaming a Test Case, Katalon Studio renamed a file under the Test Cases folder, but failed to rename the counter-part under the Scripts folder. Katalon Studio is not capable of Transactinal processing.

What is “Transactinal processing”? Well, Wikipedia tells you: “Each transaction must succeed or fail as a complete unit; it can never be only partially complete.”

(4) I tried renaming the Test Cases/sub/subsub/TC1 again.

I coud rename it, but I found the new Test Cases/sub/sub/Main has the following code:

import static com.kms.katalon.core.checkpoint.CheckpointFactory.findCheckpoint
import static com.kms.katalon.core.testcase.TestCaseFactory.findTestCase
import static com.kms.katalon.core.testdata.TestDataFactory.findTestData
import static com.kms.katalon.core.testobject.ObjectRepository.findTestObject
import static com.kms.katalon.core.testobject.ObjectRepository.findWindowsObject
import com.kms.katalon.core.checkpoint.Checkpoint as Checkpoint
import com.kms.katalon.core.cucumber.keyword.CucumberBuiltinKeywords as CucumberKW
import com.kms.katalon.core.mobile.keyword.MobileBuiltInKeywords as Mobile
import com.kms.katalon.core.model.FailureHandling as FailureHandling
import com.kms.katalon.core.testcase.TestCase as TestCase
import com.kms.katalon.core.testdata.TestData as TestData
import com.kms.katalon.core.testng.keyword.TestNGBuiltinKeywords as TestNGKW
import com.kms.katalon.core.testobject.TestObject as TestObject
import com.kms.katalon.core.webservice.keyword.WSBuiltInKeywords as WS
import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUI
import com.kms.katalon.core.windows.keyword.WindowsBuiltinKeywords as Windows
import internal.GlobalVariable as GlobalVariable
import org.openqa.selenium.Keys as Keys

This is an initial code: what we usually find when we create a new Test Case.

$ tree .
.
├── Checkpoints
...
├── Scripts
│   └── sub
│       └── subsub
│           ├── Main
│           │   └── Script1675690919162.groovy
│           └── TC1
│               └── Script1675690524595.groovy
├── Test Cases
│   └── sub
│       └── subsub
│           └── Main.tc

You can find 2 files Scripts/sub/subsub/TC1 and Scripts/sub/subsub/Main.

I checked the content of Scripts/sub/subsub/TC1, which as as follows:

import com.kms.katalon.core.webui.keyword.WebUiBuiltInKeywords as WebUI

WebUI.comment("Hello, I am TC1!")

Wow! My vanished code was still there!

kazurayam · February 6, 2023, 2:02pm

@MarkBC

You reported your issue at Why does Katalon Studio randomly erase test cases? .

You may find your “seemingly vanished codes” still remain in the Scripts folder with the previous folder names. Please check your project folder tree.

You can not check the project folder tree accurately using Katalon Studio.

You need to use Windows Explorer, or Mac Finder, or Terminal.

MarkBC · February 6, 2023, 3:04pm

Thanks for the suggestion. I did find the files (using Finder on my Mac) and they existed in the scripts directory, but were 0 bytes long.

kazurayam · February 6, 2023, 11:23pm

@MarkBC

I am sorry to hear that the files were 0 bytes long. Anything may be caused by bugs.

In order to protect your resources from being erased by Katalon Studio in future, I would recommend you to use Git to make a local backup of your projects.

Git is really bug-free! You can trust it.

kazurayam · February 10, 2023, 12:40am

I have posted a new one about the same issue:

anon46315158 · February 10, 2023, 3:45pm

i hope yo realize that i can read this as:

katalon development suck, dont ever trust. use alternate solutions!

@vu.tran any opinnion on this?

Topic		Replies	Views
Katalon Studio erased a Test Case code when it was moved, and then renamed Katalon Studio katalon-studio	11	1307	April 5, 2023
Issues with saving test cases Katalon Studio katalon-studio , test-cases	9	788	January 10, 2023
Renaming file sometimes fails Bugs Report katalon-studio , bugs-report	2	1156	April 23, 2023
Renaming any test case is deleting test scripts Katalon Studio katalon-studio , bugs-report	7	543	April 4, 2020
Refactor-Rename only works once Bugs Report katalon-studio , bugs-report	2	854	April 9, 2023

Script code vanished when a test case is renamed

Conclusion

Related Topics