Skip to content

Commit

Permalink
test: bug #130 reproduced (Go tests are supposed to fail) #129 #130
Browse files Browse the repository at this point in the history
  • Loading branch information
@flelli
flelli committed Jan 22, 2023
1 parent 83fe2ef commit 3c289db
Show file tree
Hide file tree
Showing 2 changed files with 206 additions and 0 deletions.
119 changes: 119 additions & 0 deletions modules/go/nyx/test/integration/git/go_git_repository_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@
package git_test

import (
"bytes" // https://pkg.go.dev/bytes
"fmt" // https://pkg.go.dev/fmt
"os" // https://pkg.go.dev/os
"os/exec" // https://pkg.go.dev/os/exec
"path/filepath" // https://pkg.go.dev/path/filepath
"testing" // https://pkg.go.dev/testing
"time" // https://pkg.go.dev/time
Expand Down Expand Up @@ -1398,6 +1401,122 @@ func TestGoGitRepositoryIsClean(t *testing.T) {
assert.True(t, clean)
}

func TestGoGitRepositoryIsCleanWithTextFileContainingLineFeedsUsingEmbeddedLibrary(t *testing.T) {
// This test reproduces bugs:
// - https://github.com/mooltiverse/nyx/issues/130
// - https://github.com/mooltiverse/nyx/issues/129
// The use case for the bug is when a commit with a simple change that adds a LF or CRLF in some text file
// makes isClean() return false (even after the change has been commited) when it's supposed to return true.
// The difference between this test and the below test is that here we use the internal library both to check the
// repository status and also to execute the Git commands to build the test repository.

// since the goGitRepository is not visible outside the package we need to retrieve it through the Git object
script := gittools.FROM_SCRATCH().Realize()
defer os.RemoveAll(script.GetWorkingDirectory())
dir := script.GetWorkingDirectory()
repository, err := GitInstance().Open(dir)
assert.NoError(t, err)

clean, err := repository.IsClean()
assert.NoError(t, err)
assert.True(t, clean)

// add one file with a LF and a CRLF and test
fileName := filepath.Join(script.GetWorkingDirectory(), "README.txt")
err = os.WriteFile(fileName, []byte("one"), 0644)
err = os.WriteFile(fileName, []byte("\n"), 0644)
err = os.WriteFile(fileName, []byte("two"), 0644)
err = os.WriteFile(fileName, []byte("\r\n"), 0644)
assert.NoError(t, err)

clean, err = repository.IsClean()
assert.NoError(t, err)
assert.False(t, clean)

// stage the files without committing
script.AndStage()
clean, err = repository.IsClean()
assert.NoError(t, err)
assert.False(t, clean)

// commit the files, now we're supposed to be clean again but when the bug is present we're not
script.AndCommit()
// when the bug is present, this call to IsClean() returns false even if it's supposed to return true
clean, err = repository.IsClean()
assert.NoError(t, err)
assert.True(t, clean)
}

func TestGoGitRepositoryIsCleanWithTextFileContainingLineFeedsUsingGitCommand(t *testing.T) {
// This test reproduces bugs:
// - https://github.com/mooltiverse/nyx/issues/130
// - https://github.com/mooltiverse/nyx/issues/129
// The use case for the bug is when a commit with a simple change that adds a LF or CRLF in some text file
// makes isClean() return false (even after the change has been commited) when it's supposed to return true.
// The difference between this test and the above test is that here we use the internal library just to check the
// repository status, while Git commands to build the test repository are executed using the external executable Git command.
prefix := "nyx-test-script-"
testDirectory := gitutil.NewTempDirectory("", &prefix)
defer os.RemoveAll(testDirectory)
repoDirectory := filepath.Join(testDirectory, "testrepo")
commandPath, err := exec.LookPath("git")
assert.NoError(t, err)
out := new(bytes.Buffer)
cmd := &exec.Cmd{Path: commandPath, Dir: testDirectory, Env: os.Environ(), Args: []string{"git", "init", "testrepo"}, Stdout: out, Stderr: out}
err = cmd.Run()
if err != nil {
fmt.Printf("command '%v' resulted in an error and its output is:\n", cmd.String())
fmt.Printf("%v\n", out.String())
}
assert.NoError(t, err)

repository, err := GitInstance().Open(repoDirectory)
assert.NoError(t, err)

clean, err := repository.IsClean()
assert.NoError(t, err)
assert.True(t, clean)

// add one file with a LF and a CRLF and test
fileName := filepath.Join(repoDirectory, "README.txt")
err = os.WriteFile(fileName, []byte("one"), 0644)
err = os.WriteFile(fileName, []byte("\n"), 0644)
err = os.WriteFile(fileName, []byte("two"), 0644)
err = os.WriteFile(fileName, []byte("\r\n"), 0644)
assert.NoError(t, err)

clean, err = repository.IsClean()
assert.NoError(t, err)
assert.False(t, clean)

// stage the files without committing
out = new(bytes.Buffer)
cmd = &exec.Cmd{Path: commandPath, Dir: repoDirectory, Env: os.Environ(), Args: []string{"git", "add", "."}, Stdout: out, Stderr: out}
err = cmd.Run()
if err != nil {
fmt.Printf("command '%v' resulted in an error and its output is:\n", cmd.String())
fmt.Printf("%v\n", out.String())
}
assert.NoError(t, err)
clean, err = repository.IsClean()
assert.NoError(t, err)
assert.False(t, clean)

// commit the files, now we're supposed to be clean again but when the bug is present we're not
out = new(bytes.Buffer)
cmd = &exec.Cmd{Path: commandPath, Dir: repoDirectory, Env: os.Environ(), Args: []string{"git", "commit", "-m", "\"commit\""}, Stdout: out, Stderr: out}
err = cmd.Run()
if err != nil {
fmt.Printf("command '%v' resulted in an error and its output is:\n", cmd.String())
fmt.Printf("%v\n", out.String())
}
assert.NoError(t, err)
// when the bug is present, this call to IsClean() returns false even if it's supposed to return true
clean, err = repository.IsClean()
assert.NoError(t, err)
assert.True(t, clean)
}

func TestGoGitRepositoryGetCommitTagsReturnsEmptyResultWithRepositoryWithNoCommits(t *testing.T) {
// since the goGitRepository is not visible outside the package we need to retrieve it through the Git object
script := gittools.FROM_SCRATCH().Realize()
Expand Down
87 changes: 87 additions & 0 deletions ...s/java/main/src/integrationTest/java/com/mooltiverse/oss/nyx/git/JGitRepositoryTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import static org.junit.jupiter.api.Assumptions.*;

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.net.URI;
import java.nio.file.Files;
Expand All @@ -39,6 +40,7 @@
import com.mooltiverse.oss.nyx.entities.git.Tag;
import com.mooltiverse.oss.nyx.git.tools.Scenario;
import com.mooltiverse.oss.nyx.git.tools.Script;
import com.mooltiverse.oss.nyx.git.util.FileSystemUtil;
import com.mooltiverse.oss.nyx.git.util.RandomUtil;
import com.mooltiverse.oss.nyx.services.github.GitHub;
import com.mooltiverse.oss.nyx.services.github.GitHubRepository;
Expand Down Expand Up @@ -1318,6 +1320,91 @@ public void isCleanTest()
script.andCommit();
assertTrue(repository.isClean());
}

@DisplayName("JGitRepository.isClean() with a test file containing linefeeds using the embedded library")
@Test
public void isCleanWithTextFileContainingLineFeedsUsingEmbeddedLibraryTest()
throws Exception {
// This test reproduces bugs:
// - https://github.com/mooltiverse/nyx/issues/130
// - https://github.com/mooltiverse/nyx/issues/129
// The use case for the bug is when a commit with a simple change that adds a LF or CRLF in some text file
// makes isClean() return false (even after the change has been commited) when it's supposed to return true.
// The bug actually does not affect the Java version, but is here to match with the tests for the Go version
// The difference between this test and the below test is that here we use the internal library both to check the
// repository status and also to execute the Git commands to build the test repository.
Script script = Scenario.FROM_SCRATCH.realize();
script.getWorkingDirectory().deleteOnExit();
Repository repository = JGitRepository.open(script.getWorkingDirectory());
assertTrue(repository.isClean());

// add one file with a LF and a CRLF and test
File f = new File(script.getWorkingDirectory(), "README.txt");
FileWriter fw = new FileWriter(f);
fw.write("one");
fw.write("\n");
fw.write("two");
fw.write("\r\n");
fw.flush();
fw.close();
assertFalse(repository.isClean());

// stage the files without committing
script.andStage();
assertFalse(repository.isClean());

// commit the files, now we're supposed to be clean again but when the bug is present we're not
script.andCommit();
// when the bug is present, this call to IsClean() returns false even if it's supposed to return true
assertTrue(repository.isClean());
}

@DisplayName("JGitRepository.isClean() with a test file containing linefeeds using the git command")
@Test
public void isCleanWithTextFileContainingLineFeedsUsingGitCommandTest()
throws Exception {
// This test reproduces bugs:
// - https://github.com/mooltiverse/nyx/issues/130
// - https://github.com/mooltiverse/nyx/issues/129
// The use case for the bug is when a commit with a simple change that adds a LF or CRLF in some text file
// makes isClean() return false (even after the change has been commited) when it's supposed to return true.
// The bug actually does not affect the Java version, but is here to match with the tests for the Go version
// The difference between this test and the above test is that here we use the internal library just to check the
// repository status, while Git commands to build the test repository are executed using the external executable Git command.
File testDirectory = FileSystemUtil.newTempDirectory(null, "nyx-test-script-");
testDirectory.deleteOnExit();
File repoDirectory = new File(testDirectory, "testrepo");
Process p = new ProcessBuilder(new String[]{"git", "init", "testrepo"}).directory(testDirectory).redirectErrorStream(true).start();
p.waitFor();
p.destroy();

Repository repository = JGitRepository.open(repoDirectory);
assertTrue(repository.isClean());

// add one file with a LF and a CRLF and test
File f = new File(repoDirectory, "README.txt");
FileWriter fw = new FileWriter(f);
fw.write("one");
fw.write("\n");
fw.write("two");
fw.write("\r\n");
fw.flush();
fw.close();
assertFalse(repository.isClean());

// stage the files without committing
p = new ProcessBuilder(new String[]{"git", "add", "."}).directory(repoDirectory).redirectErrorStream(true).start();
p.waitFor();
p.destroy();
assertFalse(repository.isClean());

// commit the files, now we're supposed to be clean again but when the bug is present we're not
p = new ProcessBuilder(new String[]{"git", "commit", "-m", "\"commit\""}).directory(repoDirectory).redirectErrorStream(true).start();
p.waitFor();
p.destroy();
// when the bug is present, this call to IsClean() returns false even if it's supposed to return true
assertTrue(repository.isClean());
}
}

@Nested
Expand Down

0 comments on commit 3c289db

Please sign in to comment.