#1140 new
Cory Crowe

play.libs.IO.readContentAsString(File file, String encoding) adds newline to read content

Reported by Cory Crowe | September 29th, 2011 @ 04:18 PM

Framework version: 1.2.3
Platform: Mac OS X Snow Leopard, 64 bit

Reproduction steps:

We added the following test (which fails) to demonstrate the bug. It is not included in the patch because the test creates a file and we assumed it might need to be modified if it were to be used in the project test suite:

import static org.junit.Assert.*;

import java.io.File;
import java.io.FileOutputStream;

import org.junit.Test;

import play.libs.IO;

public class IOTest {
    @Test
    public void shouldReadFileContent() throws Exception {
        File file = new File("expectedFile.txt");
        FileOutputStream fileOs = null;
        try {
            fileOs = new FileOutputStream(file);
            String expectedContent = "some/path/some/file";
            fileOs.write(expectedContent.getBytes());
            fileOs.close();
        
            String actualContent = IO.readContentAsString(file);
        
            assertEquals(expectedContent, actualContent);
        } finally {
            if(fileOs != null) {
                fileOs.close();
            }
            if(!file.delete()) {
                throw new RuntimeException("The file " + file.getAbsolutePath() + " could not be deleted.");
            }

        }
    }
}

Details:
We initially ran into an issue when trying to use an antify generated build.xml to run play ant targets.

play.libs.IO.readContentAsString(File file, String encoding) uses PrintWriter println() instead of PrintWriter write() to add file content to the result. This results in a newline character at the end of the returned String. We came to this conclusion while trying to debug why play.ant.PlayConfigurationLoadTask.execute() was not loading our modules. It turned out a newline was being added to the filepath play.ant.PlayConfigurationLoadTask.modules() was reading out of the modules/ file. This lead us to IO.readContentAsString and the fix.

Comments and changes to this ticket

Please Sign in or create a free account to add a new ticket.

With your very own profile, you can contribute to projects, track your activity, watch tickets, receive and update tickets through your email and much more.

New-ticket Create new ticket

Create your profile

Help contribute to this project by taking a few moments to create your personal profile. Create your profile »

<h2>Play framework</h2>

Play makes it easier to build Web applications with Java. It is a clean alternative to bloated Enterprise Java stacks. It focuses on developer productivity and targets RESTful architectures. Learn more on the <a href="http://www.playframework.org">http://www.playframework.org</a> website.<br><br>

<h2>Source code is hosted on github</h2>Check out our repository at <a href="http://github.com/playframework/play">http://github.com/playframework/play</a><br><br>

<h2>Contributing, creating a patch</h2> Please read the <a href="http://play.lighthouseapp.com/projects/57987/contributor-guide">contributor guide</a><br><br>

<h2>Reporting Security Vulnerabilities</h2> Since all bug reports are public, please report any security vulnerability directly to <em>guillaume dot bort at gmail dot com</em>.<br><br>

<h2>Creating a bug report</h2> Bug reports are incredibly helpful, so take time to report bugs and request features in our ticket tracker. We’re always grateful for patches to Play’s code. Indeed, bug reports with attached patches will get fixed far quickly than those without any.<br><br>

Please include as much relevant information as possible including the exact framework version you're using and a code snippet that reproduces the problem.<br><br>

Don't have too much expectations. Unless the bug is really a serious "everything is broken" thing, you're creating a ticket to start a discussion. Having a patch (or a branch on Github we can pull from) is better, but then again we'll only pull high quality branches that make sense to be in the core of Play.

People watching this ticket

Attachments

Referenced by

Pages