diff --git a/.asf.yaml b/.asf.yaml index c56b33138c..cdb8cd101b 100644 --- a/.asf.yaml +++ b/.asf.yaml @@ -5,7 +5,7 @@ # (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at # -# http://www.apache.org/licenses/LICENSE-2.0 +# https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, @@ -23,7 +23,8 @@ notifications: pullrequests: issues@commons.apache.org jira_options: link label jobs: notifications@commons.apache.org - issues_bot_dependabot: notifications@commons.apache.org - pullrequests_bot_dependabot: notifications@commons.apache.org + # commits_bot_dependabot: dependabot@commons.apache.org + issues_bot_dependabot: dependabot@commons.apache.org + pullrequests_bot_dependabot: dependabot@commons.apache.org issues_bot_codecov-commenter: notifications@commons.apache.org pullrequests_bot_codecov-commenter: notifications@commons.apache.org diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000000..f42866e4bd --- /dev/null +++ b/.gitattributes @@ -0,0 +1,16 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +* text=auto diff --git a/.github/GH-ROBOTS.txt b/.github/GH-ROBOTS.txt index e3329e55fb..64a88674fe 100644 --- a/.github/GH-ROBOTS.txt +++ b/.github/GH-ROBOTS.txt @@ -5,7 +5,7 @@ # (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at # -# http://www.apache.org/licenses/LICENSE-2.0 +# https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 9ebcd0ebb1..90ec55f742 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -5,7 +5,7 @@ # (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at # -# http://www.apache.org/licenses/LICENSE-2.0 +# https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, @@ -18,10 +18,8 @@ updates: - package-ecosystem: "maven" directory: "/" schedule: - interval: "weekly" - day: "friday" + interval: "quarterly" - package-ecosystem: "github-actions" directory: "/" schedule: - interval: "weekly" - day: "friday" + interval: "quarterly" diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index d126a970ce..9ff35c83e7 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -7,7 +7,7 @@ "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an @@ -22,7 +22,9 @@ Thanks for your contribution to [Apache Commons](https://commons.apache.org/)! Y Before you push a pull request, review this list: - [ ] Read the [contribution guidelines](CONTRIBUTING.md) for this project. +- [ ] Read the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) if you use Artificial Intelligence (AI). +- [ ] I used AI to create any part of, or all of, this pull request. Which AI tool was used to create this pull request, and to what extent did it contribute? - [ ] Run a successful build using the default [Maven](https://maven.apache.org/) goal with `mvn`; that's `mvn` on the command line by itself. -- [ ] Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied. This may not always be possible but is a best-practice. +- [ ] Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied. This may not always be possible, but it is a best practice. - [ ] Write a pull request description that is detailed enough to understand what the pull request does, how, and why. -- [ ] Each commit in the pull request should have a meaningful subject line and body. Note that commits might be squashed by a maintainer on merge. +- [ ] Each commit in the pull request should have a meaningful subject line and body. Note that a maintainer may squash commits during the merge process. diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index f45541b63e..cca38e5121 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -1,85 +1,86 @@ -# Licensed to the Apache Software Foundation (ASF) under one or more -# contributor license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright ownership. -# The ASF licenses this file to You under the Apache License, Version 2.0 -# (the "License"); you may not use this file except in compliance with -# the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -name: "CodeQL" - -on: - push: - branches: [ master ] - pull_request: - # The branches below must be a subset of the branches above - branches: [ master ] - schedule: - - cron: '33 9 * * 4' - -permissions: - contents: read - -jobs: - analyze: - name: Analyze - runs-on: ubuntu-latest - permissions: - actions: read - contents: read - security-events: write - - strategy: - fail-fast: false - matrix: - language: [ 'java' ] - # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] - # Learn more about CodeQL language support at https://git.io/codeql-language-support - - steps: - - name: Checkout repository - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2 - with: - persist-credentials: false - - uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0 - with: - path: ~/.m2/repository - key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} - restore-keys: | - ${{ runner.os }}-maven- - - # Initializes the CodeQL tools for scanning. - - name: Initialize CodeQL - uses: github/codeql-action/init@df409f7d9260372bd5f19e5b04e83cb3c43714ae # 3.27.9 - with: - languages: ${{ matrix.language }} - # If you wish to specify custom queries, you can do so here or in a config file. - # By default, queries listed here will override any specified in a config file. - # Prefix the list here with "+" to use these queries and those in the config file. - # queries: ./path/to/local/query, your-org/your-repo/queries@main - - # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). - # If this step fails, then you should remove it and run the build manually (see below) - - name: Autobuild - uses: github/codeql-action/autobuild@df409f7d9260372bd5f19e5b04e83cb3c43714ae # 3.27.9 - - # โ„น๏ธ Command-line programs to run using the OS shell. - # ๐Ÿ“š https://git.io/JvXDl - - # โœ๏ธ If the Autobuild fails above, remove it and uncomment the following three lines - # and modify them (or add more) to build your code if your project - # uses a compiled language - - #- run: | - # make bootstrap - # make release - - - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@df409f7d9260372bd5f19e5b04e83cb3c43714ae # 3.27.9 +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: "CodeQL" + +on: + push: + branches: [ master ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ master ] + schedule: + - cron: '33 9 * * 4' + +permissions: + contents: read + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + max-parallel: 20 + fail-fast: false + matrix: + language: [ 'java' ] + # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] + # Learn more about CodeQL language support at https://git.io/codeql-language-support + + steps: + - name: Checkout repository + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + persist-credentials: false + - uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 #v6.1.0 + with: + path: ~/.m2/repository + key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} + restore-keys: | + ${{ runner.os }}-maven- + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4.36.2 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + # queries: ./path/to/local/query, your-org/your-repo/queries@main + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4.36.2 + + # โ„น๏ธ Command-line programs to run using the OS shell. + # ๐Ÿ“š https://git.io/JvXDl + + # โœ๏ธ If the Autobuild fails above, remove it and uncomment the following three lines + # and modify them (or add more) to build your code if your project + # uses a compiled language + + #- run: | + # make bootstrap + # make release + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4.36.2 diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml index c6ece650e2..7bc02bdd23 100644 --- a/.github/workflows/dependency-review.yml +++ b/.github/workflows/dependency-review.yml @@ -6,7 +6,7 @@ # "License"); you may not use this file except in compliance # with the License. You may obtain a copy of the License at # -# http://www.apache.org/licenses/LICENSE-2.0 +# https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an @@ -26,6 +26,6 @@ jobs: runs-on: ubuntu-latest steps: - name: 'Checkout Repository' - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 - name: 'Dependency Review PR' - uses: actions/dependency-review-action@3b139cfc5fae8b618d3eae3675e383bb1769c019 # v4.5.0 + uses: actions/dependency-review-action@a1d282b36b6f3519aa1f3fc636f609c47dddb294 # v5.0.0 diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml index 9aec002d71..17ba7dd386 100644 --- a/.github/workflows/maven.yml +++ b/.github/workflows/maven.yml @@ -1,52 +1,61 @@ -# Licensed to the Apache Software Foundation (ASF) under one or more -# contributor license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright ownership. -# The ASF licenses this file to You under the Apache License, Version 2.0 -# (the "License"); you may not use this file except in compliance with -# the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -name: Java CI - -on: [push, pull_request] - -permissions: - contents: read - -jobs: - build: - - runs-on: ubuntu-latest - continue-on-error: ${{ matrix.experimental }} - strategy: - matrix: - java: [ 8, 11, 17, 21, 23 ] - experimental: [false] - include: - - java: 24-ea - experimental: true - - steps: - - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2 - with: - persist-credentials: false - - uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0 - with: - path: ~/.m2/repository - key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} - restore-keys: | - ${{ runner.os }}-maven- - - name: Set up JDK ${{ matrix.java }} - uses: actions/setup-java@7a6d8a8234af8eb26422e24e3006232cccaa061b # v4.6.0 - with: - distribution: 'temurin' - java-version: ${{ matrix.java }} - - name: Build with Maven - run: mvn -Ddoclint=all --show-version --batch-mode --no-transfer-progress +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: Java CI + +on: + push: + branches: + - 'master' + pull_request: {} + +permissions: + contents: read + +jobs: + build: + + runs-on: ${{ matrix.os }} + continue-on-error: ${{ matrix.experimental }} + strategy: + max-parallel: 20 + fail-fast: false + matrix: + os: [ubuntu-latest, macos-latest] + java: [ 8, 11, 17, 21, 25, 26 ] + experimental: [false] + # Keep the same parameter order as the matrix above + include: + - os: ubuntu-latest + java: 27-ea + experimental: true + + steps: + - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + persist-credentials: false + - uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 #v6.1.0 + with: + path: ~/.m2/repository + key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} + restore-keys: | + ${{ runner.os }}-maven- + - name: Set up JDK ${{ matrix.java }} + uses: actions/setup-java@1bcf9fb12cf4aa7d266a90ae39939e61372fe520 # v5.4.0 + with: + distribution: ${{ runner.os == 'macOS' && matrix.java == '8' && 'zulu' || 'temurin' }} + java-version: ${{ matrix.java }} + - name: Build with Maven + run: mvn -Ddoclint=all --show-version --batch-mode --no-transfer-progress diff --git a/.github/workflows/scorecards-analysis.yml b/.github/workflows/scorecards-analysis.yml index 2572806bad..e1868cb462 100644 --- a/.github/workflows/scorecards-analysis.yml +++ b/.github/workflows/scorecards-analysis.yml @@ -5,7 +5,7 @@ # (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at # -# http://www.apache.org/licenses/LICENSE-2.0 +# https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, @@ -40,12 +40,12 @@ jobs: steps: - name: "Checkout code" - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2 + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # 7.0.0 with: persist-credentials: false - name: "Run analysis" - uses: ossf/scorecard-action@62b2cac7ed8198b15735ed49ab1e5cf35480ba46 # 2.4.0 + uses: ossf/scorecard-action@4eaacf0543bb3f2c246792bd56e8cdeffafb205a # 2.4.3 with: results_file: results.sarif results_format: sarif @@ -57,13 +57,13 @@ jobs: publish_results: true - name: "Upload artifact" - uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # 4.5.0 + uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 with: name: SARIF file path: results.sarif retention-days: 5 - name: "Upload to code-scanning" - uses: github/codeql-action/upload-sarif@df409f7d9260372bd5f19e5b04e83cb3c43714ae # 3.27.9 + uses: github/codeql-action/upload-sarif@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4.36.2 with: sarif_file: results.sarif diff --git a/.gitignore b/.gitignore index 4b377d5762..2ff17ae4a8 100644 --- a/.gitignore +++ b/.gitignore @@ -21,3 +21,8 @@ buildNumber.properties *.iml /.vscode/ +/.DS_Store + +# NetBeans files +nb-configuration.xml +nbactions.xml diff --git a/BENCHMARK.md b/BENCHMARK.md index e8b579b2e2..c45918a289 100644 --- a/BENCHMARK.md +++ b/BENCHMARK.md @@ -6,7 +6,7 @@ (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 3ed501501d..b4342f33ca 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -6,7 +6,7 @@ (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 18fce304e6..3423e18ad2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, @@ -48,30 +48,33 @@ Getting Started --------------- + Make sure you have a [JIRA account](https://issues.apache.org/jira/). -+ Make sure you have a [GitHub account](https://github.com/signup/free). This is not essential, but makes providing patches much easier. ++ Make sure you have a [GitHub account](https://github.com/signup). This is not essential, but makes providing patches much easier. + If you're planning to implement a new feature it makes sense to discuss your changes on the [dev list](https://commons.apache.org/mail-lists.html) first. This way you can make sure you're not wasting your time on something that isn't considered to be in Apache Commons CSV's scope. + Submit a [Jira Ticket][jira] for your issue, assuming one does not already exist. + Clearly describe the issue including steps to reproduce when it is a bug. + Make sure you fill in the earliest version that you know has the issue. + Find the corresponding [repository on GitHub](https://github.com/apache/?query=commons-), -[fork](https://help.github.com/articles/fork-a-repo/) and check out your forked repository. If you don't have a GitHub account, you can still clone the Commons repository. +[fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) and check out your forked repository. If you don't have a GitHub account, you can still clone the Commons repository. Making Changes -------------- + Create a _topic branch_ for your isolated work. - * Usually you should base your branch on the `master` branch. + * Usually you should base your branch from the `master` branch. * A good topic branch name can be the JIRA bug ID plus a keyword, e.g. `CSV-123-InputStream`. * If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests. + Make commits of logical units. * Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue. - * e.g. `CSV-123: Close input stream earlier` + * For example, `[CSV-123] Close input stream sooner` + Respect the original code style: - + Only use spaces for indentation. + + Only use spaces for indentation; you can check for unnecessary whitespace with `git diff` before committing. + Create minimal diffs - disable _On Save_ actions like _Reformat Source Code_ or _Organize Imports_. If you feel the source code should be reformatted create a separate PR for this change first. - + Check for unnecessary whitespace with `git diff` -- check before committing. -+ Make sure you have added the necessary tests for your changes, typically in `src/test/java`. -+ Run all the tests with `mvn clean verify` to ensure nothing else was accidentally broken. ++ Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied. This may not always be possible but is a best practice. +Unit tests are typically in the `src/test/java` directory. ++ Run a successful build using the default [Maven](https://maven.apache.org/) goal with `mvn`; that's `mvn` on the command line by itself. ++ Write a pull request description that is detailed enough to understand what the pull request does, how, and why. ++ Each commit in the pull request should have a meaningful subject line and body. Note that commits might be squashed by a maintainer on merge. + Making Trivial Changes ---------------------- @@ -79,7 +82,7 @@ Making Trivial Changes The JIRA tickets are used to generate the changelog for the next release. For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA. -In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number. +In this case, it is appropriate to start the first line of a commit with '[doc]' or '[javadoc]' instead of a ticket number. Submitting Changes @@ -105,8 +108,8 @@ Additional Resources + [Contributing patches](https://commons.apache.org/patches.html) + [Apache Commons CSV JIRA project page][jira] + [Contributor License Agreement][cla] -+ [General GitHub documentation](https://help.github.com/) -+ [GitHub pull request documentation](https://help.github.com/articles/creating-a-pull-request/) ++ [General GitHub documentation](https://docs.github.com/) ++ [GitHub pull request documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) + [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) [cla]:https://www.apache.org/licenses/#clas diff --git a/LICENSE.txt b/LICENSE.txt index d645695673..ff9ad4530f 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -193,7 +193,7 @@ you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, diff --git a/NOTICE.txt b/NOTICE.txt index 5e0b770e9e..06d3824a28 100644 --- a/NOTICE.txt +++ b/NOTICE.txt @@ -1,5 +1,5 @@ Apache Commons CSV -Copyright 2005-2024 The Apache Software Foundation +Copyright 2005-2026 The Apache Software Foundation This product includes software developed at The Apache Software Foundation (https://www.apache.org/). diff --git a/README.md b/README.md index a864fd1dcb..f30de4b9c9 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, @@ -45,7 +45,7 @@ Apache Commons CSV [![Java CI](https://github.com/apache/commons-csv/actions/workflows/maven.yml/badge.svg)](https://github.com/apache/commons-csv/actions/workflows/maven.yml) [![Maven Central](https://img.shields.io/maven-central/v/org.apache.commons/commons-csv?label=Maven%20Central)](https://search.maven.org/artifact/org.apache.commons/commons-csv) -[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-csv/1.12.0.svg)](https://javadoc.io/doc/org.apache.commons/commons-csv/1.12.0) +[![Javadocs](https://javadoc.io/badge/org.apache.commons/commons-csv/1.14.1.svg)](https://javadoc.io/doc/org.apache.commons/commons-csv/1.14.1) [![CodeQL](https://github.com/apache/commons-csv/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/apache/commons-csv/actions/workflows/codeql-analysis.yml) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/apache/commons-csv/badge)](https://api.securityscorecards.dev/projects/github.com/apache/commons-csv) @@ -68,7 +68,7 @@ Alternatively, you can pull it from the central Maven repositories: org.apache.commons commons-csv - 1.12.0 + 1.14.1 ``` @@ -90,7 +90,7 @@ There are some guidelines which will make applying PRs easier for us: + Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change. + Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running `mvn`. + Before you pushing a PR, run `mvn` (by itself), this runs the default goal, which contains all build checks. -+ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false` ++ To see the code coverage report, regardless of coverage failures, run `mvn clean site -Dcommons.jacoco.haltOnFailure=false -Pjacoco` If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas). You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md). diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt index 295b0806e1..bfeb4bb8de 100644 --- a/RELEASE-NOTES.txt +++ b/RELEASE-NOTES.txt @@ -1,4 +1,169 @@ -Apache Commons CSV Version 1.12.0 Release Notes +Apache Commons CSV 1.14.1 Release Notes +--------------------------------------- + +The Apache Commons CSV team is pleased to announce the release of Apache Commons CSV 1.14.1. + + +This document contains the release notes for the 1.14.1 version of Apache Commons CSV. +Commons CSV reads and writes files in Comma Separated Value (CSV) format variations. + +Commons CSV requires at least Java 8. + +The Apache Commons CSV library provides a simple interface for reading and writing CSV files of various types. + +This is a feature and maintenance release. Java 8 or later is required. + +Changes in this version include: + + +Fixed Bugs +---------- + +* CSV-318: CSVPrinter.printRecord(Stream) hangs if given a parallel stream. Thanks to Joseph Shraibman, Gary Gregory. +* CSV-318: CSVPrinter now uses an internal lock instead of synchronized methods. Thanks to Joseph Shraibman, Gary Gregory. +* org.apache.commons.csv.CSVPrinter.printRecords(ResultSet) now writes one record at a time using a lock. Thanks to Gary Gregory. + +Changes +------- + +* Bump org.apache.commons:commons-parent from 81 to 85 #542. Thanks to Gary Gregory, Dependabot. +* Bump commons-io:commons-io from 2.18.0 to 2.20.0. Thanks to Gary Gregory. +* Bump com.opencsv:opencsv from 5.10 to 5.11.2 #545, #551, #553. Thanks to Gary Gregory, Dependabot. +* Bump org.apache.commons:commons-lang3 from 3.17.0 to 3.18.0 #556. Thanks to Gary Gregory, Dependabot. +* Bump commons-codec:commons-codec from 1.18.0 to 1.19.0. Thanks to Gary Gregory. + + +Historical list of changes: https://commons.apache.org/proper/commons-csv/changes.html + +For complete information on Apache Commons CSV, including instructions on how to submit bug reports, +patches, or suggestions for improvement, see the Apache Commons CSV website: + +https://commons.apache.org/proper/commons-csv/ + +Download page: https://commons.apache.org/proper/commons-csv/download_csv.cgi + +Have fun! +-Apache Commons CSV team + +------------------------------------------------------------------------------ + +Apache Commons CSV 1.14.0 Release Notes +--------------------------------------- + +This document contains the release notes for the 1.14.0 version of Apache Commons CSV. +Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format. + +Commons CSV requires at least Java 8. + +The Apache Commons CSV library provides a simple interface for reading and writing CSV files of various types. + +This is a feature and maintenance release. Java 8 or later is required. + +Changes in this version include: + +New Features +------------ + +* Define and use Maven property commons.jmh.version. Thanks to Gary Gregory. +* Add CSVFormat.Builder.setMaxRows(long). Thanks to Gary Gregory. +* Add CSVFormat.getMaxRows(). Thanks to Gary Gregory. +* CSVPrinter.printRecords(ResultSet) knows how to use CSVFormat's maxRows. Thanks to Gary Gregory. +* CSVPrinter.printRecords(Iterable) knows how to use CSVFormat's maxRows. Thanks to Gary Gregory. +* CSVPrinter.printRecords(Stream) knows how to use CSVFormat's maxRows. Thanks to Gary Gregory. +* CSVParser.stream() knows how to use CSVFormat's maxRows. Thanks to Gary Gregory. +* CSVParser.getRecords() knows how to use CSVFormat's maxRows. Thanks to Gary Gregory. +* CSVParser.iterator() knows how to use CSVFormat's maxRows. Thanks to Gary Gregory. + +Fixed Bugs +---------- + +* CSV-317: Release history link changed from changes-report.html to changes.html #516. Thanks to Filipe Roque. +* Remove -nouses directive from maven-bundle-plugin. OSGi package imports now state 'uses' definitions for package imports, this doesn't affect JPMS (from org.apache.commons:commons-parent:80). Thanks to Gary Gregory. +* CSVParser.parse(URL, Charset, CSVFormat) with a null CSVFormat maps to CSVFormat.DEFAULT (like CSVParser.parse(Reader, CSVFormat)). Thanks to Gary Gregory. +* CSVParser.parse(String, CSVFormat) with a null CSVFormat maps to CSVFormat.DEFAULT (like CSVParser.parse(Reader, CSVFormat)). Thanks to Gary Gregory. +* CSVParser.parse(File, Charset, CSVFormat) with a null CSVFormat maps to CSVFormat.DEFAULT (like CSVParser.parse(Reader, CSVFormat)). Thanks to Gary Gregory. +* CSVParser.parse(Path, Charset, CSVFormat) with a null CSVFormat maps to CSVFormat.DEFAULT (like CSVParser.parse(Reader, CSVFormat)). Thanks to Gary Gregory. +* CSVParser.parse(InputStream, Charset, CSVFormat) with a null CSVFormat maps to CSVFormat.DEFAULT (like CSVParser.parse(Reader, CSVFormat)). Thanks to Gary Gregory. +* CSVParser.parse(*) methods with a null Charset maps to Charset.defaultCharset(). Thanks to Gary Gregory. +* Fix possible NullPointerException in Token.toString(). Thanks to Gary Gregory. + +Changes +------- + +* Bump com.opencsv:opencsv from 5.9 to 5.10. Thanks to Gary Gregory. +* Bump commons-codec:commons-codec from 1.17.2 to 1.18.0 #522. Thanks to Gary Gregory. +* Bump org.apache.commons:commons-parent from 79 to 81. Thanks to Gary Gregory. + + +Historical list of changes: https://commons.apache.org/proper/commons-csv/changes.html + +For complete information on Apache Commons CSV, including instructions on how to submit bug reports, +patches, or suggestions for improvement, see the Apache Commons CSV website: + +https://commons.apache.org/proper/commons-csv/ + +Download page: https://commons.apache.org/proper/commons-csv/download_csv.cgi + +Have fun! +-Apache Commons CSV team + +------------------------------------------------------------------------------ + +Apache Commons CSV 1.13.0 Release Notes +--------------------------------------- + +This document contains the release notes for the 1.13.0 version of Apache Commons CSV. +Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format. + +Commons CSV requires at least Java 8. + +The Apache Commons CSV library provides a simple interface for reading and writing CSV files of various types. + +This is a feature and maintenance release. Java 8 or later is required. + +Changes in this version include: + +New Features +------------ + +* CSV-313: Add CSVPrinter.getRecordCount(). Thanks to Gary Gregory. +* Add and use CSVParser.Builder and builder() and deprecate CSVParser constructors. Thanks to Gary Gregory. +* CSVFormat.Builder implements Supplier. Thanks to Gary Gregory. +* Deprecate CSVFormat.Builder.build() for get(). Thanks to Gary Gregory. +* CSV-196: Track byte position #502. Thanks to Yuzhan Jiang, Gary Gregory. + +Fixed Bugs +---------- + +* CSV-314: Required OSGi Import-Package version numbers in MANIFEST.MF #504. Thanks to Gary Gregory. +* CSV-314: CSVParser.nextRecord() should throw CSVException (an IOException subclass) instead of IOException and IllegalStateException, no method signature changes needed. Thanks to Gary Gregory. + +Changes +------- + +* Bump org.apache.commons:commons-parent from 76 to 78 #486, #495. Thanks to Gary Gregory, Dependabot. +* Bump org.codehaus.mojo:taglist-maven-plugin from 3.1.0 to 3.2.1 #493. Thanks to Gary Gregory, Dependabot. +* Bump commons-io:commons-io from 2.17.0 to 2.18.0 #505. Thanks to Gary Gregory, Dependabot. +* Bump commons-codec:commons-codec from 1.17.1 to 1.17.2. Thanks to Gary Gregory. +* Bump org.apache.commons:commons-parent from 78 to 79. Thanks to Gary Gregory. + + +Historical list of changes: https://commons.apache.org/proper/commons-csv/changes.html + +For complete information on Apache Commons CSV, including instructions on how to submit bug reports, +patches, or suggestions for improvement, see the Apache Commons CSV website: + +https://commons.apache.org/proper/commons-csv/ + +Download page: https://commons.apache.org/proper/commons-csv/download_csv.cgi + +Have fun! +-Apache Commons CSV team + +------------------------------------------------------------------------------ + +Apache Commons CSV 1.12.0 Release Notes +--------------------------------------- This document contains the release notes for the 1.12.0 version of Apache Commons CSV. Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format. @@ -40,7 +205,7 @@ Changes * Bump commons-io:commons-io from 2.16.1 to 2.17.0 #476. Thanks to Gary Gregory, Dependabot. -Historical list of changes: https://commons.apache.org/proper/commons-csv/changes-report.html +Historical list of changes: https://commons.apache.org/proper/commons-csv/changes.html For complete information on Apache Commons CSV, including instructions on how to submit bug reports, patches, or suggestions for improvement, see the Apache Commons CSV website: @@ -54,7 +219,8 @@ Have fun! ------------------------------------------------------------------------------ -Apache Commons CSV Version 1.11.0 Release Notes +Apache Commons CSV 1.11.0 Release Notes +--------------------------------------- This document contains the release notes for the 1.11.0 version of Apache Commons CSV. Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format. @@ -100,7 +266,7 @@ Changes * Bump tests using com.opencsv:opencsv from 5.8 to 5.9 #373. Thanks to Dependabot. -Historical list of changes: https://commons.apache.org/proper/commons-csv/changes-report.html +Historical list of changes: https://commons.apache.org/proper/commons-csv/changes.html For complete information on Apache Commons CSV, including instructions on how to submit bug reports, patches, or suggestions for improvement, see the Apache Commons CSV website: @@ -114,7 +280,8 @@ Have fun! ------------------------------------------------------------------------------ -Apache Commons CSV Version 1.10.0 Release Notes +Apache Commons CSV 1.10.0 Release Notes +--------------------------------------- This document contains the release notes for the 1.10.0 version of Apache Commons CSV. Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format. @@ -181,7 +348,7 @@ Changes Removed: * Serialization in CSVFormat is not supported from one version to the next. -Historical list of changes: https://commons.apache.org/proper/commons-csv/changes-report.html +Historical list of changes: https://commons.apache.org/proper/commons-csv/changes.html For complete information on Apache Commons CSV, including instructions on how to submit bug reports, patches, or suggestions for improvement, see the Apache Commons CSV website: @@ -195,7 +362,8 @@ Have fun! ------------------------------------------------------------------------------ -Apache Commons CSV Version 1.9.0 Release Notes +Apache Commons CSV 1.9.0 Release Notes +-------------------------------------- This document contains the release notes for the 1.9.0 version of Apache Commons CSV. Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format. @@ -283,7 +451,7 @@ Changes * Bump biz.aQute.bnd:biz.aQute.bndlib from 5.1.2 to 5.3.0. Thanks to Dependabot. -Historical list of changes: https://commons.apache.org/proper/commons-csv/changes-report.html +Historical list of changes: https://commons.apache.org/proper/commons-csv/changes.html For complete information on Apache Commons CSV, including instructions on how to submit bug reports, patches, or suggestions for improvement, see the Apache Commons CSV website: @@ -297,7 +465,8 @@ Have fun! ------------------------------------------------------------------------------ -Apache Commons CSV Version 1.8 Release Notes +Apache Commons CSV 1.8 Release Notes +------------------------------------ This document contains the release notes for the 1.8 version of Apache Commons CSV. Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format. @@ -338,7 +507,7 @@ Changes * Fix typo performance test #55. Thanks to Chen. -Historical list of changes: https://commons.apache.org/proper/commons-csv/changes-report.html +Historical list of changes: https://commons.apache.org/proper/commons-csv/changes.html For complete information on Apache Commons CSV, including instructions on how to submit bug reports, patches, or suggestions for improvement, see the Apache Commons CSV website: @@ -352,7 +521,8 @@ Have fun! ------------------------------------------------------------------------------ -Apache Commons CSV Version 1.7 Release Notes +Apache Commons CSV 1.7 Release Notes +------------------------------------ This document contains the release notes for the 1.7 version of Apache Commons CSV. Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format. @@ -385,7 +555,7 @@ Changes * Update tests from H2 1.4.198 to 1.4.199. Thanks to Gary Gregory. -Historical list of changes: https://commons.apache.org/proper/commons-csv/changes-report.html +Historical list of changes: https://commons.apache.org/proper/commons-csv/changes.html For complete information on Apache Commons CSV, including instructions on how to submit bug reports, patches, or suggestions for improvement, see the Apache Commons CSV website: @@ -399,7 +569,8 @@ Have fun! ------------------------------------------------------------------------------ -Apache Commons CSV Version 1.6 Release Notes +Apache Commons CSV 1.6 Release Notes +------------------------------------ This document contains the release notes for the 1.6 version of Apache Commons CSV. Commons CSV reads and writes files in variations of the @@ -448,7 +619,8 @@ Have fun! ------------------------------------------------------------------------------ -Apache Commons CSV Version 1.5 Release Notes +Apache Commons CSV 1.5 Release Notes +------------------------------------ This document contains the release notes for the 1.5 version of Apache Commons CSV. Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format. @@ -488,7 +660,7 @@ Changes * CSV-201: Do not use RuntimeException in CSVParser.iterator().new Iterator() {...}.getNextRecord(). Thanks to Benedikt Ritter, Gary Gregory. -Historical list of changes: https://commons.apache.org/proper/commons-csv/changes-report.html +Historical list of changes: https://commons.apache.org/proper/commons-csv/changes.html For complete information on Apache Commons CSV, including instructions on how to submit bug reports, patches, or suggestions for improvement, see the Apache Commons CSV website: @@ -500,7 +672,8 @@ Have fun! ------------------------------------------------------------------------------ -Apache Commons CSV Version 1.4 Release Notes +Apache Commons CSV 1.4 Release Notes +------------------------------------ This document contains the release notes for the 1.4 version of Apache Commons CSV. Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format. @@ -527,7 +700,7 @@ Changes * CSV-183: Drop ferc.gov tests. -Historical list of changes: https://commons.apache.org/proper/commons-csv/changes-report.html +Historical list of changes: https://commons.apache.org/proper/commons-csv/changes.html For complete information on Apache Commons CSV, including instructions on how to submit bug reports, patches, or suggestions for improvement, see the Apache Commons CSV website: @@ -539,7 +712,8 @@ Have fun! ------------------------------------------------------------------------------ -Apache Commons CSV Version 1.3 Release Notes +Apache Commons CSV 1.3 Release Notes +------------------------------------ This document contains the release notes for the 1.3 version of Apache Commons CSV. Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format. @@ -583,7 +757,8 @@ Have fun! ------------------------------------------------------------------------------ -Apache Commons CSV Version 1.2 Release Notes +Apache Commons CSV 1.2 Release Notes +------------------------------------ This document contains the release notes for the 1.2 version of Apache Commons CSV. Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format. @@ -609,7 +784,7 @@ Fixed Bugs * CSV-156: Incorrect Javadoc on QuoteMode.NONE. Thanks to Jason Steenstra-Pickens. -Historical list of changes: https://commons.apache.org/proper/commons-csv/changes-report.html +Historical list of changes: https://commons.apache.org/proper/commons-csv/changes.html For complete information on Apache Commons CSV, including instructions on how to submit bug reports, patches, or suggestions for improvement, see the Apache Commons CSV website: @@ -621,7 +796,8 @@ Have fun! ------------------------------------------------------------------------------ -Apache Commons CSV Version 1.1 Release Notes +Apache Commons CSV 1.1 Release Notes +------------------------------------ This document contains the release notes for the 1.1 version of Apache Commons CSV. Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format. @@ -650,7 +826,7 @@ Changes: * [CSV-124] Improve toString() implementation of CSVRecord. Thanks to Kalyan. * [CSV-134] Unified parameter validation. Thanks to wu wen. -Historical list of changes: https://commons.apache.org/proper/commons-csv/changes-report.html +Historical list of changes: https://commons.apache.org/proper/commons-csv/changes.html For complete information on Apache Commons CSV, including instructions on how to submit bug reports, patches, or suggestions for improvement, see the Apache Commons CSV website: @@ -662,7 +838,8 @@ Have fun! ------------------------------------------------------------------------------- -Apache Commons CSV Version 1.0 Release Notes +Apache Commons CSV 1.0 Release Notes +------------------------------------ This document contains the release notes for the 1.0 version of Apache Commons CSV. Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format. @@ -740,7 +917,7 @@ Changes * CSV-27: Decide whether to keep the csv.writer subpackage -Historical list of changes: https://commons.apache.org/proper/commons-csv/changes-report.html +Historical list of changes: https://commons.apache.org/proper/commons-csv/changes.html For complete information on Apache Commons CSV, including instructions on how to submit bug reports, patches, or suggestions for improvement, see the Apache Commons CSV website: diff --git a/SECURITY.md b/SECURITY.md index 51943ba7b4..744d4cddbb 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -6,7 +6,7 @@ (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, diff --git a/benchmark-prereq.sh b/benchmark-prereq.sh index 1d03f6773a..bd1db91821 100755 --- a/benchmark-prereq.sh +++ b/benchmark-prereq.sh @@ -8,7 +8,7 @@ # "License"); you may not use this file except in compliance # with the License. You may obtain a copy of the License at # -# http://www.apache.org/licenses/LICENSE-2.0 +# https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, diff --git a/pom.xml b/pom.xml index a5383fe736..8cb13ed7c2 100644 --- a/pom.xml +++ b/pom.xml @@ -7,7 +7,7 @@ (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, @@ -15,36 +15,29 @@ See the License for the specific language governing permissions and limitations under the License. --> - + 4.0.0 org.apache.commons commons-parent - 78 + 102 commons-csv - 1.13.0-SNAPSHOT + 1.15.0-SNAPSHOT Apache Commons CSV https://commons.apache.org/proper/commons-csv/ 2005 The Apache Commons CSV library provides a simple interface for reading and writing CSV files of various types. - org.junit.jupiter junit-jupiter test - - org.hamcrest - hamcrest - 3.0 - test - org.mockito mockito-core - 4.11.0 + ${commons.mockito.version} test @@ -60,98 +53,35 @@ org.apache.commons commons-lang3 - 3.17.0 + 3.20.0 test com.h2database h2 + 2.2.224 test org.openjdk.jmh jmh-core - 1.37 + ${commons.jmh.version} test - - - - bayard - Henri Yandell - bayard@apache.org - The Apache Software Foundation - - - Martin van den Bemt - mvdb - mvdb@apache.org - The Apache Software Foundation - - - Yonik Seeley - yonik - yonik@apache.org - The Apache Software Foundation - - - Emmanuel Bourg - ebourg - ebourg@apache.org - Apache - - - ggregory - Gary Gregory - ggregory at apache.org - https://www.garygregory.com - The Apache Software Foundation - https://www.apache.org/ - - PMC Member - - America/New_York - - https://people.apache.org/~ggregory/img/garydgregory80.png - - - - Benedikt Ritter - britter - britter@apache.org - The Apache Software Foundation - - - Rob Tompkins - chtompki - chtompki@apache.org - The Apache Software Foundation - - - - - Bob Smith - - - - scm:git:http://gitbox.apache.org/repos/asf/commons-csv.git + scm:git:https://gitbox.apache.org/repos/asf/commons-csv.git scm:git:https://gitbox.apache.org/repos/asf/commons-csv.git https://gitbox.apache.org/repos/asf?p=commons-csv.git - - jira https://issues.apache.org/jira/browse/CSV - github https://github.com/apache/commons-csv/actions - apache.website @@ -159,14 +89,13 @@ scm:svn:https://svn.apache.org/repos/infra/websites/production/commons/content/proper/commons-csv/ - - 1.13.0 + 1.15.0 (Java 8 or above) RC1 - 1.12.0 - 1.13.1 + 1.14.1 + 1.15.1 csv org.apache.commons.csv CSV @@ -177,18 +106,11 @@ UTF-8 UTF-8 UTF-8 - - ${basedir}/src/conf/checkstyle/checkstyle-header.txt - ${basedir}/src/conf/checkstyle/checkstyle.xml - ${basedir}/src/conf/checkstyle/checkstyle-suppressions.xml - LICENSE.txt, NOTICE.txt, **/maven-archiver/pom.properties false true - 2024-09-25T02:03:48Z - - 1.17.1 - 2.18.0 - + 2025-07-30T14:51:35Z + 1.22.0 + 2.22.0 org.apache.commons.codec.binary;version="${commons.codec.version}", @@ -199,15 +121,20 @@ org.apache.commons.io.output;version="${commons.io.version}", * - + true 1.00 - 0.98 - 1.00 + 0.99 + 0.99 0.97 0.99 - 0.96 + 0.97 + + ${basedir}/src/conf/checkstyle/checkstyle-header.txt + ${basedir}/src/conf/checkstyle/checkstyle.xml + ${basedir}/src/conf/checkstyle/checkstyle-suppressions.xml + LICENSE.txt, NOTICE.txt, **/maven-archiver/pom.properties clean verify apache-rat:check japicmp:cmp spotbugs:check pmd:check pmd:cpd-check javadoc:javadoc checkstyle:check @@ -220,6 +147,7 @@ ${checkstyle.config.file} false + target/generated-test-sources/**/*.java ${checkstyle.suppress.file} true @@ -240,32 +168,35 @@ apache-rat-plugin - + - src/test/resources/org/apache/commons/csv/empty.txt - src/test/resources/org/apache/commons/csv/CSV-141/csv-141.csv - src/test/resources/org/apache/commons/csv/csv-167/sample1.csv - src/test/resources/org/apache/commons/csv/CSV-198/optd_por_public.csv - src/test/resources/org/apache/commons/csv/CSV-213/999751170.patch.csv - src/test/resources/org/apache/commons/csv/CSVFileParser/bom.csv - src/test/resources/org/apache/commons/csv/CSVFileParser/test.csv - src/test/resources/org/apache/commons/csv/CSVFileParser/test_default.txt - src/test/resources/org/apache/commons/csv/CSVFileParser/test_default_comment.txt - src/test/resources/org/apache/commons/csv/CSVFileParser/test_rfc4180.txt - src/test/resources/org/apache/commons/csv/CSVFileParser/test_rfc4180_trim.txt - src/test/resources/org/apache/commons/csv/CSVFileParser/testCSV85.csv - src/test/resources/org/apache/commons/csv/CSVFileParser/testCSV85_default.txt - src/test/resources/org/apache/commons/csv/CSVFileParser/testCSV85_ignoreEmpty.txt + src/test/resources/org/apache/commons/csv/empty.txt + src/test/resources/org/apache/commons/csv/CSV-141/csv-141.csv + src/test/resources/org/apache/commons/csv/csv-167/sample1.csv + src/test/resources/org/apache/commons/csv/CSV-198/optd_por_public.csv + src/test/resources/org/apache/commons/csv/CSV-196/emoji.csv + src/test/resources/org/apache/commons/csv/CSV-196/japanese.csv + src/test/resources/org/apache/commons/csv/CSV-213/999751170.patch.csv + src/test/resources/org/apache/commons/csv/CSV-254/csv-254.csv + src/test/resources/org/apache/commons/csv/CSVFileParser/bom.csv + src/test/resources/org/apache/commons/csv/CSVFileParser/test.csv + src/test/resources/org/apache/commons/csv/CSVFileParser/test_default.txt + src/test/resources/org/apache/commons/csv/CSVFileParser/test_default_comment.txt + src/test/resources/org/apache/commons/csv/CSVFileParser/test_rfc4180.txt + src/test/resources/org/apache/commons/csv/CSVFileParser/test_rfc4180_trim.txt + src/test/resources/org/apache/commons/csv/CSVFileParser/testCSV85.csv + src/test/resources/org/apache/commons/csv/CSVFileParser/testCSV85_default.txt + src/test/resources/org/apache/commons/csv/CSVFileParser/testCSV85_ignoreEmpty.txt - src/test/resources/org/apache/commons/csv/ferc.gov/contract.txt - src/test/resources/org/apache/commons/csv/ferc.gov/transaction.txt - src/test/resources/**/*.bin - src/test/resources/org/apache/commons/csv/CSV-259/sample.txt - src/test/resources/org/apache/commons/csv/CSVFileParser/testCSV246.csv - src/test/resources/org/apache/commons/csv/CSVFileParser/testCSV246_checkWithNoComment.txt - src/test/resources/org/apache/commons/csv/CSV-290/psql.csv - src/test/resources/org/apache/commons/csv/CSV-290/psql.tsv - + src/test/resources/org/apache/commons/csv/ferc.gov/contract.txt + src/test/resources/org/apache/commons/csv/ferc.gov/transaction.txt + src/test/resources/**/*.bin + src/test/resources/org/apache/commons/csv/CSV-259/sample.txt + src/test/resources/org/apache/commons/csv/CSVFileParser/testCSV246.csv + src/test/resources/org/apache/commons/csv/CSVFileParser/testCSV246_checkWithNoComment.txt + src/test/resources/org/apache/commons/csv/CSV-290/psql.csv + src/test/resources/org/apache/commons/csv/CSV-290/psql.tsv + @@ -429,7 +360,7 @@ org.openjdk.jmh jmh-generator-annprocess - 1.37 + ${commons.jmh.version} test @@ -450,7 +381,7 @@ com.opencsv opencsv - 5.9 + 5.12.0 test @@ -460,14 +391,16 @@ 2.4.0 test - - + org.skife.kasparov csv 1.0 @@ -477,7 +410,7 @@ org.apache.commons commons-lang3 - 3.17.0 + 3.20.0 @@ -531,5 +464,62 @@ - + + + bayard + Henri Yandell + bayard@apache.org + The Apache Software Foundation + + + Martin van den Bemt + mvdb + mvdb@apache.org + The Apache Software Foundation + + + Yonik Seeley + yonik + yonik@apache.org + The Apache Software Foundation + + + Emmanuel Bourg + ebourg + ebourg@apache.org + Apache + + + ggregory + Gary Gregory + ggregory at apache.org + https://www.garygregory.com + The Apache Software Foundation + https://www.apache.org/ + + PMC Member + + America/New_York + + https://people.apache.org/~ggregory/img/garydgregory80.png + + + + Benedikt Ritter + britter + britter@apache.org + The Apache Software Foundation + + + Rob Tompkins + chtompki + chtompki@apache.org + The Apache Software Foundation + + + + + Bob Smith + + diff --git a/src/assembly/bin.xml b/src/assembly/bin.xml index 0ee2a54b5f..3526ca9e91 100644 --- a/src/assembly/bin.xml +++ b/src/assembly/bin.xml @@ -1,56 +1,56 @@ - + - bin - - tar.gz - zip - - - - - LICENSE.txt - NOTICE.txt - RELEASE-NOTES.txt - - - - target - - - ${artifactId}-${version}.jar - - - - target/site/apidocs - apidocs - - **/* - - - - - target - - - ${artifactId}-${version}-sources.jar - - - - + xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.2.0 https://maven.apache.org/xsd/assembly-2.2.0.xsd"> + bin + + tar.gz + zip + + + + + LICENSE.txt + NOTICE.txt + RELEASE-NOTES.txt + + + + target + + + ${artifactId}-${version}.jar + + + + target/site/apidocs + apidocs + + **/* + + + + + target + + + ${artifactId}-${version}-sources.jar + + + + diff --git a/src/assembly/src.xml b/src/assembly/src.xml index 63089e10a9..1330db01f6 100644 --- a/src/assembly/src.xml +++ b/src/assembly/src.xml @@ -1,45 +1,45 @@ - + - src - - tar.gz - zip - - ${artifactId}-${version}-src - - - - LICENSE* - NOTICE* - RELEASE-NOTES.txt - pom.xml - findbugs-exclude-filter.xml - checkstyle*.xml - - - - src - - **/*Benchmark.java - - - - - + xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.2.0 https://maven.apache.org/xsd/assembly-2.2.0.xsd"> + src + + tar.gz + zip + + ${artifactId}-${version}-src + + + + LICENSE* + NOTICE* + RELEASE-NOTES.txt + pom.xml + findbugs-exclude-filter.xml + checkstyle*.xml + + + + src + + **/*Benchmark.java + + + + + diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 31459912d7..93952e9f18 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -1,376 +1,451 @@ - - - - - - - - Apache Commons CSV Release Notes - - - - - Required OSGi Import-Package version numbers in MANIFEST.MF #504. - CSVParser.nextRecord() should throw CSVException (an IOException subclass) instead of IOException and IllegalStateException, no method signature changes needed. - - Add CSVPrinter.getRecordCount(). - Add and use CSVParser.Builder and builder() and deprecate CSVParser constructors. - CSVFormat.Builder implements Supplier<CSVFormat>. - Deprecate CSVFormat.Builder.build() for get(). - - Bump org.apache.commons:commons-parent from 76 to 78 #486, #495. - Bump org.codehaus.mojo:taglist-maven-plugin from 3.1.0 to 3.2.1 #493. - Bump commons-io:commons-io from 2.17.0 to 2.18.0 #505. - - - - Add CSVException that extends IOException thrown on invalid input instead of IOException. - - Fix PMD issues for port to PMD 7.1.0. - Fix some Javadoc links #442. - Extract duplicated code into a method #444. - Migrate CSVFormat#print(File, Charset) to NIO #445. - Fix documentation for CSVFormat private constructor #466. - CSVFormat does not support explicit " as escape char. - Escaping is not disableable. - Fix Javadoc warnings on Java 23. - Improve parser performance by up to 20%, YMMV. - - Bump commons-codec:commons-codec from 1.16.1 to 1.17.1 #422, #449. - Bump org.apache.commons:commons-parent from 69 to 76 #435, #452, #465, #468, #475, #482. - Bump org.codehaus.mojo:taglist-maven-plugin from 3.0.0 to 3.1.0 #441. - Bump org.apache.commons:commons-lang3 from 3.14.0 to 3.17.0 #450, #459, #470. - Bump org.hamcrest:hamcrest from 2.2 to 3.0 #455. - Bump commons-io:commons-io from 2.16.1 to 2.17.0 #476. - - - - [Javadoc] Add example to CSVFormat#setHeaderComments() #344. - Add and use CSVFormat#setTrailingData(boolean) in CSVFormat.EXCEL for Excel compatibility #303. - Add and use CSVFormat#setLenientEof(boolean) in CSVFormat.EXCEL for Excel compatibility #303. - - Replace deprecated method in user guide, update external link #324, #325. - Document duplicate header behavior #309. - Add missing docs #328. - [StepSecurity] CI: Harden GitHub Actions #329, #330. - Better error message during faulty CSV record read #347. - Misleading error message when QuoteMode set to None #352. - OutOfMemory for very long rows despite using column value of type Reader. - Use try-with-resources to manage JDBC CLOB in CSVPrinter.printRecords(ResultSet). - JDBC Blob columns are now output as Base64 instead of Object#toString(), which usually is InputStream#toString(). - Support unusual Excel use cases: Add support for trailing data after the closing quote, and EOF without a final closing quote #303. - MongoDB CSV empty first column parsing fix #412. - - Bump commons-io:commons-io: from 2.11.0 to 2.16.1 #408, #413. - Bump commons-parent from 57 to 69 #410. - Bump h2 from 2.1.214 to 2.2.224 #333, #349, #359. - Bump commons-lang3 from 3.12.0 to 3.14.0. - Update exception message in CSVRecord#getNextRecord() #348. - Bump tests using com.opencsv:opencsv from 5.8 to 5.9 #373. - - - - Minor changes #172. - No Automatic-Module-Name prevents usage in JPMS projects without repacking the JAR. - Fix for multi-char delimiter not working as expected #218. - CSVRecord.get(Enum) should use Enum.name() instead of Enum.toString(). - Allow org.apache.commons.csv.IOUtils.copy(Reader, Appendable, CharBuffer) to compile on Java 11 and run on Java 8. - CSVRecord.toList() does not give write access to the new List. - CSVParser.getRecords() now throws UncheckedIOException instead of IOException. - Add comments to iterator() and stream() #270. - Fix wrong assumptions in PostgreSQL formats #265. - Validate input to setDelimiter(String) for empty string #266. - Bump CSVFormat#serialVersionUID from 1 to 2. - CSVParser: Identify duplicates in null, empty and blank header names #279. - - Serialization in CSVFormat is not supported from one version to the next. - - Make CSVRecord#values() public. - Add DuplicateHeaderMode for flexibility with header strictness. #114. - Support for parallelism in CSVPrinter. - Add CSVPrinter.printRecord[s](Stream). - Add accessors for header/trailer comments #257. - Add github/codeql-action. - - Bump actions/cache from 2.1.6 to 3.0.10 #196, #233, #243, #267, #271. - Bump actions/checkout from 2.3.4 to 3.1.0 #188, #195, #220, #272. - Bump actions/setup-java from 2 to 3.5.1. - Bump actions/upload-artifact from 3.1.0 to 3.1.1 #280. - Bump commons-parent from 52 to 57 #264, #288, #298, #323. - Bump checkstyle from 8.44 to 9.2.1 #180, #190, #194, #202, #207. - Bump junit-jupiter from 5.8.0-M1 to 5.9.1 #179, #186, #201, #244, #263. - Bump jmh-core from 1.32 to 1.36 #176, #208, #229, #285. - Bump jmh-generator-annprocess from 1.32 to 1.36 #175, #206, #226, #283. - Bump mockito-core from 3.11.2 to 4.11.0 #187, #197, #204, #212, #230, #237, #251, #259, #284, #292, #297. - Bump maven-pmd-plugin from 3.14.0 to 3.19.0 #184, #219, #238, #254, #258. - Bump pmd from 6.36.0 to 6.52.0 #173, #189, #193, #199, #227, #233, #214, #236, #240, #247, #255, #273. - Bump opencsv from 5.5.1 to 5.7.1 #182, #221, #260, #281. - Bump spotbugs-maven-plugin from 4.3.0 to 4.7.3.0 #192, #198, #203, #211, #225, #234, #242, #245, #261, #275, #282. - Bump com.github.spotbugs:spotbugs from 4.5.3 to 4.7.2. - Bump h2 from 1.4.200 to 2.1.214 #200, #205, #213, #239. - Bump maven-javadoc-plugin from 3.3.0 to 3.4.1. - Bump biz.aQute.bnd:biz.aQute.bndlib from 5.3.0 to 6.3.1. - Bump jacoco-maven-plugin from 0.8.7 to 0.8.8. - Bump japicmp-maven-plugin from 0.15.3 to 0.16.0. - Bump maven-checkstyle-plugin from 3.1.2 to 3.2.0 #253. - - - - Replace FindBugs with SpotBugs #56. - Javadoc typo in CSVFormat let's -> lets #57. - CSVFormat.printWithEscapes throws StringIndexOutOfBoundsException when value is Reader #61. - Improve CSVFormat test coverage #63. - Fix CSVFileParserTest.java to allow for a null return value from record.getComment() #62. - Improve test coverage in CSVFormatTest #65. - Removed invalid Javadoc markup for CSVFormat EXCEL #64. - Improve CSVRecord and CSVPrinter code coverage #66. - Improve lexer and token coverage #67. - CSVFormat.format trims last delimiter if the delimiter is a white space #71. - Replace org.apache.commons.csv.Assertions.notNull() with Objects.requireNonNull(). - Line number is not proper at EOF. - Parser iterates over the last CSV Record twice. - Minor improvements #126, #127, #130. - Add possibility to use ResultSet header meta data as CSV header #11. - Add test cases for withIgnoreSurroundingSpaces() and withTrim() #70. - Update CSVParser.parse(File, Charset, CSVFormat) from IO to NIO. - Missing separator with print(object) followed by printRecord(Object[]) #157. - Fix EOL checking for read array in ExtendedBufferedReader #5. - Print from Reader with embedded quotes generates incorrect output #78. - Replace JUnit assert by simpler but equivalent calls. #159. - Update gitignore to ignore idea and vscode #160. - Update CSVBenchmark #165. - Remove Whitespace Check Determines Delimiter Twice #167. - Document and Automate CSV Benchmark Harness #166. - Optimize Lexer Delimiter Check for One Character Delimiter #163. - SpotBugs Error: Medium: org.apache.commons.csv.CSVParser.getHeaderNames() may expose internal representation by returning CSVParser.headerNames [org.apache.commons.csv.CSVParser] At CSVParser.java:[line 599] EI_EXPOSE_REP. - SpotBugs Error: Medium: new org.apache.commons.csv.CSVParser(Reader, CSVFormat, long, long) may expose internal representation by storing an externally mutable object into CSVParser.format [org.apache.commons.csv.CSVParser] At CSVParser.java:[line 433] EI_EXPOSE_REP2. - SpotBugs Error: Medium: new org.apache.commons.csv.CSVParser(Reader, CSVFormat, long, long) may expose internal representation by storing an externally mutable object into CSVParser.headerMap [org.apache.commons.csv.CSVParser] At CSVParser.java:[line 437] EI_EXPOSE_REP2. - SpotBugs Error: Medium: new org.apache.commons.csv.CSVParser(Reader, CSVFormat, long, long) may expose internal representation by storing an externally mutable object into CSVParser.headerNames [org.apache.commons.csv.CSVParser] At CSVParser.java:[line 438] EI_EXPOSE_REP2. - SpotBugs Error: Medium: new org.apache.commons.csv.CSVPrinter(Appendable, CSVFormat) may expose internal representation by storing an externally mutable object into CSVPrinter.format [org.apache.commons.csv.CSVPrinter] At CSVPrinter.java:[line 100] EI_EXPOSE_REP2. - Formalize PerformanceTest #168. - Reuse Buffers in Lexer for Delimiter Detection #162. - Cleanup and Document Performance Test Harness #170. - Update buffer position when reading line comment #120. - - Make CSVRecord#toList() public. - Add CSVRecord#stream(). - Add CSVParser#stream(). - Make the method CSVRecord.putIn(Map) public. - Add test cases for CSVRecord with get(Enum) and toString. #54. - Add and use CSVFormat.Builder, deprecated CSVFormat#with methods, based on #73. - Add support for String delimiters #76. - - Update org.junit.jupiter:junit-jupiter from 5.6.0 to 5.7.0, #84 #109 - Update tests from Apache Commons Lang 3.9 to 3.12.0. - Update tests from commons-io:commons-io 2.6 to 2.11.0, #108. - Bump actions/checkout from v1 to v2.3.4, #79, #92, #121. - Bump commons-parent from 50 to 51 #80. - Bump tests from opencsv from 3.1 to 5.5.1 #81, #137, #158. - Update tests from super-csv from 2.2.1 to 2.4.0 #86. - Bump build actions/setup-java from v1.4.0 to v2, #101, #113. - Bump maven-pmd-plugin from 3.13.0 to 3.14.0 #122. - Bump tests from org.mockito:mockito-core 3.2.4 -> 3.11.2; #88, #107, #110, #123, #128, #129, #156. - Bump actions/cache from v2 to v2.1.6 #132, #153. - Bump maven-checkstyle-plugin from 3.0.0 to 3.1.2 #131. - Bump checkstyle from 8.29 to 8.44. - Bump junit-jupiter from 5.7.0 to 5.8.0-M1 #133, #149. - Bump commons.jacoco.version from 0.8.5 to 0.8.7 (Java 16). - Bump commons.spotbugs.version from 4.0.4 to 4.3.0 (Java 16). - Bump maven-javadoc-plugin from 3.2.0 to 3.3.0. - Bump jmh-generator-annprocess from 1.5.2 to 1.32 #151. - Bump PMD core from 6.29.0 to 6.36.0. - Bump biz.aQute.bnd:biz.aQute.bndlib from 5.1.2 to 5.3.0. - - - Add CSVRecord.isSet(int) method #52. - Char escape doesn't work properly with quoting. - Test case failures following CSVFormat#equals() update. - CSVFormat withTrim() and withIgnoreSurroundingSpaces() need better docs. - CSVFormat equals() and hashCode() don't use all fields. - CSVFormat#validate() does not account for allowDuplicateHeaderNames #43. - Post 1.7 release fixes. - Upgrade test framework to JUnit 5 Jupiter #49, #50. - A single empty header is allowed when not allowing empty column headers. #47. - CSVRecord is not Serializable. - Use test scope for supercsv #48. - Update tests from H2 1.4.199 to 1.4.200. - Update tests from Hamcrest 2.1 to 2.2. - Update tests from Mockito 3.1.0 to 3.2.4. - Fix typos in site and test #53. - Fix typo performance test #55. - - - Add predefined CSVFormats for printing MongoDB CSV and TSV. - Fix escape character for POSTGRESQL_TEXT and POSTGRESQL_CSV formats. - Site link "Source Repository" does not work. - Add support for java.sql.Clob. - Update to Java 8. - Escape quotes in CLOBs #39. - Cannot get headers in column order from CSVRecord. - Update tests from H2 1.4.198 to 1.4.199. - - - Add more documentation to CSVPrinter. - Add autoFlush option for CsvPrinter. PR #24. - The behavior of quote char using is not similar as Excel does when the first string contains CJK char(s). - Don't quote cells just because they have UTF-8 encoded characters. - Add API org.apache.commons.csv.CSVFormat.withSystemRecordSeparator(). - Inconsistency between Javadoc of CSVFormat DEFAULT EXCEL. - Create CSVFormat.ORACLE preset. - Some multi-iterator parsing peek sequences incorrectly consume elements. - Parse method should avoid creating a redundant BufferedReader. - Add predefined CSVFormats for printing MongoDB CSV and TSV. - - - withNullString value is printed without quotes when QuoteMode.ALL is specified; add QuoteMode.ALL_NON_NULL. PR #17. - Fix outdated comments about FileReader in CSVParser #13 - Fix incorrect method name 'withFirstRowAsHeader' in user guide. - Negative numeric values in the first column are always quoted in minimal mode. - Update platform requirement from Java 6 to 7. - Do not use RuntimeException in CSVParser.iterator().new Iterator() {...}.getNextRecord() - CSVParser: Add factory method accepting InputStream. - Add convenience API CSVFormat.print(File, Charset) - Add convenience API CSVFormat.print(Path, Charset) - Add convenience API CSVParser.parse(Path, Charset, CSVFormat) - Add convenience API CSVFormat#printer() to print to System.out - Provide a CSV Format for printing PostgreSQL CSV and Text formats. - Adding a placeholder in the Lexer and CSV parser to store the end-of-line string. - - - Make CSVPrinter.print(Object) GC-free. - Allow some printing operations directly from CSVFormat. - Drop ferc.gov tests. - - - Add shortcut method for using first record as header to CSVFormat - Add withHeader(Class<? extends Enum>) to CSVFormat - Comment line hides next record; update Javadoc to make behavior clear - CSVPrinter doesn't skip creation of header record if skipHeaderRecord is set to true - Add IgnoreCase option for accessing header names - The null string should be case-sensitive when reading records - CSVFormat.nullString should not be escaped - CSVFormat.MYSQL nullString should be "\N" - Fix Javadoc to say CSVFormat with() methods return a new CSVFormat - Support for ignoring trailing delimiter. - Support trimming leading and trailing blanks. - Create default formats for Informix UNLOAD and UNLOAD CSV. - - - CSVFormat.with* methods clear the header comments - Incorrect Javadoc on QuoteMode.NONE - Add enum CSVFormat.Predefined that contains the default CSVFormat values. - - - QuoteMode.NON_NUMERIC doesn't work with CSVPrinter.printRecords(ResultSet) - CSVFormat#withHeader doesn't work well with #printComment, add withHeaderComments(String...) - CSVFormat.EXCEL should ignore empty header names - Incorrect Javadoc referencing org.apache.commons.csv.CSVFormat withQuote() - Improve toString() implementation of CSVRecord - Unified parameter validation - Add CSVFormat#with 0-arg methods matching boolean arg methods - Save positions of records to enable random access - CSVPrinter.printRecord(ResultSet) with metadata - - - No longer works with Java 6 - NullPointerException when empty header string and null string of "" - Validate format parameters in constructor - IllegalArgumentException thrown when the header contains duplicate names when the column names are empty. - CSVFormat#withHeader doesn't work with CSVPrinter - CSVFormat is missing a print(...) method - CSVRecord.toMap() throws NPE on formats with no - headers. - Check whether ISE/IAE are being used appropriately - CSVFormat constructor should reject a header array with duplicate - entries - - HeaderMap is inconsistent when it is parsed from an input with - duplicate columns names - - CSVRecord.toMap() fails if row length shorter than header length - - CSVFormat.format allways append null - Add Map conversion API to CSVRecord - CSVParser: getHeaderMap throws NPE - Lots of possible changes - Use Character instead of char for char fields except delimiter - - Revert Builder implementation in CSVFormat - CSVRecord does not verify that the length of the header mapping - matches the number of values - - Allow the handling of NULL values - Use the Builder pattern for CSVFormat - Clarify comment handling - CSVParser.nextValue() seems pointless - Allow the String value for null to be customized for the CSV - printer - - Not possible to create a CSVFormat from scratch - Keep track of record number - Lexer should only use char fields - Need a way to extract parsed headers, e.g. for use in formatting - output - - Header support - Confusing semantic of the ignore leading/trailing spaces parameters - - Add convenience methods to CSVLexer - Is CharBuffer really needed, now that StringBuilder is available? - - Replace while(true)-loop in CSVParser.getRecord with do-while-loop - - CSVFormat describes itself as immutable, but it is not - in - particular it is not thread-safe - - Endless loops in CSV parser - NullPointerException in CSVPrinter.print()/println() - CSVPrinter overhaul - Excel strategy uses wrong separator - CSVStrategy has modifiable public static variables - - Predefined format for MYSQL - Reduce visibility of methods in internal classes - ExtendedBufferedReader does too much - Decide whether to keep the csv.writer subpackage - - - - + + + + + + + + Apache Commons CSV Release Notes + + + + + Remove Spotbugs dependency and use exclude-filter instead #564. + Remove broken website link #577. + Fix Apache RAT plugin console warnings. + [Javadoc] Clarify behavior of deprecated CSVFormat#withFirstRecordAsHeader() #2413. + CSVFormat.equals()/hashCode() ignores maxRows (#600). + ExtendedBufferedReader byte tracking leads to an incorrect CSVRecord.getBytePosition() (#601). + CSVFormat.Builder.setQuote() does not refresh quotedNullString (#2447). + Lexer.isDelimiter() accepts a partial multi-character delimiter at EOF (#603). + CSVParser applies characterOffset to bytePosition (#604). + CSVPrinter Reader printing with quote and escape can emit CSV that its parser cannot read back. + CSVParser applies maxRows to record numbers instead of rows produced when setRecordNumber(...) is used. + CSVParser with trackBytes enabled throws on multi-character delimiters containing supplementary Unicode characters. + CSVFormat.Builder.setNullString(String) can build an invalid quoted null string after setQuote(null). + Escape Reader values with quote and escape (#606). + Clear escape delimiter buffer before peek in Lexer.isEscapeDelimiter() (#608, #611). + Escape quote char in printWithEscapes when QuoteMode is NONE (#609). + Quote value starting with comment marker in minimal quote mode (#610). + Escape leading comment marker in printWithEscapes (#614). + Skip byte counting at EOF in ExtendedBufferedReader.read (#615). + Keep quoted empty trailing field with trailingDelimiter (#616). + Evaluate isDelimiter once in nextToken whitespace skip (#618).. + + Add an "Android Compatibility" section to the web site. + Add CSVParser.Builder.setByteOffset(long) (#604). + + Bump org.apache.commons:commons-parent from 85 to 102 #573, #595. + [test] Bump com.opencsv:opencsv from 5.11.2 to 5.12.0 #558. + Bump org.apache.commons:commons-lang3 from 3.18.0 to 3.20.0. + Bump commons-codec:commons-codec from 1.19.0 to 1.22.0. + Bump commons-io:commons-io from 2.20.0 to 2.22.0 #594. + + + + CSVPrinter.printRecord(Stream) hangs if given a parallel stream. + CSVPrinter now uses an internal lock instead of synchronized methods. + org.apache.commons.csv.CSVPrinter.printRecords(ResultSet) now writes one record at a time using a lock. + + + Bump org.apache.commons:commons-parent from 81 to 85 #542. + Bump commons-io:commons-io from 2.18.0 to 2.20.0. + Bump com.opencsv:opencsv from 5.10 to 5.11.2 #545, #551, #553. + Bump org.apache.commons:commons-lang3 from 3.17.0 to 3.18.0 #556. + Bump commons-codec:commons-codec from 1.18.0 to 1.19.0. + + + + Release history link changed from changes-report.html to changes.html #516. + Remove -nouses directive from maven-bundle-plugin. OSGi package imports now state 'uses' definitions for package imports, this doesn't affect JPMS (from org.apache.commons:commons-parent:80). + CSVParser.parse(URL, Charset, CSVFormat) with a null CSVFormat maps to CSVFormat.DEFAULT (like CSVParser.parse(Reader, CSVFormat)). + CSVParser.parse(String, CSVFormat) with a null CSVFormat maps to CSVFormat.DEFAULT (like CSVParser.parse(Reader, CSVFormat)). + CSVParser.parse(File, Charset, CSVFormat) with a null CSVFormat maps to CSVFormat.DEFAULT (like CSVParser.parse(Reader, CSVFormat)). + CSVParser.parse(Path, Charset, CSVFormat) with a null CSVFormat maps to CSVFormat.DEFAULT (like CSVParser.parse(Reader, CSVFormat)). + CSVParser.parse(InputStream, Charset, CSVFormat) with a null CSVFormat maps to CSVFormat.DEFAULT (like CSVParser.parse(Reader, CSVFormat)). + CSVParser.parse(*) methods with a null Charset maps to Charset.defaultCharset(). + Fix possible NullPointerException in Token.toString(). + + Define and use Maven property commons.jmh.version. + Add CSVFormat.Builder.setMaxRows(long). + Add CSVFormat.getMaxRows(). + CSVPrinter.printRecords(ResultSet) knows how to use CSVFormat's maxRows. + CSVPrinter.printRecords(Iterable) knows how to use CSVFormat's maxRows. + CSVPrinter.printRecords(Stream) knows how to use CSVFormat's maxRows. + CSVParser.stream() knows how to use CSVFormat's maxRows. + CSVParser.getRecords() knows how to use CSVFormat's maxRows. + CSVParser.iterator() knows how to use CSVFormat's maxRows. + + Bump com.opencsv:opencsv from 5.9 to 5.10. + Bump commons-codec:commons-codec from 1.17.2 to 1.18.0 #522. + Bump org.apache.commons:commons-parent from 79 to 81. + + + + Required OSGi Import-Package version numbers in MANIFEST.MF #504. + CSVParser.nextRecord() should throw CSVException (an IOException subclass) instead of IOException and IllegalStateException, no method signature changes needed. + + Add CSVPrinter.getRecordCount(). + Add and use CSVParser.Builder and builder() and deprecate CSVParser constructors. + CSVFormat.Builder implements Supplier<CSVFormat>. + Deprecate CSVFormat.Builder.build() for get(). + Track byte position #502. + + Bump org.apache.commons:commons-parent from 76 to 78 #486, #495. + Bump org.codehaus.mojo:taglist-maven-plugin from 3.1.0 to 3.2.1 #493. + Bump commons-io:commons-io from 2.17.0 to 2.18.0 #505. + Bump commons-codec:commons-codec from 1.17.1 to 1.17.2. + Bump org.apache.commons:commons-parent from 78 to 79. + + + + Add CSVException that extends IOException thrown on invalid input instead of IOException. + + Fix PMD issues for port to PMD 7.1.0. + Fix some Javadoc links #442. + Extract duplicated code into a method #444. + Migrate CSVFormat#print(File, Charset) to NIO #445. + Fix documentation for CSVFormat private constructor #466. + CSVFormat does not support explicit " as escape char. + Escaping is not disableable. + Fix Javadoc warnings on Java 23. + Improve parser performance by up to 20%, YMMV. + + Bump commons-codec:commons-codec from 1.16.1 to 1.17.1 #422, #449. + Bump org.apache.commons:commons-parent from 69 to 76 #435, #452, #465, #468, #475, #482. + Bump org.codehaus.mojo:taglist-maven-plugin from 3.0.0 to 3.1.0 #441. + Bump org.apache.commons:commons-lang3 from 3.14.0 to 3.17.0 #450, #459, #470. + Bump org.hamcrest:hamcrest from 2.2 to 3.0 #455. + Bump commons-io:commons-io from 2.16.1 to 2.17.0 #476. + + + + [Javadoc] Add example to CSVFormat#setHeaderComments() #344. + Add and use CSVFormat#setTrailingData(boolean) in CSVFormat.EXCEL for Excel compatibility #303. + Add and use CSVFormat#setLenientEof(boolean) in CSVFormat.EXCEL for Excel compatibility #303. + + Replace deprecated method in user guide, update external link #324, #325. + Document duplicate header behavior #309. + Add missing docs #328. + [StepSecurity] CI: Harden GitHub Actions #329, #330. + Better error message during faulty CSV record read #347. + Misleading error message when QuoteMode set to None #352. + OutOfMemory for very long rows despite using column value of type Reader. + Use try-with-resources to manage JDBC CLOB in CSVPrinter.printRecords(ResultSet). + JDBC Blob columns are now output as Base64 instead of Object#toString(), which usually is InputStream#toString(). + Support unusual Excel use cases: Add support for trailing data after the closing quote, and EOF without a final closing quote #303. + MongoDB CSV empty first column parsing fix #412. + + Bump commons-io:commons-io: from 2.11.0 to 2.16.1 #408, #413. + Bump commons-parent from 57 to 69 #410. + Bump h2 from 2.1.214 to 2.2.224 #333, #349, #359. + Bump commons-lang3 from 3.12.0 to 3.14.0. + Update exception message in CSVRecord#getNextRecord() #348. + Bump tests using com.opencsv:opencsv from 5.8 to 5.9 #373. + + + + Minor changes #172. + No Automatic-Module-Name prevents usage in JPMS projects without repacking the JAR. + Fix for multi-char delimiter not working as expected #218. + CSVRecord.get(Enum) should use Enum.name() instead of Enum.toString(). + Allow org.apache.commons.csv.IOUtils.copy(Reader, Appendable, CharBuffer) to compile on Java 11 and run on Java 8. + CSVRecord.toList() does not give write access to the new List. + CSVParser.getRecords() now throws UncheckedIOException instead of IOException. + Add comments to iterator() and stream() #270. + Fix wrong assumptions in PostgreSQL formats #265. + Validate input to setDelimiter(String) for empty string #266. + Bump CSVFormat#serialVersionUID from 1 to 2. + CSVParser: Identify duplicates in null, empty and blank header names #279. + + Serialization in CSVFormat is not supported from one version to the next. + + Make CSVRecord#values() public. + Add DuplicateHeaderMode for flexibility with header strictness. #114. + Support for parallelism in CSVPrinter. + Add CSVPrinter.printRecord[s](Stream). + Add accessors for header/trailer comments #257. + Add github/codeql-action. + + Bump actions/cache from 2.1.6 to 3.0.10 #196, #233, #243, #267, #271. + Bump actions/checkout from 2.3.4 to 3.1.0 #188, #195, #220, #272. + Bump actions/setup-java from 2 to 3.5.1. + Bump actions/upload-artifact from 3.1.0 to 3.1.1 #280. + Bump commons-parent from 52 to 57 #264, #288, #298, #323. + Bump checkstyle from 8.44 to 9.2.1 #180, #190, #194, #202, #207. + Bump junit-jupiter from 5.8.0-M1 to 5.9.1 #179, #186, #201, #244, #263. + Bump jmh-core from 1.32 to 1.36 #176, #208, #229, #285. + Bump jmh-generator-annprocess from 1.32 to 1.36 #175, #206, #226, #283. + Bump mockito-core from 3.11.2 to 4.11.0 #187, #197, #204, #212, #230, #237, #251, #259, #284, #292, #297. + Bump maven-pmd-plugin from 3.14.0 to 3.19.0 #184, #219, #238, #254, #258. + Bump pmd from 6.36.0 to 6.52.0 #173, #189, #193, #199, #227, #233, #214, #236, #240, #247, #255, #273. + Bump opencsv from 5.5.1 to 5.7.1 #182, #221, #260, #281. + Bump spotbugs-maven-plugin from 4.3.0 to 4.7.3.0 #192, #198, #203, #211, #225, #234, #242, #245, #261, #275, #282. + Bump com.github.spotbugs:spotbugs from 4.5.3 to 4.7.2. + Bump h2 from 1.4.200 to 2.1.214 #200, #205, #213, #239. + Bump maven-javadoc-plugin from 3.3.0 to 3.4.1. + Bump biz.aQute.bnd:biz.aQute.bndlib from 5.3.0 to 6.3.1. + Bump jacoco-maven-plugin from 0.8.7 to 0.8.8. + Bump japicmp-maven-plugin from 0.15.3 to 0.16.0. + Bump maven-checkstyle-plugin from 3.1.2 to 3.2.0 #253. + + + + Replace FindBugs with SpotBugs #56. + Javadoc typo in CSVFormat let's -> lets #57. + CSVFormat.printWithEscapes throws StringIndexOutOfBoundsException when value is Reader #61. + Improve CSVFormat test coverage #63. + Fix CSVFileParserTest.java to allow for a null return value from record.getComment() #62. + Improve test coverage in CSVFormatTest #65. + Removed invalid Javadoc markup for CSVFormat EXCEL #64. + Improve CSVRecord and CSVPrinter code coverage #66. + Improve lexer and token coverage #67. + CSVFormat.format trims last delimiter if the delimiter is a white space #71. + Replace org.apache.commons.csv.Assertions.notNull() with Objects.requireNonNull(). + Line number is not proper at EOF. + Parser iterates over the last CSV Record twice. + Minor improvements #126, #127, #130. + Add possibility to use ResultSet header meta data as CSV header #11. + Add test cases for withIgnoreSurroundingSpaces() and withTrim() #70. + Update CSVParser.parse(File, Charset, CSVFormat) from IO to NIO. + Missing separator with print(object) followed by printRecord(Object[]) #157. + Fix EOL checking for read array in ExtendedBufferedReader #5. + Print from Reader with embedded quotes generates incorrect output #78. + Replace JUnit assert by simpler but equivalent calls. #159. + Update gitignore to ignore idea and vscode #160. + Update CSVBenchmark #165. + Remove Whitespace Check Determines Delimiter Twice #167. + Document and Automate CSV Benchmark Harness #166. + Optimize Lexer Delimiter Check for One Character Delimiter #163. + SpotBugs Error: Medium: org.apache.commons.csv.CSVParser.getHeaderNames() may expose internal representation by returning CSVParser.headerNames [org.apache.commons.csv.CSVParser] At CSVParser.java:[line 599] EI_EXPOSE_REP. + SpotBugs Error: Medium: new org.apache.commons.csv.CSVParser(Reader, CSVFormat, long, long) may expose internal representation by storing an externally mutable object into CSVParser.format [org.apache.commons.csv.CSVParser] At CSVParser.java:[line 433] EI_EXPOSE_REP2. + SpotBugs Error: Medium: new org.apache.commons.csv.CSVParser(Reader, CSVFormat, long, long) may expose internal representation by storing an externally mutable object into CSVParser.headerMap [org.apache.commons.csv.CSVParser] At CSVParser.java:[line 437] EI_EXPOSE_REP2. + SpotBugs Error: Medium: new org.apache.commons.csv.CSVParser(Reader, CSVFormat, long, long) may expose internal representation by storing an externally mutable object into CSVParser.headerNames [org.apache.commons.csv.CSVParser] At CSVParser.java:[line 438] EI_EXPOSE_REP2. + SpotBugs Error: Medium: new org.apache.commons.csv.CSVPrinter(Appendable, CSVFormat) may expose internal representation by storing an externally mutable object into CSVPrinter.format [org.apache.commons.csv.CSVPrinter] At CSVPrinter.java:[line 100] EI_EXPOSE_REP2. + Formalize PerformanceTest #168. + Reuse Buffers in Lexer for Delimiter Detection #162. + Cleanup and Document Performance Test Harness #170. + Update buffer position when reading line comment #120. + + Make CSVRecord#toList() public. + Add CSVRecord#stream(). + Add CSVParser#stream(). + Make the method CSVRecord.putIn(Map) public. + Add test cases for CSVRecord with get(Enum) and toString. #54. + Add and use CSVFormat.Builder, deprecated CSVFormat#with methods, based on #73. + Add support for String delimiters #76. + + Update org.junit.jupiter:junit-jupiter from 5.6.0 to 5.7.0, #84 #109 + Update tests from Apache Commons Lang 3.9 to 3.12.0. + Update tests from commons-io:commons-io 2.6 to 2.11.0, #108. + Bump actions/checkout from v1 to v2.3.4, #79, #92, #121. + Bump commons-parent from 50 to 51 #80. + Bump tests from opencsv from 3.1 to 5.5.1 #81, #137, #158. + Update tests from super-csv from 2.2.1 to 2.4.0 #86. + Bump build actions/setup-java from v1.4.0 to v2, #101, #113. + Bump maven-pmd-plugin from 3.13.0 to 3.14.0 #122. + Bump tests from org.mockito:mockito-core 3.2.4 -> 3.11.2; #88, #107, #110, #123, #128, #129, #156. + Bump actions/cache from v2 to v2.1.6 #132, #153. + Bump maven-checkstyle-plugin from 3.0.0 to 3.1.2 #131. + Bump checkstyle from 8.29 to 8.44. + Bump junit-jupiter from 5.7.0 to 5.8.0-M1 #133, #149. + Bump commons.jacoco.version from 0.8.5 to 0.8.7 (Java 16). + Bump commons.spotbugs.version from 4.0.4 to 4.3.0 (Java 16). + Bump maven-javadoc-plugin from 3.2.0 to 3.3.0. + Bump jmh-generator-annprocess from 1.5.2 to 1.32 #151. + Bump PMD core from 6.29.0 to 6.36.0. + Bump biz.aQute.bnd:biz.aQute.bndlib from 5.1.2 to 5.3.0. + + + Add CSVRecord.isSet(int) method #52. + Char escape doesn't work properly with quoting. + Test case failures following CSVFormat#equals() update. + CSVFormat withTrim() and withIgnoreSurroundingSpaces() need better docs. + CSVFormat equals() and hashCode() don't use all fields. + CSVFormat#validate() does not account for allowDuplicateHeaderNames #43. + Post 1.7 release fixes. + Upgrade test framework to JUnit 5 Jupiter #49, #50. + A single empty header is allowed when not allowing empty column headers. #47. + CSVRecord is not Serializable. + Use test scope for supercsv #48. + Update tests from H2 1.4.199 to 1.4.200. + Update tests from Hamcrest 2.1 to 2.2. + Update tests from Mockito 3.1.0 to 3.2.4. + Fix typos in site and test #53. + Fix typo performance test #55. + + + Add predefined CSVFormats for printing MongoDB CSV and TSV. + Fix escape character for POSTGRESQL_TEXT and POSTGRESQL_CSV formats. + Site link "Source Repository" does not work. + Add support for java.sql.Clob. + Update to Java 8. + Escape quotes in CLOBs #39. + Cannot get headers in column order from CSVRecord. + Update tests from H2 1.4.198 to 1.4.199. + + + Add more documentation to CSVPrinter. + Add autoFlush option for CsvPrinter. PR #24. + The behavior of quote char using is not similar as Excel does when the first string contains CJK char(s). + Don't quote cells just because they have UTF-8 encoded characters. + Add API org.apache.commons.csv.CSVFormat.withSystemRecordSeparator(). + Inconsistency between Javadoc of CSVFormat DEFAULT EXCEL. + Create CSVFormat.ORACLE preset. + Some multi-iterator parsing peek sequences incorrectly consume elements. + Parse method should avoid creating a redundant BufferedReader. + Add predefined CSVFormats for printing MongoDB CSV and TSV. + + + withNullString value is printed without quotes when QuoteMode.ALL is specified; add QuoteMode.ALL_NON_NULL. PR #17. + Fix outdated comments about FileReader in CSVParser #13 + Fix incorrect method name 'withFirstRowAsHeader' in user guide. + Negative numeric values in the first column are always quoted in minimal mode. + Update platform requirement from Java 6 to 7. + Do not use RuntimeException in CSVParser.iterator().new Iterator() {...}.getNextRecord() + CSVParser: Add factory method accepting InputStream. + Add convenience API CSVFormat.print(File, Charset) + Add convenience API CSVFormat.print(Path, Charset) + Add convenience API CSVParser.parse(Path, Charset, CSVFormat) + Add convenience API CSVFormat#printer() to print to System.out + Provide a CSV Format for printing PostgreSQL CSV and Text formats. + Adding a placeholder in the Lexer and CSV parser to store the end-of-line string. + + + Make CSVPrinter.print(Object) GC-free. + Allow some printing operations directly from CSVFormat. + Drop ferc.gov tests. + + + Add shortcut method for using first record as header to CSVFormat + Add withHeader(Class<? extends Enum>) to CSVFormat + Comment line hides next record; update Javadoc to make behavior clear + CSVPrinter doesn't skip creation of header record if skipHeaderRecord is set to true + Add IgnoreCase option for accessing header names + The null string should be case-sensitive when reading records + CSVFormat.nullString should not be escaped + CSVFormat.MYSQL nullString should be "\N" + Fix Javadoc to say CSVFormat with() methods return a new CSVFormat + Support for ignoring trailing delimiter. + Support trimming leading and trailing blanks. + Create default formats for Informix UNLOAD and UNLOAD CSV. + + + CSVFormat.with* methods clear the header comments + Incorrect Javadoc on QuoteMode.NONE + Add enum CSVFormat.Predefined that contains the default CSVFormat values. + + + QuoteMode.NON_NUMERIC doesn't work with CSVPrinter.printRecords(ResultSet) + CSVFormat#withHeader doesn't work well with #printComment, add withHeaderComments(String...) + CSVFormat.EXCEL should ignore empty header names + Incorrect Javadoc referencing org.apache.commons.csv.CSVFormat withQuote() + Improve toString() implementation of CSVRecord + Unified parameter validation + Add CSVFormat#with 0-arg methods matching boolean arg methods + Save positions of records to enable random access + CSVPrinter.printRecord(ResultSet) with metadata + + + No longer works with Java 6 + NullPointerException when empty header string and null string of "" + Validate format parameters in constructor + IllegalArgumentException thrown when the header contains duplicate names when the column names are empty. + CSVFormat#withHeader doesn't work with CSVPrinter + CSVFormat is missing a print(...) method + CSVRecord.toMap() throws NPE on formats with no + headers. + Check whether ISE/IAE are being used appropriately + CSVFormat constructor should reject a header array with duplicate + entries + + HeaderMap is inconsistent when it is parsed from an input with + duplicate columns names + + CSVRecord.toMap() fails if row length shorter than header length + + CSVFormat.format allways append null + Add Map conversion API to CSVRecord + CSVParser: getHeaderMap throws NPE + Lots of possible changes + Use Character instead of char for char fields except delimiter + + Revert Builder implementation in CSVFormat + CSVRecord does not verify that the length of the header mapping + matches the number of values + + Allow the handling of NULL values + Use the Builder pattern for CSVFormat + Clarify comment handling + CSVParser.nextValue() seems pointless + Allow the String value for null to be customized for the CSV + printer + + Not possible to create a CSVFormat from scratch + Keep track of record number + Lexer should only use char fields + Need a way to extract parsed headers, e.g. for use in formatting + output + + Header support + Confusing semantic of the ignore leading/trailing spaces parameters + + Add convenience methods to CSVLexer + Is CharBuffer really needed, now that StringBuilder is available? + + Replace while(true)-loop in CSVParser.getRecord with do-while-loop + + CSVFormat describes itself as immutable, but it is not - in + particular it is not thread-safe + + Endless loops in CSV parser + NullPointerException in CSVPrinter.print()/println() + CSVPrinter overhaul + Excel strategy uses wrong separator + CSVStrategy has modifiable public static variables + + Predefined format for MYSQL + Reduce visibility of methods in internal classes + ExtendedBufferedReader does too much + Decide whether to keep the csv.writer subpackage + + + + diff --git a/src/changes/release-notes.vm b/src/changes/release-notes.vm index a10171fc5f..5769829552 100644 --- a/src/changes/release-notes.vm +++ b/src/changes/release-notes.vm @@ -6,7 +6,7 @@ ## "License"); you may not use this file except in compliance ## with the License. You may obtain a copy of the License at ## -## http://www.apache.org/licenses/LICENSE-2.0 +## https://www.apache.org/licenses/LICENSE-2.0 ## ## Unless required by applicable law or agreed to in writing, ## software distributed under the License is distributed on an @@ -15,19 +15,21 @@ ## specific language governing permissions and limitations ## under the License. ## -${project.name} -Version ${version} -Release Notes +${project.name} ${version} Release Notes +------------------------------------------------ -This document contains the release notes for the ${version} version of Apache Commons CSV. -Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format. +The ${developmentTeam} is pleased to announce the release of ${project.name} ${version}. + + +This document contains the release notes for the ${version} version of ${project.name}. +Commons CSV reads and writes files in Comma Separated Value (CSV) format variations. Commons CSV requires at least Java 8. $introduction.replaceAll("(? - - - - - - - - - - - - - - - - - - - + + + + + + - + - - + + + + - - + + + + + + + + + + + + + - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + - - + - diff --git a/src/main/java/org/apache/commons/csv/CSVException.java b/src/main/java/org/apache/commons/csv/CSVException.java index 79e488234f..a986148f34 100644 --- a/src/main/java/org/apache/commons/csv/CSVException.java +++ b/src/main/java/org/apache/commons/csv/CSVException.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv; diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java b/src/main/java/org/apache/commons/csv/CSVFormat.java index 63eaa44eae..7145d23d3b 100644 --- a/src/main/java/org/apache/commons/csv/CSVFormat.java +++ b/src/main/java/org/apache/commons/csv/CSVFormat.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv; @@ -41,6 +43,7 @@ import org.apache.commons.codec.binary.Base64OutputStream; import org.apache.commons.io.IOUtils; +import org.apache.commons.io.function.IOStream; import org.apache.commons.io.function.Uncheck; import org.apache.commons.io.output.AppendableOutputStream; @@ -91,7 +94,7 @@ *

* *
{@code
- * CSVFormat.EXCEL.withNullString("N/A").withIgnoreSurroundingSpaces(true);
+ * CSVFormat.EXCEL.builder().setNullString("N/A").setIgnoreSurroundingSpaces(true).get();
  * }
* *

Defining column names

@@ -101,7 +104,7 @@ *

* *
{@code
- * CSVFormat.EXCEL.withHeader("Col1", "Col2", "Col3");
+ * CSVFormat.EXCEL.builder().setHeader("Col1", "Col2", "Col3").get();
  * }
* *

@@ -120,7 +123,7 @@ * *

{@code
  * Reader in = ...;
- * CSVFormat.EXCEL.withHeader("Col1", "Col2", "Col3").parse(in);
+ * CSVFormat.EXCEL.builder().setHeader("Col1", "Col2", "Col3").get().parse(in);
  * }
* *

@@ -135,7 +138,7 @@ *

* *
- * CSVFormat.EXCEL.withHeader();
+ * CSVFormat.EXCEL.builder().setHeader().get();
  * 
* *

@@ -154,18 +157,18 @@ * *

Serialization

*

- * This class implements the {@link Serializable} interface with the following caveats: + * This class implements the {@link Serializable} interface with the following caveats: *

*
    - *
  • This class will no longer implement Serializable in 2.0.
  • - *
  • Serialization is not supported from one version to the next.
  • + *
  • This class will no longer implement Serializable in 2.0.
  • + *
  • Serialization is not supported from one version to the next.
  • *
*

- * The {@code serialVersionUID} values are: + * The {@code serialVersionUID} values are: *

*
    - *
  • Version 1.10.0: {@code 2L}
  • - *
  • Version 1.9.0 through 1.0: {@code 1L}
  • + *
  • Version 1.10.0: {@code 2L}
  • + *
  • Version 1.9.0 through 1.0: {@code 1L}
  • *
* *

Notes

@@ -186,19 +189,41 @@ public final class CSVFormat implements Serializable { public static class Builder implements Supplier { /** - * Creates a new default builder. + * Creates a new default builder, as for {@link #RFC4180} but allowing empty lines. + * + *

+ * The {@link Builder} settings are: + *

+ *
    + *
  • {@link Builder#setDelimiter(char) setDelimiter}{@code (',')}
  • + *
  • {@link Builder#setQuote(char) setQuote}{@code ('"')}
  • + *
  • {@link Builder#setRecordSeparator(String) setRecordSeparator}{@code ("\r\n")}
  • + *
  • {@link Builder#setIgnoreEmptyLines(boolean) setIgnoreEmptyLines}{@code (true)}
  • + *
  • {@link Builder#setDuplicateHeaderMode(DuplicateHeaderMode) setDuplicateHeaderMode}{@code (DuplicateHeaderMode.ALLOW_ALL)}
  • + *
  • All other values take their Java defaults, {@code false} for booleans, {@code null} for object references.
  • + *
+ * + * @see Predefined#Default + * @see DuplicateHeaderMode#ALLOW_ALL * * @return a copy of the builder */ public static Builder create() { - return new Builder(DEFAULT); + // @formatter:off + return new Builder() + .setDelimiter(Constants.COMMA) + .setQuote(Constants.DOUBLE_QUOTE_CHAR) + .setRecordSeparator(Constants.CRLF) + .setIgnoreEmptyLines(true) + .setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_ALL); + // @formatter:on } /** - * Creates a new builder for the given format. + * Creates a new builder from the given format. * * @param csvFormat the source format. - * @return a copy of the builder + * @return a new builder. */ public static Builder create(final CSVFormat csvFormat) { return new Builder(csvFormat); @@ -246,28 +271,36 @@ public static Builder create(final CSVFormat csvFormat) { private boolean trim; + /** The maximum number of rows to process, excluding the header row. */ + private long maxRows; + + private Builder() { + // empty + } + private Builder(final CSVFormat csvFormat) { - this.delimiter = csvFormat.delimiter; - this.quoteCharacter = csvFormat.quoteCharacter; - this.quoteMode = csvFormat.quoteMode; + this.allowMissingColumnNames = csvFormat.allowMissingColumnNames; + this.autoFlush = csvFormat.autoFlush; this.commentMarker = csvFormat.commentMarker; + this.delimiter = csvFormat.delimiter; + this.duplicateHeaderMode = csvFormat.duplicateHeaderMode; this.escapeCharacter = csvFormat.escapeCharacter; - this.ignoreSurroundingSpaces = csvFormat.ignoreSurroundingSpaces; - this.allowMissingColumnNames = csvFormat.allowMissingColumnNames; - this.ignoreEmptyLines = csvFormat.ignoreEmptyLines; - this.recordSeparator = csvFormat.recordSeparator; - this.nullString = csvFormat.nullString; this.headerComments = csvFormat.headerComments; this.headers = csvFormat.headers; - this.skipHeaderRecord = csvFormat.skipHeaderRecord; + this.ignoreEmptyLines = csvFormat.ignoreEmptyLines; this.ignoreHeaderCase = csvFormat.ignoreHeaderCase; + this.ignoreSurroundingSpaces = csvFormat.ignoreSurroundingSpaces; this.lenientEof = csvFormat.lenientEof; + this.maxRows = csvFormat.maxRows; + this.nullString = csvFormat.nullString; + this.quoteCharacter = csvFormat.quoteCharacter; + this.quoteMode = csvFormat.quoteMode; + this.quotedNullString = csvFormat.quotedNullString; + this.recordSeparator = csvFormat.recordSeparator; + this.skipHeaderRecord = csvFormat.skipHeaderRecord; this.trailingData = csvFormat.trailingData; this.trailingDelimiter = csvFormat.trailingDelimiter; this.trim = csvFormat.trim; - this.autoFlush = csvFormat.autoFlush; - this.quotedNullString = csvFormat.quotedNullString; - this.duplicateHeaderMode = csvFormat.duplicateHeaderMode; } /** @@ -338,8 +371,7 @@ public Builder setAutoFlush(final boolean autoFlush) { * Comments are printed first, before headers. *

*

- * Use {@link #setCommentMarker(char)} or {@link #setCommentMarker(Character)} to set the comment marker written at the start of - * each comment line. + * Use {@link #setCommentMarker(char)} or {@link #setCommentMarker(Character)} to set the comment marker written at the start of each comment line. *

*

* If the comment marker is not set, then the header comments are ignored. @@ -347,13 +379,14 @@ public Builder setAutoFlush(final boolean autoFlush) { *

* For example: *

+ * *
-         * builder.setCommentMarker('#')
-         *        .setHeaderComments("Generated by Apache Commons CSV", Instant.ofEpochMilli(0));
+         * builder.setCommentMarker('#').setHeaderComments("Generated by Apache Commons CSV", Instant.ofEpochMilli(0));
          * 
*

* writes: *

+ * *
          * # Generated by Apache Commons CSV.
          * # 1970-01-01T00:00:00Z
@@ -377,8 +410,7 @@ public Builder setCommentMarker(final char commentMarker) {
          * Comments are printed first, before headers.
          * 

*

- * Use {@link #setCommentMarker(char)} or {@link #setCommentMarker(Character)} to set the comment marker written at the start of - * each comment line. + * Use {@link #setCommentMarker(char)} or {@link #setCommentMarker(Character)} to set the comment marker written at the start of each comment line. *

*

* If the comment marker is not set, then the header comments are ignored. @@ -386,13 +418,14 @@ public Builder setCommentMarker(final char commentMarker) { *

* For example: *

+ * *
-         * builder.setCommentMarker('#')
-         *        .setHeaderComments("Generated by Apache Commons CSV", Instant.ofEpochMilli(0));
+         * builder.setCommentMarker('#').setHeaderComments("Generated by Apache Commons CSV", Instant.ofEpochMilli(0));
          * 
*

* writes: *

+ * *
          * # Generated by Apache Commons CSV.
          * # 1970-01-01T00:00:00Z
@@ -445,8 +478,8 @@ public Builder setDelimiter(final String delimiter) {
          * @since 1.10.0
          */
         public Builder setDuplicateHeaderMode(final DuplicateHeaderMode duplicateHeaderMode) {
-          this.duplicateHeaderMode = Objects.requireNonNull(duplicateHeaderMode, "duplicateHeaderMode");
-          return this;
+            this.duplicateHeaderMode = Objects.requireNonNull(duplicateHeaderMode, "duplicateHeaderMode");
+            return this;
         }
 
         /**
@@ -578,6 +611,9 @@ public Builder setHeader(final ResultSetMetaData resultSetMetaData) throws SQLEx
          * 

* The header is also used by the {@link CSVPrinter}. *

+ *

+ * This method keeps a copy of the input array. + *

* * @param header the header, {@code null} if disabled, empty if parsed automatically, user-specified otherwise. * @return This instance. @@ -596,8 +632,7 @@ public Builder setHeader(final String... header) { * Comments are printed first, before headers. *

*

- * Use {@link #setCommentMarker(char)} or {@link #setCommentMarker(Character)} to set the comment marker written at the start of - * each comment line. + * Use {@link #setCommentMarker(char)} or {@link #setCommentMarker(Character)} to set the comment marker written at the start of each comment line. *

*

* If the comment marker is not set, then the header comments are ignored. @@ -605,17 +640,21 @@ public Builder setHeader(final String... header) { *

* For example: *

+ * *
-         * builder.setCommentMarker('#')
-         *        .setHeaderComments("Generated by Apache Commons CSV", Instant.ofEpochMilli(0));
+         * builder.setCommentMarker('#').setHeaderComments("Generated by Apache Commons CSV", Instant.ofEpochMilli(0));
          * 
*

* writes: *

+ * *
          * # Generated by Apache Commons CSV.
          * # 1970-01-01T00:00:00Z
          * 
+ *

+ * This method keeps a copy of the input array. + *

* * @param headerComments the headerComments which will be printed by the Printer before the CSV data. * @return This instance. @@ -634,8 +673,7 @@ public Builder setHeaderComments(final Object... headerComments) { * Comments are printed first, before headers. *

*

- * Use {@link #setCommentMarker(char)} or {@link #setCommentMarker(Character)} to set the comment marker written at the start of - * each comment line. + * Use {@link #setCommentMarker(char)} or {@link #setCommentMarker(Character)} to set the comment marker written at the start of each comment line. *

*

* If the comment marker is not set, then the header comments are ignored. @@ -643,17 +681,21 @@ public Builder setHeaderComments(final Object... headerComments) { *

* For example: *

+ * *
-         * builder.setCommentMarker('#')
-         *        .setHeaderComments("Generated by Apache Commons CSV", Instant.ofEpochMilli(0).toString());
+         * builder.setCommentMarker('#').setHeaderComments("Generated by Apache Commons CSV", Instant.ofEpochMilli(0).toString());
          * 
*

* writes: *

+ * *
          * # Generated by Apache Commons CSV.
          * # 1970-01-01T00:00:00Z
          * 
+ *

+ * This method keeps a copy of the input array. + *

* * @param headerComments the headerComments which will be printed by the Printer before the CSV data. * @return This instance. @@ -710,6 +752,21 @@ public Builder setLenientEof(final boolean lenientEof) { return this; } + /** + * Sets the maximum number of rows to process, excluding the header row. + *

+ * Values less than or equal to 0 mean no limit. + *

+ * + * @param maxRows the maximum number of rows to process, excluding the header row. + * @return This instance. + * @since 1.14.0 + */ + public Builder setMaxRows(final long maxRows) { + this.maxRows = maxRows; + return this; + } + /** * Sets the String to convert to and from {@code null}. No substitution occurs if {@code null}. * @@ -723,8 +780,7 @@ public Builder setLenientEof(final boolean lenientEof) { */ public Builder setNullString(final String nullString) { this.nullString = nullString; - this.quotedNullString = quoteCharacter + nullString + quoteCharacter; - return this; + return setQuotedNullString(); } /** @@ -746,9 +802,15 @@ public Builder setQuote(final char quoteCharacter) { */ public Builder setQuote(final Character quoteCharacter) { if (isLineBreak(quoteCharacter)) { - throw new IllegalArgumentException("The quoteChar cannot be a line break"); + throw new IllegalArgumentException("The quoteCharacter cannot be a line break"); } this.quoteCharacter = quoteCharacter; + return setQuotedNullString(); + } + + private Builder setQuotedNullString() { + final Character quote = quoteCharacter != null ? quoteCharacter : Constants.DOUBLE_QUOTE_CHAR; + this.quotedNullString = quote + nullString + quote; return this; } @@ -821,6 +883,16 @@ public Builder setTrailingData(final boolean trailingData) { /** * Sets whether to add a trailing delimiter. * + *

+ * When writing, a delimiter is appended after the last value of each record. When reading, the empty field + * that such a trailing delimiter produces is dropped so the output round-trips back to the original record; + * a quoted empty trailing field ({@code ""}) is a real value rather than a trailing delimiter and is kept. + *

+ *

+ * This is unrelated to {@link #setTrailingData(boolean) trailing data}, which controls whether characters + * after the closing quote of an encapsulated value are tolerated when reading. + *

+ * * @param trailingDelimiter whether to add a trailing delimiter. * @return This instance. */ @@ -829,6 +901,7 @@ public Builder setTrailingDelimiter(final boolean trailingDelimiter) { return this; } + /** * Sets whether to trim leading and trailing blanks. * @@ -842,7 +915,7 @@ public Builder setTrim(final boolean trim) { } /** - * Predefines formats. + * Enumerates predefines formats. * * @since 1.2 */ @@ -954,49 +1027,49 @@ public CSVFormat getFormat() { } /** - * Standard Comma Separated Value format, as for {@link #RFC4180} but allowing - * empty lines. + * Standard Comma Separated Value format, as for {@link #RFC4180} but allowing empty lines. * *

* The {@link Builder} settings are: *

*
    - *
  • {@code setDelimiter(',')}
  • - *
  • {@code setQuote('"')}
  • - *
  • {@code setRecordSeparator("\r\n")}
  • - *
  • {@code setIgnoreEmptyLines(true)}
  • - *
  • {@code setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_ALL)}
  • + *
  • {@link Builder#setDelimiter(char) setDelimiter}{@code (',')}
  • + *
  • {@link Builder#setQuote(char) setQuote}{@code ('"')}
  • + *
  • {@link Builder#setRecordSeparator(String) setRecordSeparator}{@code ("\r\n")}
  • + *
  • {@link Builder#setIgnoreEmptyLines(boolean) setIgnoreEmptyLines}{@code (true)}
  • + *
  • {@link Builder#setDuplicateHeaderMode(DuplicateHeaderMode) setDuplicateHeaderMode}{@code (DuplicateHeaderMode.ALLOW_ALL)}
  • *
* * @see Predefined#Default + * @see DuplicateHeaderMode#ALLOW_ALL */ - public static final CSVFormat DEFAULT = new CSVFormat(Constants.COMMA, Constants.DOUBLE_QUOTE_CHAR, null, null, null, false, true, Constants.CRLF, null, - null, null, false, false, false, false, false, false, DuplicateHeaderMode.ALLOW_ALL, false, false); + public static final CSVFormat DEFAULT = new CSVFormat(Builder.create()); /** - * Excel file format (using a comma as the value delimiter). Note that the actual value delimiter used by Excel is locale-dependent, it might be necessary - * to customize this format to accommodate your regional settings. + * Microsoft Excel file + * format (using a comma as the value delimiter). Note that the actual value delimiter used by Excel is locale-dependent, it might be necessary to customize + * this format to accommodate your regional settings. * *

* For example for parsing or generating a CSV file on a French system the following format will be used: *

* *
-     * CSVFormat fmt = CSVFormat.EXCEL.withDelimiter(';');
+     * CSVFormat format = CSVFormat.EXCEL.builder().setDelimiter(';').get();
      * 
* *

- * The {@link Builder} settings are: + * The {@link Builder} settings are the {@link #DEFAULT} with: *

*
    - *
  • {@code setDelimiter(',')}
  • - *
  • {@code setQuote('"')}
  • - *
  • {@code setRecordSeparator("\r\n")}
  • - *
  • {@code setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_ALL)}
  • - *
  • {@code setIgnoreEmptyLines(false)}
  • - *
  • {@code setAllowMissingColumnNames(true)}
  • - *
  • {@code setTrailingData(true)}
  • - *
  • {@code setLenientEof(true)}
  • + *
  • {@link Builder#setDelimiter(char) setDelimiter}{@code (',')}
  • + *
  • {@link Builder#setQuote(char) setQuote}{@code ('"')}
  • + *
  • {@link Builder#setRecordSeparator(String) setRecordSeparator}{@code ("\r\n")}
  • + *
  • {@link Builder#setDuplicateHeaderMode(DuplicateHeaderMode) setDuplicateHeaderMode}{@code (DuplicateHeaderMode.ALLOW_ALL)}
  • + *
  • {@link Builder#setIgnoreEmptyLines(boolean) setIgnoreEmptyLines}{@code (false)}
  • + *
  • {@link Builder#setAllowMissingColumnNames(boolean) setAllowMissingColumnNames}{@code (true)}
  • + *
  • {@link Builder#setTrailingData(boolean) setTrailingData}{@code (true)}
  • + *
  • {@link Builder#setLenientEof(boolean) setLenientEof}{@code (true)}
  • *
*

* Note: This is currently like {@link #RFC4180} plus {@link Builder#setAllowMissingColumnNames(boolean) Builder#setAllowMissingColumnNames(true)} and @@ -1004,6 +1077,9 @@ public CSVFormat getFormat() { *

* * @see Predefined#Excel + * @see DuplicateHeaderMode#ALLOW_ALL + * @see Microsoft Excel + * */ // @formatter:off public static final CSVFormat EXCEL = DEFAULT.builder() @@ -1015,7 +1091,8 @@ public CSVFormat getFormat() { // @formatter:on /** - * Default Informix CSV UNLOAD format used by the {@code UNLOAD TO file_name} operation. + * Default Informix CSV UNLOAD + * format used by the {@code UNLOAD TO file_name} operation. * *

* This is a comma-delimited format with an LF character as the line separator. Values are not quoted and special characters are escaped with {@code '\'}. @@ -1023,18 +1100,17 @@ public CSVFormat getFormat() { *

* *

- * The {@link Builder} settings are: + * The {@link Builder} settings are the {@link #DEFAULT} with: *

*
    - *
  • {@code setDelimiter(',')}
  • - *
  • {@code setEscape('\\')}
  • - *
  • {@code setQuote("\"")}
  • - *
  • {@code setRecordSeparator('\n')}
  • + *
  • {@link Builder#setDelimiter(char) setDelimiter}{@code (',')}
  • + *
  • {@link Builder#setEscape(char) setEscape}{@code ('\\')}
  • + *
  • {@link Builder#setQuote(char) setQuote}{@code ('\"')}
  • + *
  • {@link Builder#setRecordSeparator(char) setRecordSeparator}{@code ('\n')}
  • *
* * @see Predefined#MySQL - * @see - * http://www.ibm.com/support/knowledgecenter/SSBJG3_2.5.0/com.ibm.gen_busug.doc/c_fgl_InOutSql_UNLOAD.htm + * @see Informix CSV UNLOAD * @since 1.3 */ // @formatter:off @@ -1047,7 +1123,8 @@ public CSVFormat getFormat() { // @formatter:on /** - * Default Informix CSV UNLOAD format used by the {@code UNLOAD TO file_name} operation (escaping is disabled.) + * Default Informix CSV UNLOAD + * format used by the {@code UNLOAD TO file_name} operation (escaping is disabled.) * *

* This is a comma-delimited format with an LF character as the line separator. Values are not quoted and special characters are escaped with {@code '\'}. @@ -1055,12 +1132,12 @@ public CSVFormat getFormat() { *

* *

- * The {@link Builder} settings are: + * The {@link Builder} settings are the {@link #DEFAULT} with: *

*
    - *
  • {@code setDelimiter(',')}
  • - *
  • {@code setQuote("\"")}
  • - *
  • {@code setRecordSeparator('\n')}
  • + *
  • {@link Builder#setDelimiter(char) setDelimiter}{@code (',')}
  • + *
  • {@link Builder#setQuote(char) setQuote}{@code ('\"')}
  • + *
  • {@link Builder#setRecordSeparator(char) setRecordSeparator}{@code ('\n')}
  • *
* * @see Predefined#MySQL @@ -1089,22 +1166,21 @@ public CSVFormat getFormat() { *

* As of 2024-04-05, the MongoDB documentation for {@code mongoimport} states: *

- *
The csv parser accepts that data that complies with RFC RFC-4180. - * As a result, backslashes are not a valid escape character. If you use double-quotes to enclose fields in the CSV data, you must escape - * internal double-quote marks by prepending another double-quote. - *
+ *
The csv parser accepts that data that complies with RFC RFC-4180. As a result, backslashes are + * not a valid escape character. If you use double-quotes to enclose fields in the CSV data, you must escape internal double-quote marks by prepending + * another double-quote.
*

- * The {@link Builder} settings are: + * The {@link Builder} settings are the {@link #DEFAULT} with: *

*
    - *
  • {@code setDelimiter(',')}
  • - *
  • {@code setEscape('"')}
  • - *
  • {@code setQuote('"')}
  • - *
  • {@code setQuoteMode(QuoteMode.ALL_NON_NULL)}
  • - *
  • {@code setSkipHeaderRecord(false)}
  • + *
  • {@link Builder#setDelimiter(char) setDelimiter}{@code (',')}
  • + *
  • {@link Builder#setEscape(char) setEscape}{@code ('"')}
  • + *
  • {@link Builder#setQuote(char) setQuote}{@code ('"')}
  • + *
  • {@link Builder#setQuoteMode(QuoteMode) setQuoteMode}{@code (QuoteMode.MINIMAL)}
  • *
* * @see Predefined#MongoDBCsv + * @see QuoteMode#ALL_NON_NULL * @see MongoDB mongoexport command documentation * @since 1.7 */ @@ -1114,7 +1190,6 @@ public CSVFormat getFormat() { .setEscape(Constants.DOUBLE_QUOTE_CHAR) .setQuote(Constants.DOUBLE_QUOTE_CHAR) .setQuoteMode(QuoteMode.MINIMAL) - .setSkipHeaderRecord(false) .get(); // @formatter:off @@ -1130,17 +1205,18 @@ public CSVFormat getFormat() { *

* *

- * The {@link Builder} settings are: + * The {@link Builder} settings are the {@link #DEFAULT} with: *

*
    - *
  • {@code setDelimiter('\t')}
  • - *
  • {@code setEscape('"')}
  • - *
  • {@code setQuote('"')}
  • - *
  • {@code setQuoteMode(QuoteMode.ALL_NON_NULL)}
  • - *
  • {@code setSkipHeaderRecord(false)}
  • + *
  • {@link Builder#setDelimiter(char) setDelimiter}{@code ('\t')}
  • + *
  • {@link Builder#setEscape(char) setEscape}{@code ('"')}
  • + *
  • {@link Builder#setQuote(char) setQuote}{@code ('"')}
  • + *
  • {@link Builder#setQuoteMode(QuoteMode) setQuoteMode}{@code (QuoteMode.MINIMAL)}
  • + *
  • {@link Builder#setSkipHeaderRecord(boolean) setSkipHeaderRecord}{@code (false)}
  • *
* * @see Predefined#MongoDBCsv + * @see QuoteMode#ALL_NON_NULL * @see MongoDB mongoexport command * documentation * @since 1.7 @@ -1156,7 +1232,8 @@ public CSVFormat getFormat() { // @formatter:off /** - * Default MySQL format used by the {@code SELECT INTO OUTFILE} and {@code LOAD DATA INFILE} operations. + * Default MySQL + * format used by the {@code SELECT INTO OUTFILE} and {@code LOAD DATA INFILE} operations. * *

* This is a tab-delimited format with an LF character as the line separator. Values are not quoted and special @@ -1164,21 +1241,21 @@ public CSVFormat getFormat() { *

* *

- * The {@link Builder} settings are: + * The {@link Builder} settings are the {@link #DEFAULT} with: *

*
    - *
  • {@code setDelimiter('\t')}
  • - *
  • {@code setEscape('\\')}
  • - *
  • {@code setIgnoreEmptyLines(false)}
  • - *
  • {@code setQuote(null)}
  • - *
  • {@code setRecordSeparator('\n')}
  • - *
  • {@code setNullString("\\N")}
  • - *
  • {@code setQuoteMode(QuoteMode.ALL_NON_NULL)}
  • + *
  • {@link Builder#setDelimiter(char) setDelimiter}{@code ('\t')}
  • + *
  • {@link Builder#setEscape(char) setEscape}{@code ('\\')}
  • + *
  • {@link Builder#setIgnoreEmptyLines(boolean) setIgnoreEmptyLines}{@code (false)}
  • + *
  • {@link Builder#setQuote(Character) setQuote}{@code (null)}
  • + *
  • {@link Builder#setRecordSeparator(char) setRecordSeparator}{@code ('\n')}
  • + *
  • {@link Builder#setNullString(String) setNullString}{@code ("\\N")}
  • + *
  • {@link Builder#setQuoteMode(QuoteMode) setQuoteMode}{@code (QuoteMode.ALL_NON_NULL)}
  • *
* * @see Predefined#MySQL - * @see https://dev.mysql.com/doc/refman/5.1/en/load - * -data.html + * @see QuoteMode#ALL_NON_NULL + * @see MySQL */ // @formatter:off public static final CSVFormat MYSQL = DEFAULT.builder() @@ -1193,7 +1270,9 @@ public CSVFormat getFormat() { // @formatter:off /** - * Default Oracle format used by the SQL*Loader utility. + * Default + * Oracle + * format used by the SQL*Loader utility. * *

* This is a comma-delimited format with the system line separator character as the record separator. Values are @@ -1202,21 +1281,22 @@ public CSVFormat getFormat() { *

* *

- * The {@link Builder} settings are: + * The {@link Builder} settings are the {@link #DEFAULT} with: *

*
    - *
  • {@code setDelimiter(',') // default is {@code FIELDS TERMINATED BY ','}}
  • - *
  • {@code setEscape('\\')}
  • - *
  • {@code setIgnoreEmptyLines(false)}
  • - *
  • {@code setQuote('"') // default is {@code OPTIONALLY ENCLOSED BY '"'}}
  • - *
  • {@code setNullString("\\N")}
  • - *
  • {@code setTrim()}
  • - *
  • {@code setSystemRecordSeparator()}
  • - *
  • {@code setQuoteMode(QuoteMode.MINIMAL)}
  • + *
  • {@link Builder#setDelimiter(char) setDelimiter}{@code (',')} // default is {@code FIELDS TERMINATED BY ','}}
  • + *
  • {@link Builder#setEscape(char) setEscape}{@code ('\\')}
  • + *
  • {@link Builder#setIgnoreEmptyLines(boolean) setIgnoreEmptyLines}{@code (false)}
  • + *
  • {@link Builder#setQuote(char) setQuote}{@code ('"')} // default is {@code OPTIONALLY ENCLOSED BY '"'}}
  • + *
  • {@link Builder#setNullString(String) setNullString}{@code ("\\N")}
  • + *
  • {@link Builder#setTrim(boolean) setTrim}{@code (true)}
  • + *
  • {@link Builder#setRecordSeparator(String) setRecordSeparator}{@code (System.lineSeparator())}
  • + *
  • {@link Builder#setQuoteMode(QuoteMode) setQuoteMode}{@code (QuoteMode.MINIMAL)}
  • *
* * @see Predefined#Oracle - * @see Oracle CSV Format Specification + * @see QuoteMode#MINIMAL + * @see Oracle CSV Format Specification * @since 1.6 */ // @formatter:off @@ -1233,7 +1313,7 @@ public CSVFormat getFormat() { // @formatter:off /** - * Default PostgreSQL CSV format used by the {@code COPY} operation. + * Default PostgreSQL CSV format used by the {@code COPY} operation. * *

* This is a comma-delimited format with an LF character as the line separator. Values are double quoted and special @@ -1241,21 +1321,21 @@ public CSVFormat getFormat() { *

* *

- * The {@link Builder} settings are: + * The {@link Builder} settings are the {@link #DEFAULT} with: *

*
    - *
  • {@code setDelimiter(',')}
  • - *
  • {@code setEscape(null)}
  • - *
  • {@code setIgnoreEmptyLines(false)}
  • - *
  • {@code setQuote('"')}
  • - *
  • {@code setRecordSeparator('\n')}
  • - *
  • {@code setNullString("")}
  • - *
  • {@code setQuoteMode(QuoteMode.ALL_NON_NULL)}
  • + *
  • {@link Builder#setDelimiter(char) setDelimiter}{@code (',')}
  • + *
  • {@link Builder#setEscape(Character) setEscape}{@code (null)}
  • + *
  • {@link Builder#setIgnoreEmptyLines(boolean) setIgnoreEmptyLines}{@code (false)}
  • + *
  • {@link Builder#setQuote(char) setQuote}{@code ('"')}
  • + *
  • {@link Builder#setRecordSeparator(char) setRecordSeparator}{@code ('\n')}
  • + *
  • {@link Builder#setNullString(String) setNullString}{@code ("")}
  • + *
  • {@link Builder#setQuoteMode(QuoteMode) setQuoteMode}{@code (QuoteMode.ALL_NON_NULL)}
  • *
* * @see Predefined#MySQL - * @see PostgreSQL COPY command - * documentation + * @see QuoteMode#ALL_NON_NULL + * @see PostgreSQL CSV * @since 1.5 */ // @formatter:off @@ -1271,7 +1351,7 @@ public CSVFormat getFormat() { // @formatter:off /** - * Default PostgreSQL text format used by the {@code COPY} operation. + * Default PostgreSQL Text format used by the {@code COPY} operation. * *

* This is a tab-delimited format with an LF character as the line separator. Values are not quoted and special @@ -1279,21 +1359,21 @@ public CSVFormat getFormat() { *

* *

- * The {@link Builder} settings are: + * The {@link Builder} settings are the {@link #DEFAULT} with: *

*
    - *
  • {@code setDelimiter('\t')}
  • - *
  • {@code setEscape('\\')}
  • - *
  • {@code setIgnoreEmptyLines(false)}
  • - *
  • {@code setQuote(null)}
  • - *
  • {@code setRecordSeparator('\n')}
  • - *
  • {@code setNullString("\\N")}
  • - *
  • {@code setQuoteMode(QuoteMode.ALL_NON_NULL)}
  • + *
  • {@link Builder#setDelimiter(char) setDelimiter}{@code ('\t')}
  • + *
  • {@link Builder#setEscape(char) setEscape}{@code ('\\')}
  • + *
  • {@link Builder#setIgnoreEmptyLines(boolean) setIgnoreEmptyLines}{@code (false)}
  • + *
  • {@link Builder#setQuote(Character) setQuote}{@code (null)}
  • + *
  • {@link Builder#setRecordSeparator(char) setRecordSeparator}{@code ('\n')}
  • + *
  • {@link Builder#setNullString(String) setNullString}{@code ("\\N")}
  • + *
  • {@link Builder#setQuoteMode(QuoteMode) setQuoteMode}{@code (QuoteMode.ALL_NON_NULL)}
  • *
* * @see Predefined#MySQL - * @see PostgreSQL COPY command - * documentation + * @see QuoteMode#ALL_NON_NULL + * @see PostgreSQL Text * @since 1.5 */ // @formatter:off @@ -1312,35 +1392,35 @@ public CSVFormat getFormat() { * Comma separated format as defined by RFC 4180. * *

- * The {@link Builder} settings are: + * The {@link Builder} settings are the {@link #DEFAULT} with: *

*
    - *
  • {@code setDelimiter(',')}
  • - *
  • {@code setQuote('"')}
  • - *
  • {@code setRecordSeparator("\r\n")}
  • - *
  • {@code setIgnoreEmptyLines(false)}
  • + *
  • {@link Builder#setDelimiter(char) setDelimiter}{@code (',')}
  • + *
  • {@link Builder#setQuote(char) setQuote}{@code ('"')}
  • + *
  • {@link Builder#setRecordSeparator(String) setRecordSeparator}{@code ("\r\n")}
  • + *
  • {@link Builder#setIgnoreEmptyLines(boolean) setIgnoreEmptyLines}{@code (false)}
  • *
* * @see Predefined#RFC4180 + * @see RFC 4180 */ public static final CSVFormat RFC4180 = DEFAULT.builder().setIgnoreEmptyLines(false).get(); private static final long serialVersionUID = 2L; /** - * Tab-delimited format. + * Tab-delimited format (TDF). * *

- * The {@link Builder} settings are: + * The {@link Builder} settings are the {@link #DEFAULT} with: *

*
    - *
  • {@code setDelimiter('\t')}
  • - *
  • {@code setQuote('"')}
  • - *
  • {@code setRecordSeparator("\r\n")}
  • - *
  • {@code setIgnoreSurroundingSpaces(true)}
  • + *
  • {@link Builder#setDelimiter(char) setDelimiter}{@code ('\t')}
  • + *
  • {@link Builder#setIgnoreSurroundingSpaces(boolean) setIgnoreSurroundingSpaces}{@code (true)}
  • *
* * @see Predefined#TDF + * @see TDF */ // @formatter:off public static final CSVFormat TDF = DEFAULT.builder() @@ -1364,7 +1444,7 @@ static T[] clone(final T... values) { /** * Returns true if the given string contains the search char. * - * @param source the string to check. + * @param source the string to check. * @param searchCh the character to search. * @return true if {@code c} contains a line break character */ @@ -1412,7 +1492,7 @@ private static boolean isLineBreak(final char c) { * @return true if {@code c} is a line break character (and not null). */ private static boolean isLineBreak(final Character c) { - return c != null && isLineBreak(c.charValue()); // N.B. Explicit (un)boxing is intentional + return c != null && isLineBreak(c.charValue()); // Explicit unboxing is intentional } /** Same test as in as {@link String#trim()}. */ @@ -1442,8 +1522,7 @@ private static boolean isTrimChar(final CharSequence charSequence, final int pos * @see #TDF */ public static CSVFormat newFormat(final char delimiter) { - return new CSVFormat(String.valueOf(delimiter), null, null, null, null, false, false, null, null, null, null, false, false, false, false, false, false, - DuplicateHeaderMode.ALLOW_ALL, false, false); + return new CSVFormat(new Builder().setDelimiter(delimiter)); } static String[] toStringArray(final Object[] values) { @@ -1546,99 +1625,49 @@ public static CSVFormat valueOf(final String format) { /** Whether to trim leading and trailing blanks. */ private final boolean trim; + /** The maximum number of rows to process, excluding the header row. */ + private final long maxRows; + private CSVFormat(final Builder builder) { - this.delimiter = builder.delimiter; - this.quoteCharacter = builder.quoteCharacter; - this.quoteMode = builder.quoteMode; + this.allowMissingColumnNames = builder.allowMissingColumnNames; + this.autoFlush = builder.autoFlush; this.commentMarker = builder.commentMarker; + this.delimiter = builder.delimiter; + this.duplicateHeaderMode = builder.duplicateHeaderMode; this.escapeCharacter = builder.escapeCharacter; - this.ignoreSurroundingSpaces = builder.ignoreSurroundingSpaces; - this.allowMissingColumnNames = builder.allowMissingColumnNames; - this.ignoreEmptyLines = builder.ignoreEmptyLines; - this.recordSeparator = builder.recordSeparator; - this.nullString = builder.nullString; this.headerComments = builder.headerComments; this.headers = builder.headers; - this.skipHeaderRecord = builder.skipHeaderRecord; + this.ignoreEmptyLines = builder.ignoreEmptyLines; this.ignoreHeaderCase = builder.ignoreHeaderCase; + this.ignoreSurroundingSpaces = builder.ignoreSurroundingSpaces; this.lenientEof = builder.lenientEof; + this.maxRows = builder.maxRows; + this.nullString = builder.nullString; + this.quoteCharacter = builder.quoteCharacter; + this.quoteMode = builder.quoteMode; + this.quotedNullString = builder.quotedNullString; + this.recordSeparator = builder.recordSeparator; + this.skipHeaderRecord = builder.skipHeaderRecord; this.trailingData = builder.trailingData; this.trailingDelimiter = builder.trailingDelimiter; this.trim = builder.trim; - this.autoFlush = builder.autoFlush; - this.quotedNullString = builder.quotedNullString; - this.duplicateHeaderMode = builder.duplicateHeaderMode; - validate(); - } - - /** - * Creates a customized CSV format. - * - * @param delimiter the char used for value separation, must not be a line break character. - * @param quoteChar the Character used as value encapsulation marker, may be {@code null} to disable. - * @param quoteMode the quote mode. - * @param commentStart the Character used for comment identification, may be {@code null} to disable. - * @param escape the Character used to escape special characters in values, may be {@code null} to disable. - * @param ignoreSurroundingSpaces {@code true} when whitespaces enclosing values should be ignored. - * @param ignoreEmptyLines {@code true} when the parser should skip empty lines. - * @param recordSeparator the line separator to use for output. - * @param nullString the String to convert to and from {@code null}. - * @param headerComments the comments to be printed by the Printer before the actual CSV data. - * @param header the header. - * @param skipHeaderRecord if {@code true} the header row will be skipped. - * @param allowMissingColumnNames if {@code true} the missing column names are allowed when parsing the header line. - * @param ignoreHeaderCase if {@code true} header names will be accessed ignoring case when parsing input. - * @param trim if {@code true} next record value will be trimmed. - * @param trailingDelimiter if {@code true} the trailing delimiter wil be added before record separator (if set). - * @param autoFlush if {@code true} the underlying stream will be flushed before closing. - * @param duplicateHeaderMode the behavior when handling duplicate headers. - * @param trailingData whether reading trailing data is allowed in records, helps Excel compatibility. - * @param lenientEof whether reading end-of-file is allowed even when input is malformed, helps Excel compatibility. - * @throws IllegalArgumentException if the delimiter is a line break character. - */ - private CSVFormat(final String delimiter, final Character quoteChar, final QuoteMode quoteMode, final Character commentStart, final Character escape, - final boolean ignoreSurroundingSpaces, final boolean ignoreEmptyLines, final String recordSeparator, final String nullString, - final Object[] headerComments, final String[] header, final boolean skipHeaderRecord, final boolean allowMissingColumnNames, - final boolean ignoreHeaderCase, final boolean trim, final boolean trailingDelimiter, final boolean autoFlush, - final DuplicateHeaderMode duplicateHeaderMode, final boolean trailingData, final boolean lenientEof) { - this.delimiter = delimiter; - this.quoteCharacter = quoteChar; - this.quoteMode = quoteMode; - this.commentMarker = commentStart; - this.escapeCharacter = escape; - this.ignoreSurroundingSpaces = ignoreSurroundingSpaces; - this.allowMissingColumnNames = allowMissingColumnNames; - this.ignoreEmptyLines = ignoreEmptyLines; - this.recordSeparator = recordSeparator; - this.nullString = nullString; - this.headerComments = toStringArray(headerComments); - this.headers = clone(header); - this.skipHeaderRecord = skipHeaderRecord; - this.ignoreHeaderCase = ignoreHeaderCase; - this.lenientEof = lenientEof; - this.trailingData = trailingData; - this.trailingDelimiter = trailingDelimiter; - this.trim = trim; - this.autoFlush = autoFlush; - this.quotedNullString = quoteCharacter + nullString + quoteCharacter; - this.duplicateHeaderMode = duplicateHeaderMode; validate(); } private void append(final char c, final Appendable appendable) throws IOException { - //try { - appendable.append(c); - //} catch (final IOException e) { - // throw new UncheckedIOException(e); - //} + // try { + appendable.append(c); + // } catch (final IOException e) { + // throw new UncheckedIOException(e); + // } } private void append(final CharSequence csq, final Appendable appendable) throws IOException { - //try { - appendable.append(csq); - //} catch (final IOException e) { - // throw new UncheckedIOException(e); - //} + // try { + appendable.append(csq); + // } catch (final IOException e) { + // throw new UncheckedIOException(e); + // } } /** @@ -1676,23 +1705,23 @@ public boolean equals(final Object obj) { duplicateHeaderMode == other.duplicateHeaderMode && Objects.equals(escapeCharacter, other.escapeCharacter) && Arrays.equals(headerComments, other.headerComments) && Arrays.equals(headers, other.headers) && ignoreEmptyLines == other.ignoreEmptyLines && ignoreHeaderCase == other.ignoreHeaderCase && - ignoreSurroundingSpaces == other.ignoreSurroundingSpaces && lenientEof == other.lenientEof && - Objects.equals(nullString, other.nullString) && Objects.equals(quoteCharacter, other.quoteCharacter) && - quoteMode == other.quoteMode && Objects.equals(quotedNullString, other.quotedNullString) && - Objects.equals(recordSeparator, other.recordSeparator) && skipHeaderRecord == other.skipHeaderRecord && - trailingData == other.trailingData && trailingDelimiter == other.trailingDelimiter && trim == other.trim; + ignoreSurroundingSpaces == other.ignoreSurroundingSpaces && lenientEof == other.lenientEof && maxRows == other.maxRows && + Objects.equals(nullString, other.nullString) && Objects.equals(quoteCharacter, other.quoteCharacter) && quoteMode == other.quoteMode && + Objects.equals(quotedNullString, other.quotedNullString) && Objects.equals(recordSeparator, other.recordSeparator) && + skipHeaderRecord == other.skipHeaderRecord && trailingData == other.trailingData && trailingDelimiter == other.trailingDelimiter && + trim == other.trim; } private void escape(final char c, final Appendable appendable) throws IOException { - append(escapeCharacter.charValue(), appendable); // N.B. Explicit (un)boxing is intentional + append(escapeCharacter.charValue(), appendable); // Explicit unboxing is intentional append(c, appendable); } /** - * Formats the specified values. + * Formats the specified values as a CSV record string. * - * @param values the values to format - * @return the formatted values + * @param values the values to format. + * @return the formatted values. */ public String format(final Object... values) { return Uncheck.get(() -> format_(values)); @@ -1748,8 +1777,8 @@ public boolean getAutoFlush() { * Comments are printed first, before headers. *

*

- * Use {@link Builder#setCommentMarker(char)} or {@link Builder#setCommentMarker(Character)} to set the comment - * marker written at the start of each comment line. + * Use {@link Builder#setCommentMarker(char)} or {@link Builder#setCommentMarker(Character)} to set the comment marker written at the start of each comment + * line. *

*

* If the comment marker is not set, then the header comments are ignored. @@ -1757,13 +1786,14 @@ public boolean getAutoFlush() { *

* For example: *

+ * *
-     * builder.setCommentMarker('#')
-     *        .setHeaderComments("Generated by Apache Commons CSV", Instant.ofEpochMilli(0));
+     * builder.setCommentMarker('#').setHeaderComments("Generated by Apache Commons CSV", Instant.ofEpochMilli(0));
      * 
*

* writes: *

+ * *
      * # Generated by Apache Commons CSV.
      * # 1970-01-01T00:00:00Z
@@ -1821,7 +1851,7 @@ public DuplicateHeaderMode getDuplicateHeaderMode() {
      * @return the escape character, may be {@code 0}
      */
     char getEscapeChar() {
-        return escapeCharacter != null ? escapeCharacter.charValue() : 0;  // N.B. Explicit (un)boxing is intentional
+        return escapeCharacter != null ? escapeCharacter.charValue() : 0; // Explicit unboxing is intentional
     }
 
     /**
@@ -1851,8 +1881,8 @@ public String[] getHeader() {
      * Comments are printed first, before headers.
      * 

*

- * Use {@link Builder#setCommentMarker(char)} or {@link Builder#setCommentMarker(Character)} to set the comment - * marker written at the start of each comment line. + * Use {@link Builder#setCommentMarker(char)} or {@link Builder#setCommentMarker(Character)} to set the comment marker written at the start of each comment + * line. *

*

* If the comment marker is not set, then the header comments are ignored. @@ -1860,13 +1890,14 @@ public String[] getHeader() { *

* For example: *

+ * *
-     * builder.setCommentMarker('#')
-     *        .setHeaderComments("Generated by Apache Commons CSV", Instant.ofEpochMilli(0));
+     * builder.setCommentMarker('#').setHeaderComments("Generated by Apache Commons CSV", Instant.ofEpochMilli(0));
      * 
*

* writes: *

+ * *
      * # Generated by Apache Commons CSV.
      * # 1970-01-01T00:00:00Z
@@ -1916,6 +1947,19 @@ public boolean getLenientEof() {
         return lenientEof;
     }
 
+    /**
+     * Gets the maximum number of rows to process, excluding the header row.
+     * 

+ * Values less than or equal to 0 mean no limit. + *

+ * + * @return The maximum number of rows to process, excluding the header row. + * @since 1.14.0 + */ + public long getMaxRows() { + return maxRows; + } + /** * Gets the String to convert to and from {@code null}. *
    @@ -1978,6 +2022,16 @@ public boolean getTrailingData() { /** * Gets whether to add a trailing delimiter. * + *

    + * When writing, a delimiter is appended after the last value of each record. When reading, the empty field + * that such a trailing delimiter produces is dropped so the output round-trips back to the original record; + * a quoted empty trailing field ({@code ""}) is a real value rather than a trailing delimiter and is kept. + *

    + *

    + * This is unrelated to {@link #getTrailingData() trailing data}, which controls whether characters after the + * closing quote of an encapsulated value are tolerated when reading. + *

    + * * @return whether to add a trailing delimiter. * @since 1.3 */ @@ -1986,8 +2040,7 @@ public boolean getTrailingDelimiter() { } /** - * Gets whether to trim leading and trailing blanks. This is used by {@link #print(Object, Appendable, boolean)} Also by - * {CSVParser#addRecordValue(boolean)} + * Gets whether to trim leading and trailing blanks. This is used by {@link #print(Object, Appendable, boolean)} Also by {CSVParser#addRecordValue(boolean)} * * @return whether to trim leading and trailing blanks. */ @@ -2002,7 +2055,7 @@ public int hashCode() { result = prime * result + Arrays.hashCode(headerComments); result = prime * result + Arrays.hashCode(headers); result = prime * result + Objects.hash(allowMissingColumnNames, autoFlush, commentMarker, delimiter, duplicateHeaderMode, escapeCharacter, - ignoreEmptyLines, ignoreHeaderCase, ignoreSurroundingSpaces, lenientEof, nullString, quoteCharacter, quoteMode, quotedNullString, + ignoreEmptyLines, ignoreHeaderCase, ignoreSurroundingSpaces, lenientEof, maxRows, nullString, quoteCharacter, quoteMode, quotedNullString, recordSeparator, skipHeaderRecord, trailingData, trailingDelimiter, trim); return result; } @@ -2021,16 +2074,11 @@ public boolean isCommentMarkerSet() { /** * Tests whether the next characters constitute a delimiter * - * @param ch0 - * the first char (index 0). - * @param charSeq - * the match char sequence - * @param startIndex - * where start to match - * @param delimiter - * the delimiter - * @param delimiterLength - * the delimiter length + * @param ch0 the first char (index 0). + * @param charSeq the match char sequence + * @param startIndex where start to match + * @param delimiter the delimiter + * @param delimiterLength the delimiter length * @return true if the match is successful */ private boolean isDelimiter(final char ch0, final CharSequence charSeq, final int startIndex, final char[] delimiter, final int delimiterLength) { @@ -2076,6 +2124,10 @@ public boolean isQuoteCharacterSet() { return quoteCharacter != null; } + IOStream limit(final IOStream stream) { + return useMaxRows() ? stream.limit(getMaxRows()) : stream; + } + /** * Parses the specified content. * @@ -2085,7 +2137,7 @@ public boolean isQuoteCharacterSet() { * * @param reader the input stream * @return a parser over a stream of {@link CSVRecord}s. - * @throws IOException If an I/O error occurs + * @throws IOException If an I/O error occurs * @throws CSVException Thrown on invalid input. */ public CSVParser parse(final Reader reader) throws IOException { @@ -2132,7 +2184,7 @@ private void print(final InputStream inputStream, final Appendable out, final bo } final boolean quoteCharacterSet = isQuoteCharacterSet(); if (quoteCharacterSet) { - append(getQuoteCharacter().charValue(), out); // N.B. Explicit (un)boxing is intentional + append(getQuoteCharacter().charValue(), out); // Explicit unboxing is intentional } // Stream the input to the output without reading or holding the whole value in memory. // AppendableOutputStream cannot "close" an Appendable. @@ -2140,7 +2192,7 @@ private void print(final InputStream inputStream, final Appendable out, final bo IOUtils.copy(inputStream, outputStream); } if (quoteCharacterSet) { - append(getQuoteCharacter().charValue(), out); // N.B. Explicit (un)boxing is intentional + append(getQuoteCharacter().charValue(), out); // Explicit unboxing is intentional } } @@ -2201,8 +2253,7 @@ private synchronized void print(final Object object, final CharSequence value, f } /** - * Prints to the specified {@code Path} with given {@code Charset}, - * returns a {@code CSVPrinter} which the caller MUST close. + * Prints to the specified {@code Path} with given {@code Charset}, returns a {@code CSVPrinter} which the caller MUST close. * *

    * See also {@link CSVPrinter}. @@ -2274,8 +2325,8 @@ public synchronized void println(final Appendable appendable) throws IOException * the record, so there is no need to call {@link #println(Appendable)}. *

    * - * @param appendable where to write. - * @param values values to output. + * @param appendable where to write. + * @param values values to output. * @throws IOException If an I/O error occurs. * @since 1.4 */ @@ -2287,7 +2338,7 @@ public synchronized void printRecord(final Appendable appendable, final Object.. } /* - * Note: Must only be called if escaping is enabled, otherwise can throw exceptions. + * This method must only be called if escaping is enabled, otherwise can throw exceptions. */ private void printWithEscapes(final CharSequence charSeq, final Appendable appendable) throws IOException { int start = 0; @@ -2296,12 +2347,18 @@ private void printWithEscapes(final CharSequence charSeq, final Appendable appen final char[] delimArray = getDelimiterCharArray(); final int delimLength = delimArray.length; final char escape = getEscapeChar(); + final boolean quoteSet = isQuoteCharacterSet(); + final char quote = quoteSet ? getQuoteCharacter().charValue() : 0; + final boolean commentMarkerSet = isCommentMarkerSet(); + final char commentChar = commentMarkerSet ? commentMarker.charValue() : 0; // Explicit unboxing is intentional while (pos < end) { char c = charSeq.charAt(pos); final boolean isDelimiterStart = isDelimiter(c, charSeq, pos, delimArray, delimLength); final boolean isCr = c == Constants.CR; final boolean isLf = c == Constants.LF; - if (isCr || isLf || c == escape || isDelimiterStart) { + // A leading comment marker would be read back as a comment, so escape it. + final boolean isComment = commentMarkerSet && pos == 0 && c == commentChar; + if (isCr || isLf || c == escape || quoteSet && c == quote || isDelimiterStart || isComment) { // write out segment up until this char if (pos > start) { appendable.append(charSeq, start, pos); @@ -2330,7 +2387,7 @@ private void printWithEscapes(final CharSequence charSeq, final Appendable appen } /* - * Note: Must only be called if escaping is enabled, otherwise can throw exceptions. + * This method must only be called if escaping is enabled, otherwise can throw exceptions. */ private void printWithEscapes(final Reader reader, final Appendable appendable) throws IOException { int start = 0; @@ -2340,8 +2397,13 @@ private void printWithEscapes(final Reader reader, final Appendable appendable) final char[] delimArray = getDelimiterCharArray(); final int delimLength = delimArray.length; final char escape = getEscapeChar(); + final boolean quoteSet = isQuoteCharacterSet(); + final char quote = quoteSet ? getQuoteCharacter().charValue() : 0; + final boolean commentMarkerSet = isCommentMarkerSet(); + final char commentChar = commentMarkerSet ? commentMarker.charValue() : 0; // Explicit unboxing is intentional final StringBuilder builder = new StringBuilder(IOUtils.DEFAULT_BUFFER_SIZE); int c; + boolean firstChar = true; final char[] lookAheadBuffer = new char[delimLength - 1]; while (EOF != (c = bufferedReader.read())) { builder.append((char) c); @@ -2351,7 +2413,10 @@ private void printWithEscapes(final Reader reader, final Appendable appendable) final boolean isDelimiterStart = isDelimiter((char) c, test, pos, delimArray, delimLength); final boolean isCr = c == Constants.CR; final boolean isLf = c == Constants.LF; - if (isCr || isLf || c == escape || isDelimiterStart) { + // A leading comment marker would be read back as a comment, so escape it. + final boolean isComment = commentMarkerSet && firstChar && c == commentChar; + firstChar = false; + if (isCr || isLf || c == escape || quoteSet && c == quote || isDelimiterStart || isComment) { // write out segment up until this char if (pos > start) { append(builder.substring(start, pos), appendable); @@ -2380,9 +2445,9 @@ private void printWithEscapes(final Reader reader, final Appendable appendable) } /* - * Note: must only be called if quoting is enabled, otherwise will generate NPE + * This method must only be called if quoting is enabled, otherwise will generate NPE. + * The original object is needed so can check for Number */ - // the original object is needed so can check for Number private void printWithQuotes(final Object object, final CharSequence charSeq, final Appendable out, final boolean newRecord) throws IOException { boolean quote = false; int start = 0; @@ -2390,7 +2455,7 @@ private void printWithQuotes(final Object object, final CharSequence charSeq, fi final int len = charSeq.length(); final char[] delim = getDelimiterCharArray(); final int delimLength = delim.length; - final char quoteChar = getQuoteCharacter().charValue(); // N.B. Explicit (un)boxing is intentional + final char quoteChar = getQuoteCharacter().charValue(); // Explicit unboxing is intentional // If escape char not specified, default to the quote char // This avoids having to keep checking whether there is an escape character // at the cost of checking against quote twice @@ -2422,10 +2487,11 @@ private void printWithQuotes(final Object object, final CharSequence charSeq, fi } } else { char c = charSeq.charAt(pos); - if (c <= Constants.COMMENT) { + if (c <= Constants.COMMENT || isCommentMarkerSet() && c == commentMarker.charValue()) { // Some other chars at the start of a value caused the parser to fail, so for now // encapsulate if we start in anything less than '#'. We are being conservative - // by including the default comment char too. + // by including the default comment char and any configured comment marker too, + // which the parser would otherwise read back as a comment line. quote = true; } else { while (pos < len) { @@ -2484,7 +2550,7 @@ private void printWithQuotes(final Object object, final CharSequence charSeq, fi /** * Always use quotes unless QuoteMode is NONE, so we do not have to look ahead. * - * @param reader What to print + * @param reader What to print * @param appendable Where to print it * @throws IOException If an I/O error occurs */ @@ -2493,15 +2559,16 @@ private void printWithQuotes(final Reader reader, final Appendable appendable) t printWithEscapes(reader, appendable); return; } - final char quote = getQuoteCharacter().charValue(); // N.B. Explicit (un)boxing is intentional + final char quote = getQuoteCharacter().charValue(); // Explicit unboxing is intentional + final char escape = isEscapeCharacterSet() ? getEscapeChar() : quote; // (1) Append opening quote append(quote, appendable); - // (2) Append Reader contents, doubling quotes + // (2) Append Reader contents, doubling quotes and escape characters int c; while (EOF != (c = reader.read())) { append((char) c, appendable); - if (c == quote) { - append(quote, appendable); + if (c == quote || c == escape) { + append((char) c, appendable); } } // (3) Append closing quote @@ -2513,27 +2580,27 @@ public String toString() { final StringBuilder sb = new StringBuilder(); sb.append("Delimiter=<").append(delimiter).append('>'); if (isEscapeCharacterSet()) { - sb.append(' '); + sb.append(Constants.SP); sb.append("Escape=<").append(escapeCharacter).append('>'); } if (isQuoteCharacterSet()) { - sb.append(' '); + sb.append(Constants.SP); sb.append("QuoteChar=<").append(quoteCharacter).append('>'); } if (quoteMode != null) { - sb.append(' '); + sb.append(Constants.SP); sb.append("QuoteMode=<").append(quoteMode).append('>'); } if (isCommentMarkerSet()) { - sb.append(' '); + sb.append(Constants.SP); sb.append("CommentStart=<").append(commentMarker).append('>'); } if (isNullStringSet()) { - sb.append(' '); + sb.append(Constants.SP); sb.append("NullString=<").append(nullString).append('>'); } if (recordSeparator != null) { - sb.append(' '); + sb.append(Constants.SP); sb.append("RecordSeparator=<").append(recordSeparator).append('>'); } if (getIgnoreEmptyLines()) { @@ -2547,11 +2614,11 @@ public String toString() { } sb.append(" SkipHeaderRecord:").append(skipHeaderRecord); if (headerComments != null) { - sb.append(' '); + sb.append(Constants.SP); sb.append("HeaderComments:").append(Arrays.toString(headerComments)); } if (headers != null) { - sb.append(' '); + sb.append(Constants.SP); sb.append("Header:").append(Arrays.toString(headers)); } return sb.toString(); @@ -2561,6 +2628,14 @@ String trim(final String value) { return getTrim() ? value.trim() : value; } + boolean useMaxRows() { + return getMaxRows() > 0; + } + + boolean useRow(final long rowNum) { + return !useMaxRows() || rowNum <= getMaxRows(); + } + /** * Verifies the validity and consistency of the attributes, and throws an {@link IllegalArgumentException} if necessary. *

    @@ -2571,16 +2646,13 @@ String trim(final String value) { * @throws IllegalArgumentException Throw when any attribute is invalid or inconsistent with other attributes. */ private void validate() throws IllegalArgumentException { - if (containsLineBreak(delimiter)) { - throw new IllegalArgumentException("The delimiter cannot be a line break"); - } - if (quoteCharacter != null && contains(delimiter, quoteCharacter.charValue())) { // N.B. Explicit (un)boxing is intentional + if (quoteCharacter != null && contains(delimiter, quoteCharacter.charValue())) { // Explicit unboxing is intentional throw new IllegalArgumentException("The quoteChar character and the delimiter cannot be the same ('" + quoteCharacter + "')"); } - if (escapeCharacter != null && contains(delimiter, escapeCharacter.charValue())) { // N.B. Explicit (un)boxing is intentional + if (escapeCharacter != null && contains(delimiter, escapeCharacter.charValue())) { // Explicit unboxing is intentional throw new IllegalArgumentException("The escape character and the delimiter cannot be the same ('" + escapeCharacter + "')"); } - if (commentMarker != null && contains(delimiter, commentMarker.charValue())) { // N.B. Explicit (un)boxing is intentional + if (commentMarker != null && contains(delimiter, commentMarker.charValue())) { // Explicit unboxing is intentional throw new IllegalArgumentException("The comment start character and the delimiter cannot be the same ('" + commentMarker + "')"); } if (quoteCharacter != null && quoteCharacter.equals(commentMarker)) { @@ -2601,10 +2673,9 @@ private void validate() throws IllegalArgumentException { // Sanitize all empty headers to the empty string "" when checking duplicates final boolean containsHeader = !dupCheckSet.add(blank ? "" : header); if (containsHeader && !(blank && emptyDuplicatesAllowed)) { - throw new IllegalArgumentException( - String.format( - "The header contains a duplicate name: \"%s\" in %s. If this is valid then use CSVFormat.Builder.setDuplicateHeaderMode().", - header, Arrays.toString(headers))); + throw new IllegalArgumentException(String.format( + "The header contains a duplicate name: \"%s\" in %s. If this is valid then use CSVFormat.Builder.setDuplicateHeaderMode().", header, + Arrays.toString(headers))); } } } @@ -2744,6 +2815,7 @@ public CSVFormat withEscape(final Character escape) { return builder().setEscape(escape).get(); } + // @formatter:off /** * Builds a new {@code CSVFormat} using the first record as header. * @@ -2752,15 +2824,22 @@ public CSVFormat withEscape(final Character escape) { *

    * *
    -     * CSVFormat format = aFormat.withHeader().withSkipHeaderRecord();
    +     * CSVFormat format = aFormat.builder()
    +     *                           .setHeader()
    +     *                           .setSkipHeaderRecord(true)
    +     *                           .get();
          * 
    * + *

    Any previously set headers are reset to empty. + * The resulting format will have {@code skipHeaderRecord = true}.

    + * * @return A new CSVFormat that is equal to this but using the first record as header. * @see Builder#setSkipHeaderRecord(boolean) * @see Builder#setHeader(String...) * @since 1.3 * @deprecated Use {@link Builder#setHeader(String...) Builder#setHeader()}.{@link Builder#setSkipHeaderRecord(boolean) setSkipHeaderRecord(true)}. */ + // @formatter:on @Deprecated public CSVFormat withFirstRecordAsHeader() { // @formatter:off @@ -2779,11 +2858,11 @@ public CSVFormat withFirstRecordAsHeader() { *

    * *
    -     * public enum Header {
    +     * public enum MyHeader {
          *     Name, Email, Phone
          * }
    -     *
    -     * CSVFormat format = aformat.withHeader(Header.class);
    +     * ...
    +     * CSVFormat format = aFormat.builder().setHeader(MyHeader.class).get();
          * 
    *

    * The header is also used by the {@link CSVPrinter}. @@ -2806,13 +2885,13 @@ public CSVFormat withHeader(final Class> headerEnum) { * input file with: * *

    -     * CSVFormat format = aformat.withHeader();
    +     * CSVFormat format = aFormat.builder().setHeader().get();
          * 
    * * or specified manually with: * *
    -     * CSVFormat format = aformat.withHeader(resultSet);
    +     * CSVFormat format = aFormat.builder().setHeader(resultSet).get();
          * 
    *

    * The header is also used by the {@link CSVPrinter}. @@ -2834,13 +2913,13 @@ public CSVFormat withHeader(final ResultSet resultSet) throws SQLException { * input file with: * *

    -     * CSVFormat format = aformat.withHeader();
    +     * CSVFormat format = aFormat.builder().setHeader().get()
          * 
    * * or specified manually with: * *
    -     * CSVFormat format = aformat.withHeader(metaData);
    +     * CSVFormat format = aFormat.builder().setHeader(resultSetMetaData).get()
          * 
    *

    * The header is also used by the {@link CSVPrinter}. @@ -2862,13 +2941,13 @@ public CSVFormat withHeader(final ResultSetMetaData resultSetMetaData) throws SQ * with: * *

    -     * CSVFormat format = aformat.withHeader();
    +     * CSVFormat format = aFormat.builder().setHeader().get();
          * 
    * * or specified manually with: * *
    {@code
    -     * CSVFormat format = aformat.withHeader("name", "email", "phone");
    +     * CSVFormat format = aFormat.builder().setHeader("name", "email", "phone").get();
          * }
    *

    * The header is also used by the {@link CSVPrinter}. @@ -2889,7 +2968,7 @@ public CSVFormat withHeader(final String... header) { * This setting is ignored by the parser. * *

    {@code
    -     * CSVFormat format = aformat.withHeaderComments("Generated by Apache Commons CSV.", Instant.now());
    +     * CSVFormat format = aFormat.builder().setHeaderComments("Generated by Apache Commons CSV.", Instant.now()).get();
          * }
    * * @param headerComments the headerComments which will be printed by the Printer before the actual CSV data. @@ -3163,4 +3242,5 @@ public CSVFormat withTrim() { public CSVFormat withTrim(final boolean trim) { return builder().setTrim(trim).get(); } + } diff --git a/src/main/java/org/apache/commons/csv/CSVParser.java b/src/main/java/org/apache/commons/csv/CSVParser.java index f4b8f08a18..141eba732c 100644 --- a/src/main/java/org/apache/commons/csv/CSVParser.java +++ b/src/main/java/org/apache/commons/csv/CSVParser.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv; @@ -47,6 +49,7 @@ import java.util.stream.Stream; import java.util.stream.StreamSupport; +import org.apache.commons.io.Charsets; import org.apache.commons.io.build.AbstractStreamBuilder; import org.apache.commons.io.function.Uncheck; @@ -151,8 +154,10 @@ public final class CSVParser implements Iterable, Closeable { public static class Builder extends AbstractStreamBuilder { private CSVFormat format; + private long byteOffset = -1; private long characterOffset; private long recordNumber = 1; + private boolean trackBytes; /** * Constructs a new instance. @@ -161,17 +166,33 @@ protected Builder() { // empty } - @SuppressWarnings("resource") @Override public CSVParser get() throws IOException { - return new CSVParser(getReader(), format != null ? format : CSVFormat.DEFAULT, characterOffset, recordNumber); + return new CSVParser(this); } /** - * Sets the lexer offset when the parser does not start parsing at the beginning of the source. + * Sets the lexer byte offset when the parser does not start parsing at the beginning of the source. + *

    + * By default, the value is {@code -1}, which reuses the character offset for the byte offset. + *

    * - * @param characterOffset the lexer offset. - * @return this instance. + * @param byteOffset the lexer byte offset. + * @return {@code this} instance. + * @see #setCharacterOffset(long) + * @since 1.15.0 + */ + public Builder setByteOffset(final long byteOffset) { + this.byteOffset = byteOffset; + return asThis(); + } + + /** + * Sets the lexer character offset when the parser does not start parsing at the beginning of the source. + * + * @param characterOffset the lexer character offset. + * @return {@code this} instance. + * @see #setByteOffset(long) */ public Builder setCharacterOffset(final long characterOffset) { this.characterOffset = characterOffset; @@ -181,8 +202,8 @@ public Builder setCharacterOffset(final long characterOffset) { /** * Sets the CSV format. A copy of the given format is kept. * - * @param format the CSV format, null is equivalent to {@link CSVFormat#DEFAULT}. - * @return this instance. + * @param format the CSV format, {@code null} resets to {@link CSVFormat#DEFAULT}. + * @return {@code this} instance. */ public Builder setFormat(final CSVFormat format) { this.format = CSVFormat.copy(format); @@ -193,27 +214,47 @@ public Builder setFormat(final CSVFormat format) { * Sets the next record number to assign, defaults to {@code 1}. * * @param recordNumber the next record number to assign. - * @return this instance. + * @return {@code this} instance. */ public Builder setRecordNumber(final long recordNumber) { this.recordNumber = recordNumber; return asThis(); } + /** + * Sets whether to enable byte tracking for the parser. + * + * @param trackBytes {@code true} to enable byte tracking; {@code false} to disable it. + * @return {@code this} instance. + * @since 1.13.0 + */ + public Builder setTrackBytes(final boolean trackBytes) { + this.trackBytes = trackBytes; + return asThis(); + } + } final class CSVRecordIterator implements Iterator { private CSVRecord current; + private long recordCount; /** - * Gets the next record. + * Gets the next record or null at the end of stream or max rows read. * * @throws IOException on parse error or input read-failure * @throws CSVException on invalid input. - * @return the next record. + * @return the next record, or {@code null} if the end of the stream has been reached. */ private CSVRecord getNextRecord() { - return Uncheck.get(CSVParser.this::nextRecord); + CSVRecord record = null; + if (format.useRow(recordCount + 1)) { + record = Uncheck.get(CSVParser.this::nextRecord); + if (record != null) { + recordCount++; + } + } + return record; } @Override @@ -224,7 +265,6 @@ public boolean hasNext() { if (current == null) { current = getNextRecord(); } - return current != null; } @@ -235,7 +275,6 @@ public CSVRecord next() { } CSVRecord next = current; current = null; - if (next == null) { // hasNext() wasn't called before next = getNextRecord(); @@ -243,7 +282,6 @@ public CSVRecord next() { throw new NoSuchElementException("No more CSV records available"); } } - return next; } @@ -252,6 +290,7 @@ public void remove() { throw new UnsupportedOperationException(); } } + /** * Header information based on name and position. */ @@ -289,15 +328,16 @@ public static Builder builder() { * @param file * a CSV file. Must not be null. * @param charset - * The Charset to decode the given file. + * The Charset to decode the given file, {@code null} maps to the {@link Charset#defaultCharset() default Charset}. * @param format - * the CSVFormat used for CSV parsing. Must not be null. + * the CSVFormat used for CSV parsing, {@code null} maps to {@link CSVFormat#DEFAULT}. * @return a new parser * @throws IllegalArgumentException - * If the parameters of the format are inconsistent or if either file or format are null. + * If the parameters of the format are inconsistent. * @throws IOException * If an I/O error occurs - * @throws CSVException Thrown on invalid input. + * @throws CSVException Thrown on invalid CSV input data. + * @throws NullPointerException if {@code file} is {@code null}. */ public static CSVParser parse(final File file, final Charset charset, final CSVFormat format) throws IOException { Objects.requireNonNull(file, "file"); @@ -313,25 +353,22 @@ public static CSVParser parse(final File file, final Charset charset, final CSVF *

    * * @param inputStream - * an InputStream containing CSV-formatted input. Must not be null. + * an InputStream containing CSV-formatted input, {@code null} maps to {@link CSVFormat#DEFAULT}. * @param charset - * The Charset to decode the given file. + * The Charset to decode the given file, {@code null} maps to the {@link Charset#defaultCharset() default Charset}. * @param format - * the CSVFormat used for CSV parsing. Must not be null. + * the CSVFormat used for CSV parsing, {@code null} maps to {@link CSVFormat#DEFAULT}. * @return a new CSVParser configured with the given reader and format. * @throws IllegalArgumentException * If the parameters of the format are inconsistent or if either reader or format are null. * @throws IOException * If there is a problem reading the header or skipping the first record - * @throws CSVException Thrown on invalid input. + * @throws CSVException Thrown on invalid CSV input data. * @since 1.5 */ - @SuppressWarnings("resource") public static CSVParser parse(final InputStream inputStream, final Charset charset, final CSVFormat format) throws IOException { - Objects.requireNonNull(inputStream, "inputStream"); - Objects.requireNonNull(format, "format"); - return parse(new InputStreamReader(inputStream, charset), format); + return parse(new InputStreamReader(inputStream, Charsets.toCharset(charset)), format); } /** @@ -340,21 +377,21 @@ public static CSVParser parse(final InputStream inputStream, final Charset chars * @param path * a CSV file. Must not be null. * @param charset - * The Charset to decode the given file. + * The Charset to decode the given file, {@code null} maps to the {@link Charset#defaultCharset() default Charset}. * @param format - * the CSVFormat used for CSV parsing. Must not be null. + * the CSVFormat used for CSV parsing, {@code null} maps to {@link CSVFormat#DEFAULT}. * @return a new parser * @throws IllegalArgumentException - * If the parameters of the format are inconsistent or if either file or format are null. + * If the parameters of the format are inconsistent. * @throws IOException * If an I/O error occurs - * @throws CSVException Thrown on invalid input. + * @throws CSVException Thrown on invalid CSV input data. + * @throws NullPointerException if {@code path} is {@code null}. * @since 1.5 */ @SuppressWarnings("resource") public static CSVParser parse(final Path path, final Charset charset, final CSVFormat format) throws IOException { Objects.requireNonNull(path, "path"); - Objects.requireNonNull(format, "format"); return parse(Files.newInputStream(path), charset, format); } @@ -369,13 +406,13 @@ public static CSVParser parse(final Path path, final Charset charset, final CSVF * @param reader * a Reader containing CSV-formatted input. Must not be null. * @param format - * the CSVFormat used for CSV parsing. Must not be null. + * the CSVFormat used for CSV parsing, {@code null} maps to {@link CSVFormat#DEFAULT}. * @return a new CSVParser configured with the given reader and format. * @throws IllegalArgumentException * If the parameters of the format are inconsistent or if either reader or format are null. * @throws IOException * If there is a problem reading the header or skipping the first record - * @throws CSVException Thrown on invalid input. + * @throws CSVException Thrown on invalid CSV input data. * @since 1.5 */ public static CSVParser parse(final Reader reader, final CSVFormat format) throws IOException { @@ -388,17 +425,17 @@ public static CSVParser parse(final Reader reader, final CSVFormat format) throw * @param string * a CSV string. Must not be null. * @param format - * the CSVFormat used for CSV parsing. Must not be null. + * the CSVFormat used for CSV parsing, {@code null} maps to {@link CSVFormat#DEFAULT}. * @return a new parser * @throws IllegalArgumentException - * If the parameters of the format are inconsistent or if either string or format are null. + * If the parameters of the format are inconsistent. * @throws IOException * If an I/O error occurs - * @throws CSVException Thrown on invalid input. + * @throws CSVException Thrown on invalid CSV input data. + * @throws NullPointerException if {@code string} is {@code null}. */ public static CSVParser parse(final String string, final CSVFormat format) throws IOException { Objects.requireNonNull(string, "string"); - Objects.requireNonNull(format, "format"); return parse(new StringReader(string), format); } @@ -413,15 +450,16 @@ public static CSVParser parse(final String string, final CSVFormat format) throw * @param url * a URL. Must not be null. * @param charset - * the charset for the resource. Must not be null. + * the charset for the resource, {@code null} maps to the {@link Charset#defaultCharset() default Charset}. * @param format - * the CSVFormat used for CSV parsing. Must not be null. + * the CSVFormat used for CSV parsing, {@code null} maps to {@link CSVFormat#DEFAULT}. * @return a new parser * @throws IllegalArgumentException - * If the parameters of the format are inconsistent or if either url, charset or format are null. + * If the parameters of the format are inconsistent. * @throws IOException * If an I/O error occurs - * @throws CSVException Thrown on invalid input. + * @throws CSVException Thrown on invalid CSV input data. + * @throws NullPointerException if {@code url} is {@code null}. */ @SuppressWarnings("resource") public static CSVParser parse(final URL url, final Charset charset, final CSVFormat format) throws IOException { @@ -449,6 +487,12 @@ public static CSVParser parse(final URL url, final Charset charset, final CSVFor */ private long recordNumber; + /** + * Lexer offset when the parser does not start parsing at the beginning of the source. Usually used in combination + * with {@link #recordNumber}. + */ + private final long byteOffset; + /** * Lexer offset when the parser does not start parsing at the beginning of the source. Usually used in combination * with {@link #recordNumber}. @@ -458,7 +502,24 @@ public static CSVParser parse(final URL url, final Charset charset, final CSVFor private final Token reusableToken = new Token(); /** - * Constructs a new instance using the given {@link CSVFormat} + * Constructs a new instance from a builder. + * + * @param builder The source builder. + * @throws IOException if an I/O error occurs. + */ + @SuppressWarnings("resource") // Lexer manages ExtendedBufferedReader. + private CSVParser(final Builder builder) throws IOException { + this.format = (builder.format != null ? builder.format : CSVFormat.DEFAULT).copy(); + this.lexer = new Lexer(format, new ExtendedBufferedReader(builder.getReader(), builder.getCharset(), builder.trackBytes)); + this.csvRecordIterator = new CSVRecordIterator(); + this.headers = createHeaders(); + this.byteOffset = builder.byteOffset != -1 ? builder.byteOffset : builder.characterOffset; + this.characterOffset = builder.characterOffset; + this.recordNumber = builder.recordNumber - 1; + } + + /** + * Constructs a new instance using the given {@link CSVFormat}. * *

    * If you do not read all records from the given {@code reader}, you should call {@link #close()} on the parser, @@ -473,7 +534,7 @@ public static CSVParser parse(final URL url, final Charset charset, final CSVFor * If the parameters of the format are inconsistent or if either reader or format are null. * @throws IOException * If there is a problem reading the header or skipping the first record - * @throws CSVException Thrown on invalid input. + * @throws CSVException Thrown on invalid CSV input data. * @deprecated Will be removed in the next major version, use {@link Builder#get()}. */ @Deprecated @@ -482,7 +543,7 @@ public CSVParser(final Reader reader, final CSVFormat format) throws IOException } /** - * Constructs a new instance using the given {@link CSVFormat} + * Constructs a new instance using the given {@link CSVFormat}. * *

    * If you do not read all records from the given {@code reader}, you should call {@link #close()} on the parser, @@ -503,25 +564,25 @@ public CSVParser(final Reader reader, final CSVFormat format) throws IOException * if there is a problem reading the header or skipping the first record * @throws CSVException on invalid input. * @since 1.1 - * @deprecated Will be private in the next major version, use {@link Builder#get()}. + * @deprecated Will be removed in the next major version, use {@link Builder#get()}. */ @Deprecated - @SuppressWarnings("resource") - public CSVParser(final Reader reader, final CSVFormat format, final long characterOffset, final long recordNumber) - throws IOException { - Objects.requireNonNull(reader, "reader"); - Objects.requireNonNull(format, "format"); - this.format = format.copy(); - this.lexer = new Lexer(format, new ExtendedBufferedReader(reader)); - this.csvRecordIterator = new CSVRecordIterator(); - this.headers = createHeaders(); - this.characterOffset = characterOffset; - this.recordNumber = recordNumber - 1; + public CSVParser(final Reader reader, final CSVFormat format, final long characterOffset, final long recordNumber) throws IOException { + // @formatter:off + this(builder() + .setReader(reader) + .setFormat(Objects.requireNonNull(format, "format")) // requireNonNull for full compatibility + .setCharacterOffset(characterOffset) + .setRecordNumber(recordNumber) + .setCharset((Charset) null).setTrackBytes(false)); + // @formatter:off } private void addRecordValue(final boolean lastRecord) { final String input = format.trim(reusableToken.content.toString()); - if (lastRecord && input.isEmpty() && format.getTrailingDelimiter()) { + // Only drop the empty field produced by an actual trailing delimiter. A quoted empty + // field ("") is a real value, not a trailing delimiter, so it must be kept. + if (lastRecord && input.isEmpty() && format.getTrailingDelimiter() && !reusableToken.isQuoted) { return; } recordList.add(handleNull(input)); @@ -552,11 +613,11 @@ private Map createEmptyHeaderMap() { * @throws CSVException on invalid input. */ private Headers createHeaders() throws IOException { - Map hdrMap = null; + Map headerMap = null; List headerNames = null; final String[] formatHeader = format.getHeader(); if (formatHeader != null) { - hdrMap = createEmptyHeaderMap(); + headerMap = createEmptyHeaderMap(); String[] headerRecord = null; if (formatHeader.length == 0) { // read the header from the first line of the file @@ -574,7 +635,6 @@ private Headers createHeaders() throws IOException { } headerRecord = formatHeader; } - // build the name to index mappings if (headerRecord != null) { // Track an occurrence of a null, empty or blank header. @@ -583,24 +643,20 @@ private Headers createHeaders() throws IOException { final String header = headerRecord[i]; final boolean blankHeader = CSVFormat.isBlank(header); if (blankHeader && !format.getAllowMissingColumnNames()) { - throw new IllegalArgumentException( - "A header name is missing in " + Arrays.toString(headerRecord)); + throw new IllegalArgumentException("A header name is missing in " + Arrays.toString(headerRecord)); } - - final boolean containsHeader = blankHeader ? observedMissing : hdrMap.containsKey(header); + final boolean containsHeader = blankHeader ? observedMissing : headerMap.containsKey(header); final DuplicateHeaderMode headerMode = format.getDuplicateHeaderMode(); final boolean duplicatesAllowed = headerMode == DuplicateHeaderMode.ALLOW_ALL; final boolean emptyDuplicatesAllowed = headerMode == DuplicateHeaderMode.ALLOW_EMPTY; - if (containsHeader && !duplicatesAllowed && !(blankHeader && emptyDuplicatesAllowed)) { - throw new IllegalArgumentException( - String.format( + throw new IllegalArgumentException(String.format( "The header contains a duplicate name: \"%s\" in %s. If this is valid then use CSVFormat.Builder.setDuplicateHeaderMode().", header, Arrays.toString(headerRecord))); } observedMissing |= blankHeader; if (header != null) { - hdrMap.put(header, Integer.valueOf(i)); // N.B. Explicit (un)boxing is intentional + headerMap.put(header, Integer.valueOf(i)); // Explicit boxing is intentional if (headerNames == null) { headerNames = new ArrayList<>(headerRecord.length); } @@ -610,18 +666,18 @@ private Headers createHeaders() throws IOException { } } // Make header names Collection immutable - return new Headers(hdrMap, headerNames == null ? Collections.emptyList() : Collections.unmodifiableList(headerNames)); + return new Headers(headerMap, headerNames == null ? Collections.emptyList() : Collections.unmodifiableList(headerNames)); } /** * Gets the current line number in the input stream. * *

    - * ATTENTION: If your CSV input has multi-line values, the returned number does not correspond to + * Note: If your CSV input has multi-line values, the returned number does not correspond to * the record number. *

    * - * @return current line number + * @return current line number. */ public long getCurrentLineNumber() { return lexer.getCurrentLineNumber(); @@ -630,7 +686,7 @@ public long getCurrentLineNumber() { /** * Gets the first end-of-line string encountered. * - * @return the first end-of-line string + * @return the first end-of-line string. * @since 1.5 */ public String getFirstEndOfLine() { @@ -654,7 +710,7 @@ public String getHeaderComment() { * The map keys are column names. The map values are 0-based indices. *

    *

    - * Note: The map can only provide a one-to-one mapping when the format did not + * Note: The map can only provide a one-to-one mapping when the format did not * contain null or duplicate column names. *

    * @@ -698,7 +754,7 @@ public List getHeaderNames() { * Gets the current record number in the input stream. * *

    - * ATTENTION: If your CSV input has multi-line values, the returned number does not correspond to + * Note: If your CSV input has multi-line values, the returned number does not correspond to * the line number. *

    * @@ -715,6 +771,9 @@ public long getRecordNumber() { *

    * The returned content starts at the current parse-position in the stream. *

    + *

    + * You can use {@link CSVFormat.Builder#setMaxRows(long)} to limit how many rows this method produces. + *

    * * @return list of {@link CSVRecord CSVRecords}, may be empty * @throws UncheckedIOException @@ -821,6 +880,9 @@ private boolean isStrictQuoteMode() { * parser is closed, one option is to extract all records as a list with * {@link #getRecords()}, and return an iterator to that list. *

    + *

    + * You can use {@link CSVFormat.Builder#setMaxRows(long)} to limit how many rows an Iterator produces. + *

    */ @Override public Iterator iterator() { @@ -830,15 +892,16 @@ public Iterator iterator() { /** * Parses the next record from the current point in the stream. * - * @return the record as an array of values, or {@code null} if the end of the stream has been reached - * @throws IOException on parse error or input read-failure - * @throws CSVException on invalid input. + * @return the record as an array of values, or {@code null} if the end of the stream has been reached. + * @throws IOException on parse error or input read-failure. + * @throws CSVException on invalid CSV input data. */ CSVRecord nextRecord() throws IOException { CSVRecord result = null; recordList.clear(); StringBuilder sb = null; final long startCharPosition = lexer.getCharacterPosition() + characterOffset; + final long startBytePosition = lexer.getBytesRead() + byteOffset; do { reusableToken.reset(); lexer.nextToken(reusableToken); @@ -871,12 +934,10 @@ CSVRecord nextRecord() throws IOException { throw new CSVException("Unexpected Token type: %s", reusableToken.type); } } while (reusableToken.type == TOKEN); - if (!recordList.isEmpty()) { recordNumber++; - final String comment = Objects.toString(sb, null); - result = new CSVRecord(this, recordList.toArray(Constants.EMPTY_STRING_ARRAY), comment, - recordNumber, startCharPosition); + result = new CSVRecord(this, recordList.toArray(Constants.EMPTY_STRING_ARRAY), Objects.toString(sb, null), recordNumber, startCharPosition, + startBytePosition); } return result; } @@ -887,6 +948,10 @@ CSVRecord nextRecord() throws IOException { * If the parser is closed, the stream will not produce any more values. * See the comments in {@link #iterator()}. *

    + *

    + * You can use {@link CSVFormat.Builder#setMaxRows(long)} to limit how many rows a Stream produces. + *

    + * * @return a sequential {@code Stream} with this collection as its source. * @since 1.9.0 */ diff --git a/src/main/java/org/apache/commons/csv/CSVPrinter.java b/src/main/java/org/apache/commons/csv/CSVPrinter.java index 643ebb1f7b..a7048fd625 100644 --- a/src/main/java/org/apache/commons/csv/CSVPrinter.java +++ b/src/main/java/org/apache/commons/csv/CSVPrinter.java @@ -1,518 +1,579 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.apache.commons.csv; - -import static org.apache.commons.csv.Constants.CR; -import static org.apache.commons.csv.Constants.LF; -import static org.apache.commons.csv.Constants.SP; - -import java.io.Closeable; -import java.io.Flushable; -import java.io.IOException; -import java.io.InputStream; -import java.io.Reader; -import java.sql.Blob; -import java.sql.Clob; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.util.Arrays; -import java.util.Objects; -import java.util.stream.Stream; - -import org.apache.commons.io.function.IOStream; - -/** - * Prints values in a {@link CSVFormat CSV format}. - * - *

    Values can be appended to the output by calling the {@link #print(Object)} method. - * Values are printed according to {@link String#valueOf(Object)}. - * To complete a record the {@link #println()} method has to be called. - * Comments can be appended by calling {@link #printComment(String)}. - * However a comment will only be written to the output if the {@link CSVFormat} supports comments. - *

    - * - *

    The printer also supports appending a complete record at once by calling {@link #printRecord(Object...)} - * or {@link #printRecord(Iterable)}. - * Furthermore {@link #printRecords(Object...)}, {@link #printRecords(Iterable)} and {@link #printRecords(ResultSet)} - * methods can be used to print several records at once. - *

    - * - *

    Example:

    - * - *
    - * try (CSVPrinter printer = new CSVPrinter(new FileWriter("csv.txt"), CSVFormat.EXCEL)) {
    - *     printer.printRecord("id", "userName", "firstName", "lastName", "birthday");
    - *     printer.printRecord(1, "john73", "John", "Doe", LocalDate.of(1973, 9, 15));
    - *     printer.println();
    - *     printer.printRecord(2, "mary", "Mary", "Meyer", LocalDate.of(1985, 3, 29));
    - * } catch (IOException ex) {
    - *     ex.printStackTrace();
    - * }
    - * 
    - * - *

    This code will write the following to csv.txt:

    - *
    - * id,userName,firstName,lastName,birthday
    - * 1,john73,John,Doe,1973-09-15
    - *
    - * 2,mary,Mary,Meyer,1985-03-29
    - * 
    - */ -public final class CSVPrinter implements Flushable, Closeable { - - /** The place that the values get written. */ - private final Appendable appendable; - - private final CSVFormat format; - - /** True if we just began a new record. */ - private boolean newRecord = true; - - private long recordCount; - - /** - * Creates a printer that will print values to the given stream following the CSVFormat. - *

    - * Currently, only a pure encapsulation format or a pure escaping format is supported. Hybrid formats (encapsulation - * and escaping with a different character) are not supported. - *

    - * - * @param appendable - * stream to which to print. Must not be null. - * @param format - * the CSV format. Must not be null. - * @throws IOException - * thrown if the optional header cannot be printed. - * @throws IllegalArgumentException - * thrown if the parameters of the format are inconsistent or if either out or format are null. - */ - public CSVPrinter(final Appendable appendable, final CSVFormat format) throws IOException { - Objects.requireNonNull(appendable, "appendable"); - Objects.requireNonNull(format, "format"); - - this.appendable = appendable; - this.format = format.copy(); - // TODO: Is it a good idea to do this here instead of on the first call to a print method? - // It seems a pain to have to track whether the header has already been printed or not. - final String[] headerComments = format.getHeaderComments(); - if (headerComments != null) { - for (final String line : headerComments) { - printComment(line); - } - } - if (format.getHeader() != null && !format.getSkipHeaderRecord()) { - this.printRecord((Object[]) format.getHeader()); - } - } - - @Override - public void close() throws IOException { - close(false); - } - - /** - * Closes the underlying stream with an optional flush first. - * @param flush whether to flush before the actual close. - * @throws IOException - * If an I/O error occurs - * @since 1.6 - */ - public void close(final boolean flush) throws IOException { - if (flush || format.getAutoFlush()) { - flush(); - } - if (appendable instanceof Closeable) { - ((Closeable) appendable).close(); - } - } - - /** - * Outputs the record separator and increments the record count. - * - * @throws IOException - * If an I/O error occurs - */ - private synchronized void endOfRecord() throws IOException { - println(); - recordCount++; - } - - /** - * Flushes the underlying stream. - * - * @throws IOException - * If an I/O error occurs - */ - @Override - public void flush() throws IOException { - if (appendable instanceof Flushable) { - ((Flushable) appendable).flush(); - } - } - - /** - * Gets the target Appendable. - * - * @return the target Appendable. - */ - public Appendable getOut() { - return this.appendable; - } - - /** - * Gets the record count printed, this does not include comments or headers. - * - * @return the record count, this does not include comments or headers. - * @since 1.13.0 - */ - public long getRecordCount() { - return recordCount; - } - - /** - * Prints the string as the next value on the line. The value will be escaped or encapsulated as needed. - * - * @param value - * value to be output. - * @throws IOException - * If an I/O error occurs - */ - public synchronized void print(final Object value) throws IOException { - format.print(value, appendable, newRecord); - newRecord = false; - } - - /** - * Prints a comment on a new line among the delimiter-separated values. - * - *

    - * Comments will always begin on a new line and occupy at least one full line. The character specified to start - * comments and a space will be inserted at the beginning of each new line in the comment. - *

    - * - *

    - * If comments are disabled in the current CSV format this method does nothing. - *

    - * - *

    This method detects line breaks inside the comment string and inserts {@link CSVFormat#getRecordSeparator()} - * to start a new line of the comment. Note that this might produce unexpected results for formats that do not use - * line breaks as record separators.

    - * - * @param comment - * the comment to output - * @throws IOException - * If an I/O error occurs - */ - public synchronized void printComment(final String comment) throws IOException { - if (comment == null || !format.isCommentMarkerSet()) { - return; - } - if (!newRecord) { - println(); - } - appendable.append(format.getCommentMarker().charValue()); // N.B. Explicit (un)boxing is intentional - appendable.append(SP); - for (int i = 0; i < comment.length(); i++) { - final char c = comment.charAt(i); - switch (c) { - case CR: - if (i + 1 < comment.length() && comment.charAt(i + 1) == LF) { - i++; - } - //$FALL-THROUGH$ break intentionally excluded. - case LF: - println(); - appendable.append(format.getCommentMarker().charValue()); // N.B. Explicit (un)boxing is intentional - appendable.append(SP); - break; - default: - appendable.append(c); - break; - } - } - println(); - } - - /** - * Prints headers for a result set based on its metadata. - * - * @param resultSet The ResultSet to query for metadata. - * @throws IOException If an I/O error occurs. - * @throws SQLException If a database access error occurs or this method is called on a closed result set. - * @since 1.9.0 - */ - public synchronized void printHeaders(final ResultSet resultSet) throws IOException, SQLException { - try (IOStream stream = IOStream.of(format.builder().setHeader(resultSet).get().getHeader())) { - stream.forEachOrdered(this::print); - } - println(); - } - - /** - * Outputs the record separator. - * - * @throws IOException - * If an I/O error occurs - */ - public synchronized void println() throws IOException { - format.println(appendable); - newRecord = true; - } - - /** - * Prints the given values as a single record of delimiter-separated values followed by the record separator. - * - *

    - * The values will be quoted if needed. Quotes and newLine characters will be escaped. This method adds the record - * separator to the output after printing the record, so there is no need to call {@link #println()}. - *

    - * - * @param values - * values to output. - * @throws IOException - * If an I/O error occurs - */ - @SuppressWarnings("resource") - public synchronized void printRecord(final Iterable values) throws IOException { - IOStream.of(values).forEachOrdered(this::print); - endOfRecord(); - } - - /** - * Prints the given values as a single record of delimiter-separated values followed by the record separator. - * - *

    - * The values will be quoted if needed. Quotes and newLine characters will be escaped. This method adds the record - * separator to the output after printing the record, so there is no need to call {@link #println()}. - *

    - * - * @param values - * values to output. - * @throws IOException - * If an I/O error occurs - */ - public void printRecord(final Object... values) throws IOException { - printRecord(Arrays.asList(values)); - } - - /** - * Prints the given values as a single record of delimiter-separated values followed by the record separator. - * - *

    - * The values will be quoted if needed. Quotes and newLine characters will be escaped. This method adds the record - * separator to the output after printing the record, so there is no need to call {@link #println()}. - *

    - * - * @param values - * values to output. - * @throws IOException - * If an I/O error occurs - * @since 1.10.0 - */ - @SuppressWarnings("resource") // caller closes. - public synchronized void printRecord(final Stream values) throws IOException { - IOStream.adapt(values).forEachOrdered(this::print); - endOfRecord(); - } - - private void printRecordObject(final Object value) throws IOException { - if (value instanceof Object[]) { - this.printRecord((Object[]) value); - } else if (value instanceof Iterable) { - this.printRecord((Iterable) value); - } else { - this.printRecord(value); - } - } - - /** - * Prints all the objects in the given {@link Iterable} handling nested collections/arrays as records. - * - *

    - * If the given Iterable only contains simple objects, this method will print a single record like - * {@link #printRecord(Iterable)}. If the given Iterable contains nested collections/arrays those nested elements - * will each be printed as records using {@link #printRecord(Object...)}. - *

    - * - *

    - * Given the following data structure: - *

    - * - *
    {@code
    -     * List data = new ArrayList<>();
    -     * data.add(new String[]{ "A", "B", "C" });
    -     * data.add(new String[]{ "1", "2", "3" });
    -     * data.add(new String[]{ "A1", "B2", "C3" });
    -     * }
    -     * 
    - * - *

    - * Calling this method will print: - *

    - * - *
    -     * {@code
    -     * A, B, C
    -     * 1, 2, 3
    -     * A1, B2, C3
    -     * }
    -     * 
    - * - * @param values - * the values to print. - * @throws IOException - * If an I/O error occurs - */ - @SuppressWarnings("resource") - public void printRecords(final Iterable values) throws IOException { - IOStream.of(values).forEachOrdered(this::printRecordObject); - } - - /** - * Prints all the objects in the given array handling nested collections/arrays as records. - * - *

    - * If the given array only contains simple objects, this method will print a single record like - * {@link #printRecord(Object...)}. If the given collections contain nested collections or arrays, those nested - * elements will each be printed as records using {@link #printRecord(Object...)}. - *

    - * - *

    - * Given the following data structure: - *

    - * - *
    {@code
    -     * String[][] data = new String[3][]
    -     * data[0] = String[]{ "A", "B", "C" };
    -     * data[1] = new String[]{ "1", "2", "3" };
    -     * data[2] = new String[]{ "A1", "B2", "C3" };
    -     * }
    -     * 
    - * - *

    - * Calling this method will print: - *

    - * - *
    {@code
    -     * A, B, C
    -     * 1, 2, 3
    -     * A1, B2, C3
    -     * }
    -     * 
    - * - * @param values - * the values to print. - * @throws IOException - * If an I/O error occurs - */ - public void printRecords(final Object... values) throws IOException { - printRecords(Arrays.asList(values)); - } - - /** - * Prints all the objects in the given JDBC result set. - * - * @param resultSet - * The values to print. - * @throws IOException - * If an I/O error occurs. - * @throws SQLException - * Thrown when a database access error occurs. - */ - public void printRecords(final ResultSet resultSet) throws SQLException, IOException { - final int columnCount = resultSet.getMetaData().getColumnCount(); - while (resultSet.next()) { - for (int i = 1; i <= columnCount; i++) { - final Object object = resultSet.getObject(i); - if (object instanceof Clob) { - try (Reader reader = ((Clob) object).getCharacterStream()) { - print(reader); - } - } else if (object instanceof Blob) { - try (InputStream inputStream = ((Blob) object).getBinaryStream()) { - print(inputStream); - } - } else { - print(object); - } - } - endOfRecord(); - } - } - - /** - * Prints all the objects with metadata in the given JDBC result set based on the header boolean. - * - * @param resultSet source of row data. - * @param printHeader whether to print headers. - * @throws IOException If an I/O error occurs - * @throws SQLException if a database access error occurs - * @since 1.9.0 - */ - public void printRecords(final ResultSet resultSet, final boolean printHeader) throws SQLException, IOException { - if (printHeader) { - printHeaders(resultSet); - } - printRecords(resultSet); - } - - /** - * Prints all the objects in the given {@link Stream} handling nested collections/arrays as records. - * - *

    - * If the given Stream only contains simple objects, this method will print a single record like - * {@link #printRecord(Iterable)}. If the given Stream contains nested collections/arrays those nested elements - * will each be printed as records using {@link #printRecord(Object...)}. - *

    - * - *

    - * Given the following data structure: - *

    - * - *
    {@code
    -     * List data = new ArrayList<>();
    -     * data.add(new String[]{ "A", "B", "C" });
    -     * data.add(new String[]{ "1", "2", "3" });
    -     * data.add(new String[]{ "A1", "B2", "C3" });
    -     * Stream stream = data.stream();
    -     * }
    -     * 
    - * - *

    - * Calling this method will print: - *

    - * - *
    -     * {@code
    -     * A, B, C
    -     * 1, 2, 3
    -     * A1, B2, C3
    -     * }
    -     * 
    - * - * @param values - * the values to print. - * @throws IOException - * If an I/O error occurs - * @since 1.10.0 - */ - @SuppressWarnings({ "resource" }) // Caller closes. - public void printRecords(final Stream values) throws IOException { - IOStream.adapt(values).forEachOrdered(this::printRecordObject); - } -} +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.commons.csv; + +import static org.apache.commons.csv.Constants.CR; +import static org.apache.commons.csv.Constants.LF; +import static org.apache.commons.csv.Constants.SP; + +import java.io.Closeable; +import java.io.Flushable; +import java.io.IOException; +import java.io.InputStream; +import java.io.Reader; +import java.sql.Blob; +import java.sql.Clob; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.Statement; +import java.util.Arrays; +import java.util.Objects; +import java.util.concurrent.locks.ReentrantLock; +import java.util.stream.Stream; + +import org.apache.commons.io.function.IOStream; + +/** + * Prints values in a {@link CSVFormat CSV format}. + * + *

    Values can be appended to the output by calling the {@link #print(Object)} method. + * Values are printed according to {@link String#valueOf(Object)}. + * To complete a record the {@link #println()} method has to be called. + * Comments can be appended by calling {@link #printComment(String)}. + * However a comment will only be written to the output if the {@link CSVFormat} supports comments. + *

    + * + *

    The printer also supports appending a complete record at once by calling {@link #printRecord(Object...)} + * or {@link #printRecord(Iterable)}. + * Furthermore {@link #printRecords(Object...)}, {@link #printRecords(Iterable)} and {@link #printRecords(ResultSet)} + * methods can be used to print several records at once. + *

    + * + *

    Example:

    + * + *
    + * try (CSVPrinter printer = new CSVPrinter(new FileWriter("csv.txt"), CSVFormat.EXCEL)) {
    + *     printer.printRecord("id", "userName", "firstName", "lastName", "birthday");
    + *     printer.printRecord(1, "john73", "John", "Doe", LocalDate.of(1973, 9, 15));
    + *     printer.println();
    + *     printer.printRecord(2, "mary", "Mary", "Meyer", LocalDate.of(1985, 3, 29));
    + * } catch (IOException ex) {
    + *     ex.printStackTrace();
    + * }
    + * 
    + * + *

    This code will write the following to csv.txt:

    + *
    + * id,userName,firstName,lastName,birthday
    + * 1,john73,John,Doe,1973-09-15
    + *
    + * 2,mary,Mary,Meyer,1985-03-29
    + * 
    + */ +public final class CSVPrinter implements Flushable, Closeable { + + /** The place that the values get written. */ + private final Appendable appendable; + + private final CSVFormat format; + + /** True if we just began a new record. */ + private boolean newRecord = true; + + private long recordCount; + + private final ReentrantLock lock = new ReentrantLock(); + + /** + * Creates a printer that will print values to the given stream following the CSVFormat. + *

    + * Currently, only a pure encapsulation format or a pure escaping format is supported. Hybrid formats (encapsulation and escaping with a different + * character) are not supported. + *

    + * + * @param appendable stream to which to print. Must not be null. + * @param format the CSV format. Must not be null. + * @throws IOException thrown if the optional header cannot be printed. + * @throws IllegalArgumentException thrown if the parameters of the format are inconsistent. + * @throws NullPointerException thrown if either parameters are null. + */ + public CSVPrinter(final Appendable appendable, final CSVFormat format) throws IOException { + Objects.requireNonNull(appendable, "appendable"); + Objects.requireNonNull(format, "format"); + this.appendable = appendable; + this.format = format.copy(); + // TODO: Is it a good idea to do this here instead of on the first call to a print method? + // It seems a pain to have to track whether the header has already been printed or not. + final String[] headerComments = format.getHeaderComments(); + if (headerComments != null) { + for (final String line : headerComments) { + printComment(line); + } + } + if (format.getHeader() != null && !format.getSkipHeaderRecord()) { + this.printRecord((Object[]) format.getHeader()); + } + } + + @Override + public void close() throws IOException { + close(false); + } + + /** + * Closes the underlying stream with an optional flush first. + * + * @param flush whether to flush before the actual close. + * @throws IOException + * If an I/O error occurs + * @since 1.6 + * @see CSVFormat#getAutoFlush() + */ + public void close(final boolean flush) throws IOException { + if (flush || format.getAutoFlush()) { + flush(); + } + if (appendable instanceof Closeable) { + ((Closeable) appendable).close(); + } + } + + /** + * Prints the record separator and increments the record count. + * + * @throws IOException + * If an I/O error occurs + */ + private void endOfRecord() throws IOException { + println(); + recordCount++; + } + + /** + * Flushes the underlying stream. + * + * @throws IOException + * If an I/O error occurs + */ + @Override + public void flush() throws IOException { + if (appendable instanceof Flushable) { + ((Flushable) appendable).flush(); + } + } + + /** + * Gets the target Appendable. + * + * @return the target Appendable. + */ + public Appendable getOut() { + return appendable; + } + + /** + * Gets the record count printed, this does not include comments or headers. + * + * @return the record count, this does not include comments or headers. + * @since 1.13.0 + */ + public long getRecordCount() { + return recordCount; + } + + /** + * Prints the string as the next value on the line. The value will be escaped or encapsulated as needed. + * + * @param value + * value to be output. + * @throws IOException + * If an I/O error occurs + */ + public void print(final Object value) throws IOException { + lock.lock(); + try { + printRaw(value); + } finally { + lock.unlock(); + } + } + + /** + * Prints a comment on a new line among the delimiter-separated values. + * + *

    + * Comments will always begin on a new line and occupy at least one full line. The character specified to start + * comments and a space will be inserted at the beginning of each new line in the comment. + *

    + * + *

    + * If comments are disabled in the current CSV format this method does nothing. + *

    + * + *

    This method detects line breaks inside the comment string and inserts {@link CSVFormat#getRecordSeparator()} + * to start a new line of the comment. Note that this might produce unexpected results for formats that do not use + * line breaks as record separators.

    + * + * @param comment + * the comment to output + * @throws IOException + * If an I/O error occurs + */ + public void printComment(final String comment) throws IOException { + lock.lock(); + try { + if (comment == null || !format.isCommentMarkerSet()) { + return; + } + if (!newRecord) { + println(); + } + appendable.append(format.getCommentMarker().charValue()); // Explicit unboxing is intentional + appendable.append(SP); + for (int i = 0; i < comment.length(); i++) { + final char c = comment.charAt(i); + switch (c) { + case CR: + if (i + 1 < comment.length() && comment.charAt(i + 1) == LF) { + i++; + } + // falls-through: break intentionally excluded. + case LF: + println(); + appendable.append(format.getCommentMarker().charValue()); // Explicit unboxing is intentional + appendable.append(SP); + break; + default: + appendable.append(c); + break; + } + } + println(); + } finally { + lock.unlock(); + } + } + + /** + * Prints headers for a result set based on its metadata. + * + * @param resultSet The ResultSet to query for metadata. + * @throws IOException If an I/O error occurs. + * @throws SQLException If a database access error occurs or this method is called on a closed result set. + * @since 1.9.0 + */ + public void printHeaders(final ResultSet resultSet) throws IOException, SQLException { + lock.lock(); + try { + try (IOStream stream = IOStream.of(format.builder().setHeader(resultSet).get().getHeader())) { + stream.forEachOrdered(this::print); + } + println(); + } finally { + lock.unlock(); + } + } + + /** + * Prints the record separator. + * + * @throws IOException + * If an I/O error occurs + */ + public void println() throws IOException { + lock.lock(); + try { + format.println(appendable); + newRecord = true; + } finally { + lock.unlock(); + } + } + + /** + * Prints the string as the next value on the line. The value will be escaped or encapsulated as needed. + * + * @param value + * value to be output. + * @throws IOException + * If an I/O error occurs + */ + private void printRaw(final Object value) throws IOException { + format.print(value, appendable, newRecord); + newRecord = false; + } + + /** + * Prints the given values as a single record of delimiter-separated values followed by the record separator. + * + *

    + * The values will be quoted if needed. Quotes and newLine characters will be escaped. This method adds the record + * separator to the output after printing the record, so there is no need to call {@link #println()}. + *

    + * + * @param values + * values to output. + * @throws IOException + * If an I/O error occurs + */ + @SuppressWarnings("resource") + public void printRecord(final Iterable values) throws IOException { + lock.lock(); + try { + IOStream.of(values).forEachOrdered(this::print); + endOfRecord(); + } finally { + lock.unlock(); + } + } + + /** + * Prints the given values as a single record of delimiter-separated values followed by the record separator. + * + *

    + * The values will be quoted if needed. Quotes and newLine characters will be escaped. This method adds the record + * separator to the output after printing the record, so there is no need to call {@link #println()}. + *

    + * + * @param values + * values to output. + * @throws IOException + * If an I/O error occurs + */ + public void printRecord(final Object... values) throws IOException { + printRecord(Arrays.asList(values)); + } + + /** + * Prints the given values as a single record of delimiter-separated values followed by the record separator. + * + *

    + * The values will be quoted if needed. Quotes and newLine characters will be escaped. This method adds the record + * separator to the output after printing the record, so there is no need to call {@link #println()}. + *

    + * + * @param stream + * values to output. + * @throws IOException + * If an I/O error occurs + * @since 1.10.0 + */ + @SuppressWarnings("resource") // caller closes. + public void printRecord(final Stream stream) throws IOException { + lock.lock(); + try { + IOStream.adapt(stream).forEachOrdered(stream.isParallel() ? this::printRaw : this::print); + endOfRecord(); + } finally { + lock.unlock(); + } + } + + private void printRecordObject(final Object value) throws IOException { + if (value instanceof Object[]) { + this.printRecord((Object[]) value); + } else if (value instanceof Iterable) { + this.printRecord((Iterable) value); + } else { + this.printRecord(value); + } + } + + @SuppressWarnings("resource") + private void printRecords(final IOStream stream) throws IOException { + format.limit(stream).forEachOrdered(this::printRecordObject); + } + + /** + * Prints all the objects in the given {@link Iterable} handling nested collections/arrays as records. + * + *

    + * If the given Iterable only contains simple objects, this method will print a single record like + * {@link #printRecord(Iterable)}. If the given Iterable contains nested collections/arrays those nested elements + * will each be printed as records using {@link #printRecord(Object...)}. + *

    + * + *

    + * Given the following data structure: + *

    + * + *
    {@code
    +     * List data = new ArrayList<>();
    +     * data.add(new String[]{ "A", "B", "C" });
    +     * data.add(new String[]{ "1", "2", "3" });
    +     * data.add(new String[]{ "A1", "B2", "C3" });
    +     * }
    +     * 
    + * + *

    + * Calling this method will print: + *

    + * + *
    +     * {@code
    +     * A, B, C
    +     * 1, 2, 3
    +     * A1, B2, C3
    +     * }
    +     * 
    + * + * @param values + * the values to print. + * @throws IOException + * If an I/O error occurs + */ + @SuppressWarnings("resource") + public void printRecords(final Iterable values) throws IOException { + printRecords(IOStream.of(values)); + } + + /** + * Prints all the objects in the given array handling nested collections/arrays as records. + * + *

    + * If the given array only contains simple objects, this method will print a single record like + * {@link #printRecord(Object...)}. If the given collections contain nested collections or arrays, those nested + * elements will each be printed as records using {@link #printRecord(Object...)}. + *

    + * + *

    + * Given the following data structure: + *

    + * + *
    {@code
    +     * String[][] data = new String[3][]
    +     * data[0] = String[]{ "A", "B", "C" };
    +     * data[1] = new String[]{ "1", "2", "3" };
    +     * data[2] = new String[]{ "A1", "B2", "C3" };
    +     * }
    +     * 
    + * + *

    + * Calling this method will print: + *

    + * + *
    {@code
    +     * A, B, C
    +     * 1, 2, 3
    +     * A1, B2, C3
    +     * }
    +     * 
    + * + * @param values + * the values to print. + * @throws IOException + * If an I/O error occurs + */ + public void printRecords(final Object... values) throws IOException { + printRecords(Arrays.asList(values)); + } + + /** + * Prints all the objects in the given JDBC result set. + *

    + * You can use {@link CSVFormat.Builder#setMaxRows(long)} to limit how many rows a result set produces. This is most useful when you cannot limit rows + * through {@link Statement#setLargeMaxRows(long)} or {@link Statement#setMaxRows(int)}. + *

    + * + * @param resultSet The values to print. + * @throws IOException If an I/O error occurs. + * @throws SQLException Thrown when a database access error occurs. + */ + public void printRecords(final ResultSet resultSet) throws SQLException, IOException { + final int columnCount = resultSet.getMetaData().getColumnCount(); + while (resultSet.next() && format.useRow(resultSet.getRow())) { + lock.lock(); + try { + for (int i = 1; i <= columnCount; i++) { + final Object object = resultSet.getObject(i); + if (object instanceof Clob) { + try (Reader reader = ((Clob) object).getCharacterStream()) { + print(reader); + } + } else if (object instanceof Blob) { + try (InputStream inputStream = ((Blob) object).getBinaryStream()) { + print(inputStream); + } + } else { + print(object); + } + } + endOfRecord(); + } finally { + lock.unlock(); + } + } + } + + /** + * Prints all the objects with metadata in the given JDBC result set based on the header boolean. + *

    + * You can use {@link CSVFormat.Builder#setMaxRows(long)} to limit how many rows a result set produces. This is most useful when you cannot limit rows + * through {@link Statement#setLargeMaxRows(long)} or {@link Statement#setMaxRows(int)}. + *

    + * + * @param resultSet source of row data. + * @param printHeader whether to print headers. + * @throws IOException If an I/O error occurs + * @throws SQLException if a database access error occurs + * @since 1.9.0 + */ + public void printRecords(final ResultSet resultSet, final boolean printHeader) throws SQLException, IOException { + if (printHeader) { + printHeaders(resultSet); + } + printRecords(resultSet); + } + + /** + * Prints all the objects in the given {@link Stream} handling nested collections/arrays as records. + * + *

    + * If the given Stream only contains simple objects, this method will print a single record like + * {@link #printRecord(Iterable)}. If the given Stream contains nested collections/arrays those nested elements + * will each be printed as records using {@link #printRecord(Object...)}. + *

    + * + *

    + * Given the following data structure: + *

    + * + *
    {@code
    +     * List data = new ArrayList<>();
    +     * data.add(new String[]{ "A", "B", "C" });
    +     * data.add(new String[]{ "1", "2", "3" });
    +     * data.add(new String[]{ "A1", "B2", "C3" });
    +     * Stream stream = data.stream();
    +     * }
    +     * 
    + * + *

    + * Calling this method will print: + *

    + * + *
    +     * {@code
    +     * A, B, C
    +     * 1, 2, 3
    +     * A1, B2, C3
    +     * }
    +     * 
    + * + * @param values + * the values to print. + * @throws IOException + * If an I/O error occurs + * @since 1.10.0 + */ + @SuppressWarnings({ "resource" }) // Caller closes. + public void printRecords(final Stream values) throws IOException { + printRecords(IOStream.adapt(values)); + } +} diff --git a/src/main/java/org/apache/commons/csv/CSVRecord.java b/src/main/java/org/apache/commons/csv/CSVRecord.java index 1fac65843d..8dab14d907 100644 --- a/src/main/java/org/apache/commons/csv/CSVRecord.java +++ b/src/main/java/org/apache/commons/csv/CSVRecord.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv; @@ -48,25 +50,31 @@ public final class CSVRecord implements Serializable, Iterable { */ private final long characterPosition; - /** The accumulated comments (if any) */ + /** + * The starting position of this record in the source stream, measured in bytes. + */ + private final long bytePosition; + + /** The accumulated comments (if any). */ private final String comment; /** The record number. */ private final long recordNumber; - /** The values of the record */ + /** The values of the record. */ private final String[] values; /** The parser that originates this record. This is not serialized. */ private final transient CSVParser parser; - CSVRecord(final CSVParser parser, final String[] values, final String comment, final long recordNumber, - final long characterPosition) { + CSVRecord(final CSVParser parser, final String[] values, final String comment, final long recordNumber, + final long characterPosition, final long bytePosition) { this.recordNumber = recordNumber; this.values = values != null ? values : Constants.EMPTY_STRING_ARRAY; this.parser = parser; this.comment = comment; this.characterPosition = characterPosition; + this.bytePosition = bytePosition; } /** @@ -106,9 +114,9 @@ public String get(final int i) { * the name of the column to be retrieved. * @return the column value, maybe null depending on {@link CSVFormat#getNullString()}. * @throws IllegalStateException - * if no header mapping was provided + * if no header mapping was provided. * @throws IllegalArgumentException - * if {@code name} is not mapped or if the record is inconsistent + * if {@code name} is not mapped or if the record is inconsistent. * @see #isMapped(String) * @see #isConsistent() * @see #getParser() @@ -117,23 +125,31 @@ public String get(final int i) { public String get(final String name) { final Map headerMap = getHeaderMapRaw(); if (headerMap == null) { - throw new IllegalStateException( - "No header mapping was specified, the record values can't be accessed by name"); + throw new IllegalStateException("No header mapping was specified, the record values can't be accessed by name"); } final Integer index = headerMap.get(name); if (index == null) { - throw new IllegalArgumentException(String.format("Mapping for %s not found, expected one of %s", name, - headerMap.keySet())); + throw new IllegalArgumentException(String.format("Mapping for %s not found, expected one of %s", name, headerMap.keySet())); } try { - return values[index.intValue()]; // N.B. Explicit (un)boxing is intentional + return values[index.intValue()]; // Explicit unboxing is intentional } catch (final ArrayIndexOutOfBoundsException e) { - throw new IllegalArgumentException(String.format( - "Index for header '%s' is %d but CSVRecord only has %d values!", name, index, - Integer.valueOf(values.length))); // N.B. Explicit (un)boxing is intentional + // Explicit boxing is intentional + throw new IllegalArgumentException( + String.format("Index for header '%s' is %d but CSVRecord only has %d values!", name, index, Integer.valueOf(values.length))); } } + /** + * Returns the starting position of this record in the source stream, measured in bytes. + * + * @return the byte position of this record in the source stream. + * @since 1.13.0 + */ + public long getBytePosition() { + return bytePosition; + } + /** * Returns the start position of this record as a character position in the source stream. This may or may not * correspond to the byte position depending on the character set. @@ -147,7 +163,7 @@ public long getCharacterPosition() { /** * Returns the comment for this record, if any. * Note that comments are attached to the following record. - * If there is no following record (i.e. the comment is at EOF), + * If there is no following record (that is, the comment is at EOF), * then the comment will be ignored. * * @return the comment for this record, or null if no comment for this record is available. @@ -179,7 +195,7 @@ public CSVParser getParser() { * Returns the number of this record in the parsed CSV file. * *

    - * ATTENTION: If your CSV input has multi-line values, the returned number does not correspond to + * NOTE:If your CSV input has multi-line values, the returned number does not correspond to * the current line number of the parser that created this record. *

    * @@ -193,10 +209,10 @@ public long getRecordNumber() { /** * Checks whether this record has a comment, false otherwise. * Note that comments are attached to the following record. - * If there is no following record (i.e. the comment is at EOF), + * If there is no following record (that is, the comment is at EOF), * then the comment will be ignored. * - * @return true if this record has a comment, false otherwise + * @return true if this record has a comment, false otherwise. * @since 1.3 */ public boolean hasComment() { @@ -211,7 +227,7 @@ public boolean hasComment() { * test but still produce parsable files. *

    * - * @return true of this record is valid, false if not + * @return true of this record is valid, false if not. */ public boolean isConsistent() { final Map headerMap = getHeaderMapRaw(); @@ -219,7 +235,7 @@ public boolean isConsistent() { } /** - * Checks whether a given column is mapped, i.e. its name has been defined to the parser. + * Checks whether a given column is mapped, that is, its name has been defined to the parser. * * @param name * the name of the column to be retrieved. @@ -234,8 +250,8 @@ public boolean isMapped(final String name) { * Checks whether a column with a given index has a value. * * @param index - * a column index (0-based) - * @return whether a column with a given index has a value + * a column index (0-based). + * @return whether a column with a given index has a value. */ public boolean isSet(final int index) { return 0 <= index && index < values.length; @@ -246,10 +262,10 @@ public boolean isSet(final int index) { * * @param name * the name of the column to be retrieved. - * @return whether a given column is mapped and has a value + * @return whether a given column is mapped and has a value. */ public boolean isSet(final String name) { - return isMapped(name) && getHeaderMapRaw().get(name).intValue() < values.length; // N.B. Explicit (un)boxing is intentional + return isMapped(name) && getHeaderMapRaw().get(name).intValue() < values.length; // Explicit unboxing is intentional } /** @@ -265,7 +281,7 @@ public Iterator iterator() { /** * Puts all values of this record into the given Map. * - * @param the map type + * @param The map type. * @param map The Map to populate. * @return the given map. * @since 1.9.0 @@ -336,14 +352,13 @@ public Map toMap() { */ @Override public String toString() { - return "CSVRecord [comment='" + comment + "', recordNumber=" + recordNumber + ", values=" + - Arrays.toString(values) + "]"; + return "CSVRecord [comment='" + comment + "', recordNumber=" + recordNumber + ", values=" + Arrays.toString(values) + "]"; } /** - * Gets the values for this record. This is not a copy. + * Gets the values for this record. This is not a copy. * - * @return the values for this record. + * @return the values for this record, never null. * @since 1.10.0 */ public String[] values() { diff --git a/src/main/java/org/apache/commons/csv/Constants.java b/src/main/java/org/apache/commons/csv/Constants.java index cc6fb08d87..9dd276eccc 100644 --- a/src/main/java/org/apache/commons/csv/Constants.java +++ b/src/main/java/org/apache/commons/csv/Constants.java @@ -1,88 +1,90 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.apache.commons.csv; - -/** - * Private constants to this package. - */ -final class Constants { - - static final char BACKSLASH = '\\'; - - static final char BACKSPACE = '\b'; - - static final String COMMA = ","; - - /** - * Starts a comment, the remainder of the line is the comment. - */ - static final char COMMENT = '#'; - - static final char CR = '\r'; - - /** RFC 4180 defines line breaks as CRLF */ - static final String CRLF = "\r\n"; - - static final Character DOUBLE_QUOTE_CHAR = Character.valueOf('"'); // N.B. Explicit (un)boxing is intentional - - static final String EMPTY = ""; - - static final String[] EMPTY_STRING_ARRAY = {}; - - static final char FF = '\f'; - - static final char LF = '\n'; - - /** - * Unicode line separator. - */ - static final String LINE_SEPARATOR = "\u2028"; - - /** - * Unicode next line. - */ - static final String NEXT_LINE = "\u0085"; - - /** - * Unicode paragraph separator. - */ - static final String PARAGRAPH_SEPARATOR = "\u2029"; - - static final char PIPE = '|'; - - /** ASCII record separator */ - static final char RS = 30; - - static final char SP = ' '; - - static final String SQL_NULL_STRING = "\\N"; - - static final char TAB = '\t'; - - /** Undefined state for the lookahead char */ - static final int UNDEFINED = -2; - - /** ASCII unit separator */ - static final char US = 31; - - /** No instances. */ - private Constants() { - // noop - } - -} +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.commons.csv; + +/** + * Private constants for this package. + */ +final class Constants { + + static final char BACKSLASH = '\\'; + + static final char BACKSPACE = '\b'; + + static final String COMMA = ","; + + /** + * Starts a comment, the remainder of the line is the comment. + */ + static final char COMMENT = '#'; + + static final char CR = '\r'; + + /** RFC 4180 defines line breaks as CRLF. */ + static final String CRLF = "\r\n"; + + static final Character DOUBLE_QUOTE_CHAR = Character.valueOf('"'); // Explicit boxing is intentional. + + static final String EMPTY = ""; + + static final String[] EMPTY_STRING_ARRAY = {}; + + static final char FF = '\f'; + + static final char LF = '\n'; + + /** + * Unicode line separator. + */ + static final String LINE_SEPARATOR = "\u2028"; + + /** + * Unicode next line. + */ + static final String NEXT_LINE = "\u0085"; + + /** + * Unicode paragraph separator. + */ + static final String PARAGRAPH_SEPARATOR = "\u2029"; + + static final char PIPE = '|'; + + /** ASCII record separator. */ + static final char RS = 30; + + static final char SP = ' '; + + static final String SQL_NULL_STRING = "\\N"; + + static final char TAB = '\t'; + + /** Undefined state for the lookahead char. */ + static final int UNDEFINED = -2; + + /** ASCII unit separator. */ + static final char US = 31; + + /** No instances. */ + private Constants() { + // noop + } + +} diff --git a/src/main/java/org/apache/commons/csv/DuplicateHeaderMode.java b/src/main/java/org/apache/commons/csv/DuplicateHeaderMode.java index 92f44d30ba..8087f16eeb 100644 --- a/src/main/java/org/apache/commons/csv/DuplicateHeaderMode.java +++ b/src/main/java/org/apache/commons/csv/DuplicateHeaderMode.java @@ -1,24 +1,26 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv; /** - * Determines how duplicate header fields should be handled + * Enumerates how duplicate header fields should be handled * if {@link CSVFormat.Builder#setHeader(Class)} is not null. * * @since 1.10.0 diff --git a/src/main/java/org/apache/commons/csv/ExtendedBufferedReader.java b/src/main/java/org/apache/commons/csv/ExtendedBufferedReader.java index 18c922a508..20c1ef5444 100644 --- a/src/main/java/org/apache/commons/csv/ExtendedBufferedReader.java +++ b/src/main/java/org/apache/commons/csv/ExtendedBufferedReader.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv; @@ -24,6 +26,10 @@ import java.io.IOException; import java.io.Reader; +import java.nio.CharBuffer; +import java.nio.charset.CharacterCodingException; +import java.nio.charset.Charset; +import java.nio.charset.CharsetEncoder; import org.apache.commons.io.IOUtils; import org.apache.commons.io.input.UnsynchronizedBufferedReader; @@ -31,36 +37,59 @@ /** * A special buffered reader which supports sophisticated read access. *

    - * In particular the reader supports a look-ahead option, which allows you to see the next char returned by - * {@link #read()}. This reader also tracks how many characters have been read with {@link #getPosition()}. + * In particular the reader supports a look-ahead option, which allows you to see the next char returned by {@link #read()}. This reader also tracks how many + * characters have been read with {@link #getPosition()}. *

    */ final class ExtendedBufferedReader extends UnsynchronizedBufferedReader { /** The last char returned */ private int lastChar = UNDEFINED; + private int lastCharMark = UNDEFINED; /** The count of EOLs (CR/LF/CRLF) seen so far */ private long lineNumber; + private long lineNumberMark; /** The position, which is the number of characters read so far */ private long position; + private long positionMark; + /** The number of bytes read so far. */ + private long bytesRead; + + private long bytesReadMark; + + /** Encoder for calculating the number of bytes for each character read. */ + private final CharsetEncoder encoder; + /** * Constructs a new instance using the default buffer size. */ ExtendedBufferedReader(final Reader reader) { + this(reader, null, false); + } + + /** + * Constructs a new instance with the specified reader, character set, and byte tracking option. Initializes an encoder if byte tracking is enabled and a + * character set is provided. + * + * @param reader the reader supports a look-ahead option. + * @param charset the character set for encoding, or {@code null} if not applicable. + * @param trackBytes {@code true} to enable byte tracking; {@code false} to disable it. + */ + ExtendedBufferedReader(final Reader reader, final Charset charset, final boolean trackBytes) { super(reader); + encoder = charset != null && trackBytes ? charset.newEncoder() : null; } /** * Closes the stream. * - * @throws IOException - * If an I/O error occurs + * @throws IOException If an I/O error occurs */ @Override public void close() throws IOException { @@ -70,10 +99,73 @@ public void close() throws IOException { } /** - * Returns the last character that was read as an integer (0 to 65535). This will be the last character returned by - * any of the read methods. This will not include a character read using the {@link #peek()} method. If no - * character has been read then this will return {@link Constants#UNDEFINED}. If the end of the stream was reached - * on the last read then this will return {@link IOUtils#EOF}. + * Gets the number of bytes read by the reader. + * + * @return the number of bytes read by the read + */ + long getBytesRead() { + return this.bytesRead; + } + + private long getEncodedCharLength(final char[] buf, final int offset, final int length) throws CharacterCodingException { + long len = 0; + int previous = lastChar; + for (int i = offset; i < offset + length; i++) { + len += getEncodedCharLength(previous, buf[i]); + previous = buf[i]; + } + return len; + } + + /** + * Gets the byte length of the given character based on the original Unicode specification, which defined characters as fixed-width 16-bit entities. + *

    + * The Unicode characters are divided into two main ranges: + *

      + *
    • U+0000 to U+FFFF (Basic Multilingual Plane, BMP): + *
        + *
      • Represented using a single 16-bit {@code char}.
      • + *
      • Includes UTF-8 encodings of 1-byte, 2-byte, and some 3-byte characters.
      • + *
      + *
    • + *
    • U+10000 to U+10FFFF (Supplementary Characters): + *
        + *
      • Represented as a pair of {@code char}s:
      • + *
      • The first {@code char} is from the high-surrogates range (\uD800-\uDBFF).
      • + *
      • The second {@code char} is from the low-surrogates range (\uDC00-\uDFFF).
      • + *
      • Includes UTF-8 encodings of some 3-byte characters and all 4-byte characters.
      • + *
      + *
    • + *
    + * + * @param current the current character to process. + * @return the byte length of the character. + * @throws CharacterCodingException if the character cannot be encoded. + */ + private int getEncodedCharLength(final int current) throws CharacterCodingException { + return getEncodedCharLength(lastChar, current); + } + + private int getEncodedCharLength(final int previous, final int current) throws CharacterCodingException { + final char cChar = (char) current; + final char lChar = (char) previous; + if (!Character.isSurrogate(cChar)) { + return encoder.encode(CharBuffer.wrap(new char[] { cChar })).limit(); + } + if (Character.isHighSurrogate(cChar)) { + // Move on to the next char (low surrogate) + return 0; + } + if (Character.isSurrogatePair(lChar, cChar)) { + return encoder.encode(CharBuffer.wrap(new char[] { lChar, cChar })).limit(); + } + throw new CharacterCodingException(); + } + + /** + * Returns the last character that was read as an integer (0 to 65535). This will be the last character returned by any of the read methods. This will not + * include a character read using the {@link #peek()} method. If no character has been read then this will return {@link Constants#UNDEFINED}. If the end of + * the stream was reached on the last read then this will return {@link IOUtils#EOF}. * * @return the last character that was read */ @@ -108,16 +200,19 @@ public void mark(final int readAheadLimit) throws IOException { lineNumberMark = lineNumber; lastCharMark = lastChar; positionMark = position; + bytesReadMark = bytesRead; super.mark(readAheadLimit); } @Override public int read() throws IOException { final int current = super.read(); - if (current == CR || current == LF && lastChar != CR || - current == EOF && lastChar != CR && lastChar != LF && lastChar != EOF) { + if (current == CR || current == LF && lastChar != CR || current == EOF && lastChar != CR && lastChar != LF && lastChar != EOF) { lineNumber++; } + if (encoder != null && current != EOF) { + this.bytesRead += getEncodedCharLength(current); + } lastChar = current; position++; return lastChar; @@ -129,6 +224,9 @@ public int read(final char[] buf, final int offset, final int length) throws IOE return 0; } final int len = super.read(buf, offset, length); + if (encoder != null && len > 0) { + this.bytesRead += getEncodedCharLength(buf, offset, len); + } if (len > 0) { for (int i = offset; i < offset + len; i++) { final char ch = buf[i]; @@ -149,8 +247,7 @@ public int read(final char[] buf, final int offset, final int length) throws IOE } /** - * Gets the next line, dropping the line terminator(s). This method should only be called when processing a - * comment, otherwise, information can be lost. + * Gets the next line, dropping the line terminator(s). This method should only be called when processing a comment, otherwise, information can be lost. *

    * Increments {@link #lineNumber} and updates {@link #position}. *

    @@ -187,7 +284,7 @@ public void reset() throws IOException { lineNumber = lineNumberMark; lastChar = lastCharMark; position = positionMark; + bytesRead = bytesReadMark; super.reset(); } - } diff --git a/src/main/java/org/apache/commons/csv/Lexer.java b/src/main/java/org/apache/commons/csv/Lexer.java index 6d9c8a4850..fe964480a4 100644 --- a/src/main/java/org/apache/commons/csv/Lexer.java +++ b/src/main/java/org/apache/commons/csv/Lexer.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv; @@ -21,6 +23,7 @@ import java.io.Closeable; import java.io.IOException; +import java.util.Arrays; import org.apache.commons.io.IOUtils; @@ -66,8 +69,8 @@ final class Lexer implements Closeable { /** * Appends the next escaped character to the token's content. * - * @param token the current token - * @throws IOException on stream access error + * @param token the current token. + * @throws IOException on stream access error. * @throws CSVException Thrown on invalid input. */ private void appendNextEscapedCharacterToToken(final Token token) throws IOException { @@ -87,7 +90,7 @@ private void appendNextEscapedCharacterToToken(final Token token) throws IOExcep * Closes resources. * * @throws IOException - * If an I/O error occurs + * If an I/O error occurs. */ @Override public void close() throws IOException { @@ -95,18 +98,27 @@ public void close() throws IOException { } /** - * Returns the current character position + * Gets the number of bytes read. * - * @return the current character position + * @return the number of bytes read. + */ + long getBytesRead() { + return reader.getBytesRead(); + } + + /** + * Gets the current character position. + * + * @return the current character position. */ long getCharacterPosition() { return reader.getPosition(); } /** - * Returns the current line number + * Gets the current line number. * - * @return the current line number + * @return the current line number. */ long getCurrentLineNumber() { return reader.getLineNumber(); @@ -125,7 +137,7 @@ boolean isCommentStart(final int ch) { } /** - * Determine whether the next characters constitute a delimiter through {@link ExtendedBufferedReader#peek(char[])}. + * Tests whether the next characters constitute a delimiter through {@link ExtendedBufferedReader#peek(char[])}. * * @param ch * the current character. @@ -141,6 +153,7 @@ boolean isDelimiter(final int ch) throws IOException { isLastTokenDelimiter = true; return true; } + Arrays.fill(delimiterBuf, '\0'); reader.peek(delimiterBuf); for (int i = 0; i < delimiterBuf.length; i++) { if (delimiterBuf[i] != delimiter[i + 1]) { @@ -179,6 +192,7 @@ boolean isEscape(final int ch) { * @throws IOException If an I/O error occurs. */ boolean isEscapeDelimiter() throws IOException { + Arrays.fill(escapeDelimiterBuf, '\0'); reader.peek(escapeDelimiterBuf); if (escapeDelimiterBuf[0] != delimiter[0]) { return false; @@ -203,7 +217,7 @@ boolean isQuoteChar(final int ch) { /** * Tests if the current character represents the start of a line: a CR, LF, or is at the start of the file. * - * @param ch the character to check + * @param ch the character to check. * @return true if the character is at the start of a line. */ boolean isStartOfLine(final int ch) { @@ -263,15 +277,22 @@ Token nextToken(final Token token) throws IOException { } // Important: make sure a new char gets consumed in each iteration while (token.type == Token.Type.INVALID) { + // isDelimiter consumes the trailing characters of a multi-character delimiter as a side effect, so it must + // only be evaluated once per character. Remember a match found while skipping whitespace below. + boolean delimiter = false; // ignore whitespaces at beginning of a token if (ignoreSurroundingSpaces) { - while (Character.isWhitespace((char) c) && !isDelimiter(c) && !eol) { + while (Character.isWhitespace((char) c) && !eol) { + if (isDelimiter(c)) { + delimiter = true; + break; + } c = reader.read(); eol = readEndOfLine(c); } } // ok, start of token reached: encapsulated, or token - if (isDelimiter(c)) { + if (delimiter || isDelimiter(c)) { // empty token return TOKEN("") token.type = Token.Type.TOKEN; } else if (eol) { @@ -329,7 +350,6 @@ private Token parseEncapsulatedToken(final Token token) throws IOException { int c; while (true) { c = reader.read(); - if (isQuoteChar(c)) { if (isQuoteChar(reader.peek())) { // double or escaped encapsulator -> add single encapsulator to token @@ -390,35 +410,36 @@ private Token parseEncapsulatedToken(final Token token) throws IOException { *
  • An unescaped delimiter has been reached (TOKEN)
  • *
* - * @param token the current token - * @param ch the current character - * @return the filled token - * @throws IOException on stream access error + * @param token the current token. + * @param ch the current character. + * @return the filled token. + * @throws IOException on stream access error. * @throws CSVException Thrown on invalid input. */ - private Token parseSimpleToken(final Token token, int ch) throws IOException { + private Token parseSimpleToken(final Token token, final int ch) throws IOException { // Faster to use while(true)+break than while(token.type == INVALID) + int cur = ch; while (true) { - if (readEndOfLine(ch)) { + if (readEndOfLine(cur)) { token.type = Token.Type.EORECORD; break; } - if (isEndOfFile(ch)) { + if (isEndOfFile(cur)) { token.type = Token.Type.EOF; token.isReady = true; // There is data at EOF break; } - if (isDelimiter(ch)) { + if (isDelimiter(cur)) { token.type = Token.Type.TOKEN; break; } // continue - if (isEscape(ch)) { + if (isEscape(cur)) { appendNextEscapedCharacterToToken(token); } else { - token.content.append((char) ch); + token.content.append((char) cur); } - ch = reader.read(); // continue + cur = reader.read(); // continue } if (ignoreSurroundingSpaces) { @@ -431,13 +452,14 @@ private Token parseSimpleToken(final Token token, int ch) throws IOException { /** * Greedily accepts \n, \r and \r\n This checker consumes silently the second control-character... * - * @return true if the given or next character is a line-terminator + * @return true if the given or next character is a line-terminator. */ - boolean readEndOfLine(int ch) throws IOException { + boolean readEndOfLine(final int ch) throws IOException { // check if we have \r\n... - if (ch == Constants.CR && reader.peek() == Constants.LF) { + int cur = ch; + if (cur == Constants.CR && reader.peek() == Constants.LF) { // note: does not change ch outside of this method! - ch = reader.read(); + cur = reader.read(); // Save the EOL state if (firstEol == null) { this.firstEol = Constants.CRLF; @@ -445,14 +467,14 @@ boolean readEndOfLine(int ch) throws IOException { } // save EOL state here. if (firstEol == null) { - if (ch == Constants.LF) { + if (cur == Constants.LF) { this.firstEol = LF_STRING; - } else if (ch == Constants.CR) { + } else if (cur == Constants.CR) { this.firstEol = CR_STRING; } } - return ch == Constants.LF || ch == Constants.CR; + return cur == Constants.LF || cur == Constants.CR; } // TODO escape handling needs more work diff --git a/src/main/java/org/apache/commons/csv/QuoteMode.java b/src/main/java/org/apache/commons/csv/QuoteMode.java index f2fb1f9474..ae64ab4863 100644 --- a/src/main/java/org/apache/commons/csv/QuoteMode.java +++ b/src/main/java/org/apache/commons/csv/QuoteMode.java @@ -1,23 +1,27 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv; /** - * Defines quoting behavior. + * Enumerates quoting behavior. + * + * @see CSVFormat.Builder#setQuoteMode(QuoteMode) */ public enum QuoteMode { diff --git a/src/main/java/org/apache/commons/csv/Token.java b/src/main/java/org/apache/commons/csv/Token.java index b9f1094783..87af335678 100644 --- a/src/main/java/org/apache/commons/csv/Token.java +++ b/src/main/java/org/apache/commons/csv/Token.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv; @@ -22,13 +24,14 @@ /** * Internal token representation. *

- * It is used as a contract between the lexer and the parser. + * This is used as a contract between the lexer and the parser. *

*/ final class Token { enum Type { - /** Token has no valid content, i.e. is in its initialized state. */ + + /** Token has no valid content, that is, is in its initialized state. */ INVALID, /** Token with content, at the beginning or in the middle of a line. */ @@ -45,13 +48,13 @@ enum Type { } /** Length of the initial token (content-)buffer */ - private static final int INITIAL_TOKEN_LENGTH = 50; + private static final int DEFAULT_CAPACITY = 50; /** Token type */ Token.Type type = INVALID; - /** The content buffer. */ - final StringBuilder content = new StringBuilder(INITIAL_TOKEN_LENGTH); + /** The content buffer, never null. */ + final StringBuilder content = new StringBuilder(DEFAULT_CAPACITY); /** Token ready flag: indicates a valid token with content (ready for the parser). */ boolean isReady; @@ -66,12 +69,12 @@ void reset() { } /** - * Eases IDE debugging. + * Converts the token state to a string to ease debugging. * * @return a string helpful for debugging. */ @Override public String toString() { - return type.name() + " [" + content.toString() + "]"; + return type + " [" + content.toString() + "]"; } } diff --git a/src/main/java/org/apache/commons/csv/package-info.java b/src/main/java/org/apache/commons/csv/package-info.java index d8a822bdc8..d3340fcae8 100644 --- a/src/main/java/org/apache/commons/csv/package-info.java +++ b/src/main/java/org/apache/commons/csv/package-info.java @@ -1,22 +1,24 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ /** - * Apache Commons CSV Format Support. + *

Apache Commons CSV

* *

CSV are widely used as interfaces to legacy systems or manual data imports. * CSV stands for "Comma Separated Values" (or sometimes "Character Separated diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html new file mode 100644 index 0000000000..0598cf19d0 --- /dev/null +++ b/src/main/javadoc/overview.html @@ -0,0 +1,375 @@ + + + +Apache Commons CSV Overview + + + Apache Commons CSV +

+ You can find the Javadoc package list at the bottom of this page. +

+
+

Introducing Commons CSV

+

Apache Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format.

+

+ Common CSV formats are predefined in the CSVFormat class: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CSV Formats
CSVFormatDescriptionSince Version
DEFAULTIO for the Standard Comma Separated Value format, like RFC 4180 but allowing + empty lines. + 1.0
EXCELIO for the Microsoft + Excel CSV. format. + 1.0
INFORMIX_UNLOADIO for the Informix UNLOAD TO file_name + command. + 1.3
INFORMIX_UNLOAD_CSVIO for the Informix UNLOAD CSV TO + file_name command with escaping disabled. + 1.3
MONGODB_CSVIO for the MongoDB CSV mongoexport command. + 1.7
MONGODB_TSVIO for the MongoDB Tab Separated Values (TSV)mongoexport + command. + 1.7
MYSQLIO for the MySQL CSV format. + 1.0
ORACLEIO for the Oracle CSV format + of the SQL*Loader utility. + 1.6
POSTGRESQL_CSVIO for the PostgreSQL CSV format used by the COPY + operation. + 1.5
POSTGRESQL_TEXTIO for the PostgreSQL Text format used by the COPY + operation. + 1.5
RFC4180IO for the RFC-4180 format defined byRFC 4180. + 1.0
TDFIO for the Tab Delimited Format (also known as Tab Separated Values). + 1.0
+

Custom formats can be created using a fluent style API.

+
+
+

Parsing Standard CSV Files

+

+ Parsing files with Apache Commons CSV is relatively straight forward. Pick a + CSVFormat + and go from there. +

+
+

Parsing an Excel CSV File

+

To parse an Excel CSV file, write:

+
+        
+Reader in = new FileReader("path/to/file.csv");
+Iterable<CSVRecord> records = CSVFormat.EXCEL.parse(in);
+for (CSVRecord record : records) {
+    String lastName = record.get("Last Name");
+    String firstName = record.get("First Name");
+}
+        
+      
+
+
+
+

Parsing Custom CSV Files

+

+ You can define your own using IO rules by building your own CSVFormat instance. Starting with + CSVFormat.builder() + lets you start from a predefined format and customize. For example: +

+
+      
+CSVFormat myFormat = CSVFormat.DEFAULT.builder()
+    .setCommentMarker('#')
+    .setEscape('+')
+    .setIgnoreSurroundingSpaces(true)
+    .setQuote('"')
+    .setQuoteMode(QuoteMode.ALL)
+    .get()
+      
+    
+
+
+

Handling Byte Order Marks

+

+ To handle files that start with a Byte Order Mark (BOM), like some Excel CSV files, you need an extra step to deal with the optional BOM bytes. Using the + BOMInputStream class from Apache Commons IO simplifies this task; for example: +

+
+        
+try (Reader reader = new InputStreamReader(BOMInputStream.builder()
+        .setPath(path)
+        .get(), "UTF-8");
+        CSVParser parser = CSVFormat.EXCEL.builder()
+                .setHeader()
+                .get()
+                .parse(reader)) {
+    for (CSVRecord record : parser) {
+        String string = record.get("ColumnA");
+        // ...
+    }
+}
+        
+      
+

You might find it handy to create something like this:

+
+        
+/**
+ * Creates a reader capable of handling BOMs.
+ *
+ * @param path The path to read.
+ * @return a new InputStreamReader for UTF-8 bytes.
+ * @throws IOException if an I/O error occurs.
+ */
+public InputStreamReader newReader(final Path path) throws IOException {
+    return new InputStreamReader(BOMInputStream.builder()
+            .setPath(path)
+            .get(), StandardCharsets.UTF_8);
+}
+        
+      
+
+
+

Using Headers

+

+ Apache Commons CSV provides several ways to access record values. The simplest way is to access values by their index in the record. However, columns in + CSV files often have a name, for example: ID, CustomerNo, Birthday, etc. The CSVFormat class provides an API for specifying these header names and + CSVRecord on the other hand has methods to access values by their corresponding header name. +

+
+

Accessing column values by index

+

To access a record value by index, no special configuration of the CSVFormat is necessary:

+
+        
+Reader in = new FileReader("path/to/file.csv");
+Iterable<CSVRecord> records = CSVFormat.RFC4180.parse(in);
+for (CSVRecord record : records) {
+    String columnOne = record.get(0);
+    String columnTwo = record.get(1);
+}
+        
+      
+
+
+

Defining a header manually

+

Indices may not be the most intuitive way to access record values. For this reason it is possible to assign names to each column in the file:

+
+        
+Reader in = new FileReader("path/to/file.csv");
+Iterable<CSVRecord> records = CSVFormat.RFC4180.builder()
+  .setHeader("ID", "CustomerNo", "Name")
+  .build()
+  .parse(in);
+for (CSVRecord record : records) {
+    String id = record.get("ID");
+    String customerNo = record.get("CustomerNo");
+    String name = record.get("Name");
+}
+        
+      
+ Note that column values can still be accessed using their index. +
+
+

Using an enum to define a header

+

Using String values all over the code to reference columns can be error prone. For this reason, it is possible to define an enum to specify header + names. Note that the enum constant names are used to access column values. This may lead to enums constant names which do not follow the Java coding + standard of defining constants in upper case with underscores:

+
+        
+public enum Headers {
+    ID, CustomerNo, Name
+}
+Reader in = new FileReader("path/to/file.csv");
+Iterable<CSVRecord> records = CSVFormat.RFC4180.builder()
+  .setHeader(Headers.class)
+  .build()
+  .parse(in);
+for (CSVRecord record : records) {
+    String id = record.get(Headers.ID);
+    String customerNo = record.get(Headers.CustomerNo);
+    String name = record.get(Headers.Name);
+}
+        
+      
+ Again it is possible to access values by their index and by using a String (for example "CustomerNo"). +
+
+

Header auto detection

+

Some CSV files define header names in their first record. If configured, Apache Commons CSV can parse the header names from the first record:

+
+        
+Reader in = new FileReader("path/to/file.csv");
+Iterable<CSVRecord> records = CSVFormat.RFC4180.builder()
+  .setHeader()
+  .setSkipHeaderRecord(true)
+  .build()
+  .parse(in);
+for (CSVRecord record : records) {
+    String id = record.get("ID");
+    String customerNo = record.get("CustomerNo");
+    String name = record.get("Name");
+}
+        
+      
+ This will use the values from the first record as header names and skip the first record when iterating. +
+
+
+

Printing with headers

+

To print a CSV file with headers, you specify the headers in the format:

+
+        
+Appendable out = ...;
+CSVPrinter printer = CSVFormat.DEFAULT.builder()
+  .setHeader("H1", "H2")
+  .build()
+  .print(out);
+        
+      
+

To print a CSV file with JDBC column labels, you specify the ResultSet in the format:

+
+        
+try (ResultSet resultSet = ...) {
+    CSVPrinter printer = CSVFormat.DEFAULT.builder()
+      .setHeader(resultSet)
+      .build()
+      .print(out);
+}
+        
+      
+
+
+

Working with JDBC

+
+

Exporting JDBC Result Sets

+

+ To export row data from a JDBC + ResultSet + , use CSVPrinter.printRecords(ResultSet) : +

+
+        
+        final StringWriter sw = new StringWriter();
+        final CSVFormat csvFormat = CSVFormat.DEFAULT;
+        try (Connection connection = DriverManager.getConnection("jdbc:h2:mem:my_test;", "sa", "")) {
+            try (Statement stmt = connection.createStatement();
+                    CSVPrinter printer = new CSVPrinter(sw, csvFormat);
+                    ResultSet resultSet = stmt.executeQuery("select ID, NAME, TEXT, BIN_DATA from TEST")) {
+                printer.printRecords(resultSet);
+            }
+        }
+        final String csv = sw.toString();
+        System.out.println(csv);
+        
+        
+
+
+

Limiting rows from JDBC Result Sets

+

SQL lets you limit how many rows a SELECT statement returns with the LIMIT clause.

+

+ When you can't or don't want to change the SQL used to generate rows, JDBC lets you limit how many rows a JDBC Statement returns with the Statement.setMaxRows(int) method. +

+

+ When you get a JDBC ResultSet from an API like + DatabaseMetaData.getProcedures(...), there is no SQL or JDBC Statement to use to set a limit, the ResultSet class does not have an API to limit rows. +

+

+ To simplify limiting ResultSet rows, Commons CVS offers the CSVFormat.Builder.setMaxRows(long) + method. For example: +

+
+        
+        CSVFormat csvFormat = CSVFormat.DEFAULT
+            .setMaxRows(5_000)
+            .get();
+        try (ResultSet resultSet = ...) {
+            csvFormat.printer().printRecords(resultSet);
+        }
+        
+      
+

+ Using the above, calling CSVPrinter.printRecords(ResultSet) will + limit the row count to the maximum number of rows specified in setMaxRows(). +

+

Note that setMaxRows() works with the other methods that print a sequence of records.

+
+
+ + diff --git a/src/media/commons-logo-component-100.xcf b/src/media/commons-logo-component-100.xcf new file mode 100644 index 0000000000..77d92f2779 Binary files /dev/null and b/src/media/commons-logo-component-100.xcf differ diff --git a/src/media/commons-logo-component.xcf b/src/media/commons-logo-component.xcf new file mode 100644 index 0000000000..3670221da7 Binary files /dev/null and b/src/media/commons-logo-component.xcf differ diff --git a/src/media/logo.png b/src/media/logo.png new file mode 100644 index 0000000000..93bb6c0148 Binary files /dev/null and b/src/media/logo.png differ diff --git a/src/site/resources/images/logo.png b/src/site/resources/images/logo.png index 77e721d2c7..93bb6c0148 100644 Binary files a/src/site/resources/images/logo.png and b/src/site/resources/images/logo.png differ diff --git a/src/site/resources/images/logo.xcf b/src/site/resources/images/logo.xcf deleted file mode 100644 index 98ff21ec1d..0000000000 Binary files a/src/site/resources/images/logo.xcf and /dev/null differ diff --git a/src/site/resources/pmd/pmd-ruleset.xml b/src/site/resources/pmd/pmd-ruleset.xml index 86f3a412d4..74e41f991d 100644 --- a/src/site/resources/pmd/pmd-ruleset.xml +++ b/src/site/resources/pmd/pmd-ruleset.xml @@ -7,7 +7,7 @@ (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, @@ -18,7 +18,7 @@ + xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.net/ruleset_2_0_0.xsd"> This ruleset checks the code for discouraged programming constructs. @@ -59,7 +59,6 @@ - diff --git a/src/site/resources/profile.jacoco b/src/site/resources/profile.jacoco index e69de29bb2..0314c63ff2 100644 --- a/src/site/resources/profile.jacoco +++ b/src/site/resources/profile.jacoco @@ -0,0 +1,16 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. diff --git a/src/site/resources/spotbugs/spotbugs-exclude-filter.xml b/src/site/resources/spotbugs/spotbugs-exclude-filter.xml index a7364d40db..79c57d3ae4 100644 --- a/src/site/resources/spotbugs/spotbugs-exclude-filter.xml +++ b/src/site/resources/spotbugs/spotbugs-exclude-filter.xml @@ -6,7 +6,7 @@ (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, @@ -54,5 +54,12 @@ + + + + + + + diff --git a/src/site/site.xml b/src/site/site.xml index 62d9bafd16..232c2056c5 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -7,7 +7,7 @@ (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, @@ -15,32 +15,29 @@ See the License for the specific language governing permissions and limitations under the License. --> - - - - Apache Commons CSV - /images/logo.png - /index.html - Apache Commons CSV&trade; logo + + + - - - - - - - + + + + + + + + + + + + + + - - - - - - - - - - + diff --git a/src/site/xdoc/download_csv.xml b/src/site/xdoc/download_csv.xml index cc7d90bf88..151c3f69ec 100644 --- a/src/site/xdoc/download_csv.xml +++ b/src/site/xdoc/download_csv.xml @@ -7,7 +7,7 @@ The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, @@ -56,10 +56,12 @@ limitations under the License. | | +======================================================================+ --> - + Download Apache Commons CSV - Apache Commons Documentation Team + Apache Commons Team
@@ -79,7 +81,7 @@ limitations under the License. mirrors (at the end of the mirrors list) that should be available.

- [if-any logo][end] + [if-any logo]Logo[end]

@@ -113,32 +115,32 @@ limitations under the License.

-
+
- - - + + + - - - + + +
commons-csv-1.12.0-bin.tar.gzsha512pgpcommons-csv-1.14.1-bin.tar.gzsha512pgp
commons-csv-1.12.0-bin.zipsha512pgpcommons-csv-1.14.1-bin.zipsha512pgp
- - - + + + - - - + + +
commons-csv-1.12.0-src.tar.gzsha512pgpcommons-csv-1.14.1-src.tar.gzsha512pgp
commons-csv-1.12.0-src.zipsha512pgpcommons-csv-1.14.1-src.zipsha512pgp
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml index ec139c8668..ac5b8cfa9f 100644 --- a/src/site/xdoc/index.xml +++ b/src/site/xdoc/index.xml @@ -7,7 +7,7 @@ The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, @@ -18,32 +18,20 @@ limitations under the License. Home - Commons Documentation Team + Apache Commons Team + + + -

Commons CSV reads and writes files in variations of the Comma Separated Value (CSV) format.

-

The most common CSV formats are predefined in the CSVFormat class: -

-

-

Custom formats can be created using a fluent style API.

+

Read the documentation starting with the Javadoc Overview.

-

An overview of the functionality is provided in the -user guide. +user guide. Various project reports are also available.

@@ -58,7 +46,6 @@ The git repository can be browsed.

-
-

The latest code can be checked out from our git repository at https://gitbox.apache.org/repos/asf/commons-csv.git. You can build the component using Apache Maven using mvn clean package.

- +
+

+ Apache Commons CSV requires Java 8 or above. +

+ + + + + + + + + + + + + + + +
Commons CSVJavaAndroid
1.10.0+8Android 7.0 (API level 24)
+

The commons developer mailing list is the main channel of communication for contributors. Please remember that the lists are shared between all commons components, so prefix your email by [csv].

@@ -97,7 +103,6 @@ For previous releases, see the TagList report.

If you'd like to offer up pull requests via GitHub rather than applying patches to JIRA, we have a GitHub mirror.

-

The commons mailing lists act as the main support forum. @@ -111,14 +116,12 @@ For previous releases, see the

Commons CSV was started to unify a common and simple interface for reading and writing CSV files under an ASL license. It has been bootstrapped by a code donation from Netcetera in Switzerland. There are three pre-existing BSD compatible CSV parsers which this component will hopefully make redundant (authors willing):

In addition to the code from Netcetera (org.apache.commons.csv), Martin van den Bemt has added an additional writer API.

Other CSV implementations:

@@ -126,7 +129,5 @@ For previous releases, see the Super CSV
- -
diff --git a/src/site/xdoc/issue-tracking.xml b/src/site/xdoc/issue-tracking.xml index 3564ef4fdd..3aa64b4042 100644 --- a/src/site/xdoc/issue-tracking.xml +++ b/src/site/xdoc/issue-tracking.xml @@ -7,7 +7,7 @@ The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, @@ -41,10 +41,12 @@ limitations under the License. | | +======================================================================+ --> - + Apache Commons CSV Issue tracking - Apache Commons Documentation Team + Apache Commons Team @@ -64,6 +66,7 @@ limitations under the License.

If you would like to report a bug, or raise an enhancement request with Apache Commons CSV please do the following: +

  1. Search existing open bugs. If you find your issue listed then please add a comment with your details.
  2. @@ -73,16 +76,15 @@ limitations under the License.
  3. Submit either a bug report or enhancement request.
-

Please also remember these points: +

  • the more information you provide, the better we can help you
  • test cases are vital, particularly for any proposed enhancements
  • the developers of Apache Commons CSV are all unpaid volunteers
-

For more information on creating patches see the @@ -91,12 +93,12 @@ limitations under the License.

You may also find these links useful: +

-

diff --git a/src/site/xdoc/mail-lists.xml b/src/site/xdoc/mail-lists.xml index 727e4a555a..345cef8996 100644 --- a/src/site/xdoc/mail-lists.xml +++ b/src/site/xdoc/mail-lists.xml @@ -7,7 +7,7 @@ The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, @@ -39,10 +39,12 @@ limitations under the License. | | +======================================================================+ --> - + Apache Commons CSV Mailing Lists - Apache Commons Documentation Team + Apache Commons Team @@ -53,10 +55,10 @@ limitations under the License. To make it easier for people to only read messages related to components they are interested in, the convention in Commons is to prefix the subject line of messages with the component's name, for example: -
    -
  • [csv] Problem with the ...
  • -

+
    +
  • [csv] Problem with the ...
  • +

Questions related to the usage of Apache Commons CSV should be posted to the User List. diff --git a/src/site/xdoc/security.xml b/src/site/xdoc/security.xml new file mode 100644 index 0000000000..47edf5d116 --- /dev/null +++ b/src/site/xdoc/security.xml @@ -0,0 +1,56 @@ + + + + + Apache Commons Security Reports + Apache Commons Team + + +

+

+ For information about reporting or asking questions about security, please see + Apache Commons Security. +

+

This page lists all security vulnerabilities fixed in released versions of this component. +

+

Please note that binary patches are never provided. If you need to apply a source code patch, use the building instructions for the component version + that you are using. +

+

+ If you need help on building this component or other help on following the instructions to mitigate the known vulnerabilities listed here, please send + your questions to the public + user mailing list. +

+

If you have encountered an unlisted security vulnerability or other unexpected behavior that has security impact, or if the descriptions here are + incomplete, please report them privately to the Apache Security Team. Thank you. +

+
+
+

None.

+
+
+

+ For information about safe deserialization, please see Safe Deserialization. +

+
+ +
\ No newline at end of file diff --git a/src/site/xdoc/user-guide.xml b/src/site/xdoc/user-guide.xml index 3a433faca4..d5a1f26850 100644 --- a/src/site/xdoc/user-guide.xml +++ b/src/site/xdoc/user-guide.xml @@ -7,7 +7,7 @@ The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, @@ -21,173 +21,6 @@ limitations under the License. Apache Commons Documentation Team - - -

Apache Commons CSV User Guide

- - - - -
- - Parsing files with Apache Commons CSV is relatively straight forward. - The CSVFormat class provides some commonly used CSV variants: - -
-
DEFAULT
Standard Comma Separated Value format, as for RFC4180 but allowing empty lines.
-
EXCEL
The Microsoft Excel CSV format.
-
INFORMIX_UNLOAD1.3
Informix UNLOAD format used by the UNLOAD TO file_name operation.
-
INFORMIX_UNLOAD_CSV1.3
Informix CSV UNLOAD format used by the UNLOAD TO file_name operation (escaping is disabled.)
-
MONGO_CSV1.7
MongoDB CSV format used by the mongoexport operation.
-
MONGO_TSV1.7
MongoDB TSV format used by the mongoexport operation.
-
MYSQL
The MySQL CSV format.
-
ORACLE1.6
Default Oracle format used by the SQL*Loader utility.
-
POSTGRESSQL_CSV1.5
Default PostgreSQL CSV format used by the COPY operation.
-
POSTGRESSQL_TEXT1.5
Default PostgreSQL text format used by the COPY operation.
-
RFC-4180
The RFC-4180 format defined by RFC-4180.
-
TDF
A tab delimited format.
-
- - -

To parse an Excel CSV file, write:

- Reader in = new FileReader("path/to/file.csv"); -Iterable<CSVRecord> records = CSVFormat.EXCEL.parse(in); -for (CSVRecord record : records) { - String lastName = record.get("Last Name"); - String firstName = record.get("First Name"); -} - -
- -

- To handle files that start with a Byte Order Mark (BOM) like some Excel CSV files, you need an extra step to - deal with these optional bytes. - You can use the - - BOMInputStream - - class from - Apache Commons IO - for example: -

- final URL url = ...; -try (final Reader reader = new InputStreamReader(new BOMInputStream(url.openStream()), "UTF-8"); - final CSVParser parser = CSVFormat.EXCEL.builder() - .setHeader() - .build() - .parse(reader)) { - for (final CSVRecord record : parser) { - final String string = record.get("SomeColumn"); - ... - } -} - -

- You might find it handy to create something like this: -

- /** - * Creates a reader capable of handling BOMs. - */ -public InputStreamReader newReader(final InputStream inputStream) { - return new InputStreamReader(new BOMInputStream(inputStream), StandardCharsets.UTF_8); -} - -
-
- -
- - Apache Commons CSV provides several ways to access record values. - The simplest way is to access values by their index in the record. - However, columns in CSV files often have a name, for example: ID, CustomerNo, Birthday, etc. - The CSVFormat class provides an API for specifying these header names and CSVRecord on - the other hand has methods to access values by their corresponding header name. - - - To access a record value by index, no special configuration of the CSVFormat is necessary: - Reader in = new FileReader("path/to/file.csv"); -Iterable<CSVRecord> records = CSVFormat.RFC4180.parse(in); -for (CSVRecord record : records) { - String columnOne = record.get(0); - String columnTwo = record.get(1); -} - - - - Indices may not be the most intuitive way to access record values. For this reason it is possible to - assign names to each column in the file: - Reader in = new FileReader("path/to/file.csv"); -Iterable<CSVRecord> records = CSVFormat.RFC4180.builder() - .setHeader("ID", "CustomerNo", "Name") - .build() - .parse(in); -for (CSVRecord record : records) { - String id = record.get("ID"); - String customerNo = record.get("CustomerNo"); - String name = record.get("Name"); -} - - Note that column values can still be accessed using their index. - - - Using String values all over the code to reference columns can be error prone. For this reason, - it is possible to define an enum to specify header names. Note that the enum constant names are - used to access column values. This may lead to enums constant names which do not follow the Java - coding standard of defining constants in upper case with underscores: - public enum Headers { - ID, CustomerNo, Name -} -Reader in = new FileReader("path/to/file.csv"); -Iterable<CSVRecord> records = CSVFormat.RFC4180.builder() - .setHeader(Headers.class) - .build() - .parse(in); -for (CSVRecord record : records) { - String id = record.get(Headers.ID); - String customerNo = record.get(Headers.CustomerNo); - String name = record.get(Headers.Name); -} - - Again it is possible to access values by their index and by using a String (for example "CustomerNo"). - - - Some CSV files define header names in their first record. If configured, Apache Commons CSV can parse - the header names from the first record: - Reader in = new FileReader("path/to/file.csv"); -Iterable<CSVRecord> records = CSVFormat.RFC4180.builder() - .setHeader() - .setSkipHeaderRecord(true) - .build() - .parse(in); -for (CSVRecord record : records) { - String id = record.get("ID"); - String customerNo = record.get("CustomerNo"); - String name = record.get("Name"); -} - - This will use the values from the first record as header names and skip the first record when iterating. - - -

- To print a CSV file with headers, you specify the headers in the format: -

- final Appendable out = ...; -final CSVPrinter printer = CSVFormat.DEFAULT.builder() - .setHeader("H1", "H2") - .build() - .print(out); - -

- To print a CSV file with JDBC column labels, you specify the ResultSet in the format: -

- try (final ResultSet resultSet = ...) { - final CSVPrinter printer = CSVFormat.DEFAULT.builder() - .setHeader(resultSet) - .build() - .print(out); -} - -
-
+

The User Guide migrated to the Javadoc.

diff --git a/src/test/java/org/apache/commons/csv/CSVBenchmark.java b/src/test/java/org/apache/commons/csv/CSVBenchmark.java index a3cdd33f97..b1be4ce095 100644 --- a/src/test/java/org/apache/commons/csv/CSVBenchmark.java +++ b/src/test/java/org/apache/commons/csv/CSVBenchmark.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv; @@ -78,9 +80,8 @@ private Reader getReader() { */ @Setup public void init() throws IOException { - InputStream in = this.getClass().getClassLoader().getResourceAsStream( - "org/apache/commons/csv/perf/worldcitiespop.txt.gz"); - try (final InputStream gzin = new GZIPInputStream(in, 8192)) { + try (InputStream in = this.getClass().getClassLoader().getResourceAsStream("org/apache/commons/csv/perf/worldcitiespop.txt.gz"); + InputStream gzin = new GZIPInputStream(in, 8192)) { this.data = IOUtils.toString(gzin, StandardCharsets.ISO_8859_1); } } @@ -89,9 +90,9 @@ public void init() throws IOException { public int parseCommonsCSV(final Blackhole bh) throws Exception { int count = 0; - try (final Reader in = getReader()) { + try (Reader in = getReader()) { final CSVFormat format = CSVFormat.Builder.create().setSkipHeaderRecord(true).build(); - Iterator iter = format.parse(in).iterator(); + final Iterator iter = format.parse(in).iterator(); while (iter.hasNext()) { count++; iter.next(); @@ -106,7 +107,7 @@ public int parseCommonsCSV(final Blackhole bh) throws Exception { public int parseGenJavaCSV(final Blackhole bh) throws Exception { int count = 0; - try (final Reader in = getReader()) { + try (Reader in = getReader()) { final CsvReader reader = new CsvReader(in); reader.setFieldDelimiter(','); while (reader.readLine() != null) { @@ -122,7 +123,7 @@ public int parseGenJavaCSV(final Blackhole bh) throws Exception { public int parseJavaCSV(final Blackhole bh) throws Exception { int count = 0; - try (final Reader in = getReader()) { + try (Reader in = getReader()) { final com.csvreader.CsvReader reader = new com.csvreader.CsvReader(in, ','); reader.setRecordDelimiter('\n'); while (reader.readRecord()) { @@ -141,7 +142,7 @@ public int parseOpenCSV(final Blackhole bh) throws Exception { final com.opencsv.CSVParser parser = new CSVParserBuilder() .withSeparator(',').withIgnoreQuotations(true).build(); - try (final Reader in = getReader()) { + try (Reader in = getReader()) { final com.opencsv.CSVReader reader = new CSVReaderBuilder(in).withSkipLines(1).withCSVParser(parser).build(); while (reader.readNext() != null) { count++; @@ -158,7 +159,7 @@ public int parseSkifeCSV(final Blackhole bh) throws Exception { reader.setSeperator(','); final CountingReaderCallback callback = new CountingReaderCallback(); - try (final Reader in = getReader()) { + try (Reader in = getReader()) { reader.parse(in, callback); } @@ -170,7 +171,7 @@ public int parseSkifeCSV(final Blackhole bh) throws Exception { public int parseSuperCSV(final Blackhole bh) throws Exception { int count = 0; - try (final CsvListReader reader = new CsvListReader(getReader(), CsvPreference.STANDARD_PREFERENCE)) { + try (CsvListReader reader = new CsvListReader(getReader(), CsvPreference.STANDARD_PREFERENCE)) { while (reader.read() != null) { count++; } diff --git a/src/test/java/org/apache/commons/csv/CSVDuplicateHeaderTest.java b/src/test/java/org/apache/commons/csv/CSVDuplicateHeaderTest.java index 7932a8c906..2f518a1206 100644 --- a/src/test/java/org/apache/commons/csv/CSVDuplicateHeaderTest.java +++ b/src/test/java/org/apache/commons/csv/CSVDuplicateHeaderTest.java @@ -1,29 +1,34 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv; +import static org.junit.jupiter.api.Assertions.assertArrayEquals; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertThrows; + import java.io.IOException; import java.util.Arrays; import java.util.List; import java.util.stream.Collectors; import java.util.stream.Stream; -import org.junit.jupiter.api.Assertions; import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.Arguments; import org.junit.jupiter.params.provider.MethodSource; @@ -32,7 +37,7 @@ * Tests parsing of duplicate column names in a CSV header. * The test verifies that headers are consistently handled by CSVFormat and CSVParser. */ -public class CSVDuplicateHeaderTest { +class CSVDuplicateHeaderTest { /** * Return test cases for duplicate header data for use in CSVFormat. @@ -270,7 +275,7 @@ static Stream duplicateHeaderData() { */ @ParameterizedTest @MethodSource(value = {"duplicateHeaderAllowsMissingColumnsNamesData"}) - public void testCSVFormat(final DuplicateHeaderMode duplicateHeaderMode, + void testCSVFormat(final DuplicateHeaderMode duplicateHeaderMode, final boolean allowMissingColumnNames, final boolean ignoreHeaderCase, final String[] headers, @@ -283,11 +288,11 @@ public void testCSVFormat(final DuplicateHeaderMode duplicateHeaderMode, .setHeader(headers); if (valid) { final CSVFormat format = builder.get(); - Assertions.assertEquals(duplicateHeaderMode, format.getDuplicateHeaderMode(), "DuplicateHeaderMode"); - Assertions.assertEquals(allowMissingColumnNames, format.getAllowMissingColumnNames(), "AllowMissingColumnNames"); - Assertions.assertArrayEquals(headers, format.getHeader(), "Header"); + assertEquals(duplicateHeaderMode, format.getDuplicateHeaderMode(), "DuplicateHeaderMode"); + assertEquals(allowMissingColumnNames, format.getAllowMissingColumnNames(), "AllowMissingColumnNames"); + assertArrayEquals(headers, format.getHeader(), "Header"); } else { - Assertions.assertThrows(IllegalArgumentException.class, builder::get); + assertThrows(IllegalArgumentException.class, builder::get); } } @@ -303,7 +308,7 @@ public void testCSVFormat(final DuplicateHeaderMode duplicateHeaderMode, */ @ParameterizedTest @MethodSource(value = {"duplicateHeaderData"}) - public void testCSVParser(final DuplicateHeaderMode duplicateHeaderMode, + void testCSVParser(final DuplicateHeaderMode duplicateHeaderMode, final boolean allowMissingColumnNames, final boolean ignoreHeaderCase, final String[] headers, @@ -325,10 +330,10 @@ public void testCSVParser(final DuplicateHeaderMode duplicateHeaderMode, try (CSVParser parser = CSVParser.parse(input, format)) { // Parser ignores null headers final List expected = Arrays.stream(headers).filter(s -> s != null).collect(Collectors.toList()); - Assertions.assertEquals(expected, parser.getHeaderNames(), "HeaderNames"); + assertEquals(expected, parser.getHeaderNames(), "HeaderNames"); } } else { - Assertions.assertThrows(IllegalArgumentException.class, () -> CSVParser.parse(input, format)); + assertThrows(IllegalArgumentException.class, () -> CSVParser.parse(input, format)); } } } diff --git a/src/test/java/org/apache/commons/csv/CSVFileParserTest.java b/src/test/java/org/apache/commons/csv/CSVFileParserTest.java index 728686eb84..e74d0e6884 100644 --- a/src/test/java/org/apache/commons/csv/CSVFileParserTest.java +++ b/src/test/java/org/apache/commons/csv/CSVFileParserTest.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv; @@ -38,7 +40,7 @@ /** * Parse tests using test files */ -public class CSVFileParserTest { +class CSVFileParserTest { private static final File BASE_DIR = new File("src/test/resources/org/apache/commons/csv/CSVFileParser"); @@ -57,7 +59,7 @@ private String readTestData(final BufferedReader reader) throws IOException { @ParameterizedTest @MethodSource("generateData") - public void testCSVFile(final File testFile) throws Exception { + void testCSVFile(final File testFile) throws Exception { try (FileReader fr = new FileReader(testFile); BufferedReader testDataReader = new BufferedReader(fr)) { String line = readTestData(testDataReader); assertNotNull("file must contain config line", line); @@ -68,14 +70,14 @@ public void testCSVFile(final File testFile) throws Exception { boolean checkComments = false; for (int i = 1; i < split.length; i++) { final String option = split[i]; - final String[] option_parts = option.split("=", 2); - if ("IgnoreEmpty".equalsIgnoreCase(option_parts[0])) { - format = format.withIgnoreEmptyLines(Boolean.parseBoolean(option_parts[1])); - } else if ("IgnoreSpaces".equalsIgnoreCase(option_parts[0])) { - format = format.withIgnoreSurroundingSpaces(Boolean.parseBoolean(option_parts[1])); - } else if ("CommentStart".equalsIgnoreCase(option_parts[0])) { - format = format.withCommentMarker(option_parts[1].charAt(0)); - } else if ("CheckComments".equalsIgnoreCase(option_parts[0])) { + final String[] optionParts = option.split("=", 2); + if ("IgnoreEmpty".equalsIgnoreCase(optionParts[0])) { + format = format.withIgnoreEmptyLines(Boolean.parseBoolean(optionParts[1])); + } else if ("IgnoreSpaces".equalsIgnoreCase(optionParts[0])) { + format = format.withIgnoreSurroundingSpaces(Boolean.parseBoolean(optionParts[1])); + } else if ("CommentStart".equalsIgnoreCase(optionParts[0])) { + format = format.withCommentMarker(optionParts[1].charAt(0)); + } else if ("CheckComments".equalsIgnoreCase(optionParts[0])) { checkComments = true; } else { fail(testFile.getName() + " unexpected option: " + option); @@ -86,7 +88,7 @@ public void testCSVFile(final File testFile) throws Exception { // Now parse the file and compare against the expected results // We use a buffered reader internally so no need to create one here. - try (final CSVParser parser = CSVParser.parse(new File(BASE_DIR, split[0]), Charset.defaultCharset(), format)) { + try (CSVParser parser = CSVParser.parse(new File(BASE_DIR, split[0]), Charset.defaultCharset(), format)) { for (final CSVRecord record : parser) { String parsed = Arrays.toString(record.values()); final String comment = record.getComment(); @@ -102,7 +104,7 @@ public void testCSVFile(final File testFile) throws Exception { @ParameterizedTest @MethodSource("generateData") - public void testCSVUrl(final File testFile) throws Exception { + void testCSVUrl(final File testFile) throws Exception { try (FileReader fr = new FileReader(testFile); BufferedReader testData = new BufferedReader(fr)) { String line = readTestData(testData); assertNotNull("file must contain config line", line); @@ -113,14 +115,14 @@ public void testCSVUrl(final File testFile) throws Exception { boolean checkComments = false; for (int i = 1; i < split.length; i++) { final String option = split[i]; - final String[] option_parts = option.split("=", 2); - if ("IgnoreEmpty".equalsIgnoreCase(option_parts[0])) { - format = format.withIgnoreEmptyLines(Boolean.parseBoolean(option_parts[1])); - } else if ("IgnoreSpaces".equalsIgnoreCase(option_parts[0])) { - format = format.withIgnoreSurroundingSpaces(Boolean.parseBoolean(option_parts[1])); - } else if ("CommentStart".equalsIgnoreCase(option_parts[0])) { - format = format.withCommentMarker(option_parts[1].charAt(0)); - } else if ("CheckComments".equalsIgnoreCase(option_parts[0])) { + final String[] optionParts = option.split("=", 2); + if ("IgnoreEmpty".equalsIgnoreCase(optionParts[0])) { + format = format.withIgnoreEmptyLines(Boolean.parseBoolean(optionParts[1])); + } else if ("IgnoreSpaces".equalsIgnoreCase(optionParts[0])) { + format = format.withIgnoreSurroundingSpaces(Boolean.parseBoolean(optionParts[1])); + } else if ("CommentStart".equalsIgnoreCase(optionParts[0])) { + format = format.withCommentMarker(optionParts[1].charAt(0)); + } else if ("CheckComments".equalsIgnoreCase(optionParts[0])) { checkComments = true; } else { fail(testFile.getName() + " unexpected option: " + option); @@ -131,7 +133,7 @@ public void testCSVUrl(final File testFile) throws Exception { // Now parse the file and compare against the expected results final URL resource = ClassLoader.getSystemResource("org/apache/commons/csv/CSVFileParser/" + split[0]); - try (final CSVParser parser = CSVParser.parse(resource, StandardCharsets.UTF_8, format)) { + try (CSVParser parser = CSVParser.parse(resource, StandardCharsets.UTF_8, format)) { for (final CSVRecord record : parser) { String parsed = Arrays.toString(record.values()); final String comment = record.getComment(); diff --git a/src/test/java/org/apache/commons/csv/CSVFormatPredefinedTest.java b/src/test/java/org/apache/commons/csv/CSVFormatPredefinedTest.java index d62f41f3cb..dad08cdb1d 100644 --- a/src/test/java/org/apache/commons/csv/CSVFormatPredefinedTest.java +++ b/src/test/java/org/apache/commons/csv/CSVFormatPredefinedTest.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv; @@ -24,7 +26,7 @@ /** * Tests {@link CSVFormat.Predefined}. */ -public class CSVFormatPredefinedTest { +class CSVFormatPredefinedTest { private void test(final CSVFormat format, final String enumName) { assertEquals(format, CSVFormat.Predefined.valueOf(enumName).getFormat()); @@ -32,52 +34,52 @@ private void test(final CSVFormat format, final String enumName) { } @Test - public void testDefault() { + void testDefault() { test(CSVFormat.DEFAULT, "Default"); } @Test - public void testExcel() { + void testExcel() { test(CSVFormat.EXCEL, "Excel"); } @Test - public void testMongoDbCsv() { + void testMongoDbCsv() { test(CSVFormat.MONGODB_CSV, "MongoDBCsv"); } @Test - public void testMongoDbTsv() { + void testMongoDbTsv() { test(CSVFormat.MONGODB_TSV, "MongoDBTsv"); } @Test - public void testMySQL() { + void testMySQL() { test(CSVFormat.MYSQL, "MySQL"); } @Test - public void testOracle() { + void testOracle() { test(CSVFormat.ORACLE, "Oracle"); } @Test - public void testPostgreSqlCsv() { + void testPostgreSqlCsv() { test(CSVFormat.POSTGRESQL_CSV, "PostgreSQLCsv"); } @Test - public void testPostgreSqlText() { + void testPostgreSqlText() { test(CSVFormat.POSTGRESQL_TEXT, "PostgreSQLText"); } @Test - public void testRFC4180() { + void testRFC4180() { test(CSVFormat.RFC4180, "RFC4180"); } @Test - public void testTDF() { + void testTDF() { test(CSVFormat.TDF, "TDF"); } } diff --git a/src/test/java/org/apache/commons/csv/CSVFormatTest.java b/src/test/java/org/apache/commons/csv/CSVFormatTest.java index 7ce0aad721..ed20898de9 100644 --- a/src/test/java/org/apache/commons/csv/CSVFormatTest.java +++ b/src/test/java/org/apache/commons/csv/CSVFormatTest.java @@ -1,1531 +1,1607 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.apache.commons.csv; - -import static org.apache.commons.csv.CSVFormat.RFC4180; -import static org.apache.commons.csv.Constants.CR; -import static org.apache.commons.csv.Constants.CRLF; -import static org.apache.commons.csv.Constants.LF; -import static org.junit.jupiter.api.Assertions.assertArrayEquals; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertFalse; -import static org.junit.jupiter.api.Assertions.assertNotNull; -import static org.junit.jupiter.api.Assertions.assertNotSame; -import static org.junit.jupiter.api.Assertions.assertNull; -import static org.junit.jupiter.api.Assertions.assertThrows; -import static org.junit.jupiter.api.Assertions.assertTrue; -import static org.junit.jupiter.api.Assertions.fail; - -import java.io.ByteArrayInputStream; -import java.io.ByteArrayOutputStream; -import java.io.IOException; -import java.io.ObjectInputStream; -import java.io.ObjectOutputStream; -import java.io.Reader; -import java.io.StringReader; -import java.lang.reflect.Method; -import java.lang.reflect.Modifier; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.util.Arrays; -import java.util.Objects; - -import org.apache.commons.csv.CSVFormat.Builder; -import org.junit.jupiter.api.Assertions; -import org.junit.jupiter.api.Test; - -/** - * Tests {@link CSVFormat}. - */ -public class CSVFormatTest { - - public enum EmptyEnum { - // empty enum. - } - - public enum Header { - Name, Email, Phone - } - - private static void assertNotEquals(final Object right, final Object left) { - Assertions.assertNotEquals(right, left); - Assertions.assertNotEquals(left, right); - } - - private static CSVFormat copy(final CSVFormat format) { - return format.builder().setDelimiter(format.getDelimiter()).get(); - } - - private void assertNotEquals(final String name, final String type, final Object left, final Object right) { - if (left.equals(right) || right.equals(left)) { - fail("Objects must not compare equal for " + name + "(" + type + ")"); - } - if (left.hashCode() == right.hashCode()) { - fail("Hash code should not be equal for " + name + "(" + type + ")"); - } - } - - @Test - public void testBuildVsGet() { - final Builder builder = CSVFormat.DEFAULT.builder(); - assertNotSame(builder.get(), builder.build()); - } - - @Test - public void testDelimiterEmptyStringThrowsException1() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setDelimiter("").get()); - } - - @SuppressWarnings("deprecation") - @Test - public void testDelimiterSameAsCommentStartThrowsException_Deprecated() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withDelimiter('!').withCommentMarker('!')); - } - - @Test - public void testDelimiterSameAsCommentStartThrowsException1() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setDelimiter('!').setCommentMarker('!').get()); - } - - @SuppressWarnings("deprecation") - @Test - public void testDelimiterSameAsEscapeThrowsException_Deprecated() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withDelimiter('!').withEscape('!')); - } - - @Test - public void testDelimiterSameAsEscapeThrowsException1() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setDelimiter('!').setEscape('!').get()); - } - - @Test - public void testDelimiterSameAsRecordSeparatorThrowsException() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.newFormat(CR)); - } - - @Test - public void testDuplicateHeaderElements() { - final String[] header = { "A", "A" }; - final CSVFormat format = CSVFormat.DEFAULT.builder().setHeader(header).get(); - assertEquals(2, format.getHeader().length); - assertArrayEquals(header, format.getHeader()); - } - - @SuppressWarnings("deprecation") - @Test - public void testDuplicateHeaderElements_Deprecated() { - final String[] header = { "A", "A" }; - final CSVFormat format = CSVFormat.DEFAULT.withHeader(header); - assertEquals(2, format.getHeader().length); - assertArrayEquals(header, format.getHeader()); - } - - @Test - public void testDuplicateHeaderElementsFalse() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setAllowDuplicateHeaderNames(false).setHeader("A", "A").get()); - } - - @SuppressWarnings("deprecation") - @Test - public void testDuplicateHeaderElementsFalse_Deprecated() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withAllowDuplicateHeaderNames(false).withHeader("A", "A")); - } - - @Test - public void testDuplicateHeaderElementsTrue() { - CSVFormat.DEFAULT.builder().setAllowDuplicateHeaderNames(true).setHeader("A", "A").get(); - } - - @SuppressWarnings("deprecation") - @Test - public void testDuplicateHeaderElementsTrue_Deprecated() { - CSVFormat.DEFAULT.withAllowDuplicateHeaderNames(true).withHeader("A", "A"); - } - - @Test - public void testDuplicateHeaderElementsTrueContainsEmpty1() { - CSVFormat.DEFAULT.builder().setAllowDuplicateHeaderNames(false).setHeader("A", "", "B", "").get(); - } - - @Test - public void testDuplicateHeaderElementsTrueContainsEmpty2() { - CSVFormat.DEFAULT.builder().setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_EMPTY).setHeader("A", "", "B", "").get(); - } - - @Test - public void testDuplicateHeaderElementsTrueContainsEmpty3() { - CSVFormat.DEFAULT.builder().setAllowDuplicateHeaderNames(false).setAllowMissingColumnNames(true).setHeader("A", "", "B", "").get(); - } - - @Test - public void testEquals() { - final CSVFormat right = CSVFormat.DEFAULT; - final CSVFormat left = copy(right); - Assertions.assertNotEquals(null, right); - Assertions.assertNotEquals("A String Instance", right); - assertEquals(right, right); - assertEquals(right, left); - assertEquals(left, right); - assertEquals(right.hashCode(), right.hashCode()); - assertEquals(right.hashCode(), left.hashCode()); - } - - @Test - public void testEqualsCommentStart() { - final CSVFormat right = CSVFormat.newFormat('\'').builder().setQuote('"').setCommentMarker('#').setQuoteMode(QuoteMode.ALL).get(); - final CSVFormat left = right.builder().setCommentMarker('!').get(); - - assertNotEquals(right, left); - } - - @SuppressWarnings("deprecation") - @Test - public void testEqualsCommentStart_Deprecated() { - final CSVFormat right = CSVFormat.newFormat('\'').withQuote('"').withCommentMarker('#').withQuoteMode(QuoteMode.ALL); - final CSVFormat left = right.withCommentMarker('!'); - - assertNotEquals(right, left); - } - - @Test - public void testEqualsDelimiter() { - final CSVFormat right = CSVFormat.newFormat('!'); - final CSVFormat left = CSVFormat.newFormat('?'); - - assertNotEquals(right, left); - } - - @Test - public void testEqualsEscape() { - final CSVFormat right = CSVFormat.newFormat('\'').builder().setQuote('"').setCommentMarker('#').setEscape('+').setQuoteMode(QuoteMode.ALL).get(); - final CSVFormat left = right.builder().setEscape('!').get(); - - assertNotEquals(right, left); - } - - @SuppressWarnings("deprecation") - @Test - public void testEqualsEscape_Deprecated() { - final CSVFormat right = CSVFormat.newFormat('\'').withQuote('"').withCommentMarker('#').withEscape('+').withQuoteMode(QuoteMode.ALL); - final CSVFormat left = right.withEscape('!'); - - assertNotEquals(right, left); - } - - @Test - public void testEqualsHash() throws Exception { - final Method[] methods = CSVFormat.class.getDeclaredMethods(); - for (final Method method : methods) { - if (Modifier.isPublic(method.getModifiers())) { - final String name = method.getName(); - if (name.startsWith("with")) { - for (final Class cls : method.getParameterTypes()) { - final String type = cls.getCanonicalName(); - switch (type) { - case "boolean": { - final Object defTrue = method.invoke(CSVFormat.DEFAULT, Boolean.TRUE); - final Object defFalse = method.invoke(CSVFormat.DEFAULT, Boolean.FALSE); - assertNotEquals(name, type, defTrue, defFalse); - break; - } - case "char": { - final Object a = method.invoke(CSVFormat.DEFAULT, 'a'); - final Object b = method.invoke(CSVFormat.DEFAULT, 'b'); - assertNotEquals(name, type, a, b); - break; - } - case "java.lang.Character": { - final Object a = method.invoke(CSVFormat.DEFAULT, new Object[] { null }); - final Object b = method.invoke(CSVFormat.DEFAULT, Character.valueOf('d')); - assertNotEquals(name, type, a, b); - break; - } - case "java.lang.String": { - final Object a = method.invoke(CSVFormat.DEFAULT, new Object[] { null }); - final Object b = method.invoke(CSVFormat.DEFAULT, "e"); - assertNotEquals(name, type, a, b); - break; - } - case "java.lang.String[]": { - final Object a = method.invoke(CSVFormat.DEFAULT, new Object[] { new String[] { null, null } }); - final Object b = method.invoke(CSVFormat.DEFAULT, new Object[] { new String[] { "f", "g" } }); - assertNotEquals(name, type, a, b); - break; - } - case "org.apache.commons.csv.QuoteMode": { - final Object a = method.invoke(CSVFormat.DEFAULT, QuoteMode.MINIMAL); - final Object b = method.invoke(CSVFormat.DEFAULT, QuoteMode.ALL); - assertNotEquals(name, type, a, b); - break; - } - case "org.apache.commons.csv.DuplicateHeaderMode": { - final Object a = method.invoke(CSVFormat.DEFAULT, DuplicateHeaderMode.ALLOW_ALL); - final Object b = method.invoke(CSVFormat.DEFAULT, DuplicateHeaderMode.DISALLOW); - assertNotEquals(name, type, a, b); - break; - } - case "java.lang.Object[]": { - final Object a = method.invoke(CSVFormat.DEFAULT, new Object[] { new Object[] { null, null } }); - final Object b = method.invoke(CSVFormat.DEFAULT, new Object[] { new Object[] { new Object(), new Object() } }); - assertNotEquals(name, type, a, b); - break; - } - default: - if ("withHeader".equals(name)) { // covered above by String[] - // ignored - } else { - fail("Unhandled method: " + name + "(" + type + ")"); - } - break; - } - } - } - } - } - } - - @Test - public void testEqualsHeader() { - final CSVFormat right = CSVFormat.newFormat('\'').builder().setRecordSeparator(CR).setCommentMarker('#').setEscape('+').setHeader("One", "Two", "Three") - .setIgnoreEmptyLines(true).setIgnoreSurroundingSpaces(true).setQuote('"').setQuoteMode(QuoteMode.ALL).get(); - final CSVFormat left = right.builder().setHeader("Three", "Two", "One").get(); - - assertNotEquals(right, left); - } - - @SuppressWarnings("deprecation") - @Test - public void testEqualsHeader_Deprecated() { - final CSVFormat right = CSVFormat.newFormat('\'').withRecordSeparator(CR).withCommentMarker('#').withEscape('+').withHeader("One", "Two", "Three") - .withIgnoreEmptyLines().withIgnoreSurroundingSpaces().withQuote('"').withQuoteMode(QuoteMode.ALL); - final CSVFormat left = right.withHeader("Three", "Two", "One"); - - assertNotEquals(right, left); - } - - @Test - public void testEqualsIgnoreEmptyLines() { - final CSVFormat right = CSVFormat.newFormat('\'').builder().setCommentMarker('#').setEscape('+').setIgnoreEmptyLines(true) - .setIgnoreSurroundingSpaces(true).setQuote('"').setQuoteMode(QuoteMode.ALL).get(); - final CSVFormat left = right.builder().setIgnoreEmptyLines(false).get(); - - assertNotEquals(right, left); - } - - @SuppressWarnings("deprecation") - @Test - public void testEqualsIgnoreEmptyLines_Deprecated() { - final CSVFormat right = CSVFormat.newFormat('\'').withCommentMarker('#').withEscape('+').withIgnoreEmptyLines().withIgnoreSurroundingSpaces() - .withQuote('"').withQuoteMode(QuoteMode.ALL); - final CSVFormat left = right.withIgnoreEmptyLines(false); - - assertNotEquals(right, left); - } - - @Test - public void testEqualsIgnoreSurroundingSpaces() { - final CSVFormat right = CSVFormat.newFormat('\'').builder().setCommentMarker('#').setEscape('+').setIgnoreSurroundingSpaces(true).setQuote('"') - .setQuoteMode(QuoteMode.ALL).get(); - final CSVFormat left = right.builder().setIgnoreSurroundingSpaces(false).get(); - - assertNotEquals(right, left); - } - - @SuppressWarnings("deprecation") - @Test - public void testEqualsIgnoreSurroundingSpaces_Deprecated() { - final CSVFormat right = CSVFormat.newFormat('\'').withCommentMarker('#').withEscape('+').withIgnoreSurroundingSpaces().withQuote('"') - .withQuoteMode(QuoteMode.ALL); - final CSVFormat left = right.withIgnoreSurroundingSpaces(false); - - assertNotEquals(right, left); - } - - @Test - public void testEqualsLeftNoQuoteRightQuote() { - final CSVFormat left = CSVFormat.newFormat(',').builder().setQuote(null).get(); - final CSVFormat right = left.builder().setQuote('#').get(); - - assertNotEquals(left, right); - } - - @SuppressWarnings("deprecation") - @Test - public void testEqualsLeftNoQuoteRightQuote_Deprecated() { - final CSVFormat left = CSVFormat.newFormat(',').withQuote(null); - final CSVFormat right = left.withQuote('#'); - - assertNotEquals(left, right); - } - - @Test - public void testEqualsNoQuotes() { - final CSVFormat left = CSVFormat.newFormat(',').builder().setQuote(null).get(); - final CSVFormat right = left.builder().setQuote(null).get(); - - assertEquals(left, right); - } - - @SuppressWarnings("deprecation") - @Test - public void testEqualsNoQuotes_Deprecated() { - final CSVFormat left = CSVFormat.newFormat(',').withQuote(null); - final CSVFormat right = left.withQuote(null); - - assertEquals(left, right); - } - - @Test - public void testEqualsNullString() { - final CSVFormat right = CSVFormat.newFormat('\'').builder().setRecordSeparator(CR).setCommentMarker('#').setEscape('+').setIgnoreEmptyLines(true) - .setIgnoreSurroundingSpaces(true).setQuote('"').setQuoteMode(QuoteMode.ALL).setNullString("null").get(); - final CSVFormat left = right.builder().setNullString("---").get(); - - assertNotEquals(right, left); - } - - @SuppressWarnings("deprecation") - @Test - public void testEqualsNullString_Deprecated() { - final CSVFormat right = CSVFormat.newFormat('\'').withRecordSeparator(CR).withCommentMarker('#').withEscape('+').withIgnoreEmptyLines() - .withIgnoreSurroundingSpaces().withQuote('"').withQuoteMode(QuoteMode.ALL).withNullString("null"); - final CSVFormat left = right.withNullString("---"); - - assertNotEquals(right, left); - } - - @Test - public void testEqualsOne() { - - final CSVFormat csvFormatOne = CSVFormat.INFORMIX_UNLOAD; - final CSVFormat csvFormatTwo = CSVFormat.MYSQL; - - assertEquals('\\', (char) csvFormatOne.getEscapeCharacter()); - assertEquals('\\', csvFormatOne.getEscapeChar()); - assertNull(csvFormatOne.getQuoteMode()); - - assertTrue(csvFormatOne.getIgnoreEmptyLines()); - assertFalse(csvFormatOne.getSkipHeaderRecord()); - - assertFalse(csvFormatOne.getIgnoreHeaderCase()); - assertNull(csvFormatOne.getCommentMarker()); - - assertFalse(csvFormatOne.isCommentMarkerSet()); - assertTrue(csvFormatOne.isQuoteCharacterSet()); - - assertEquals('|', csvFormatOne.getDelimiter()); - assertFalse(csvFormatOne.getAllowMissingColumnNames()); - - assertTrue(csvFormatOne.isEscapeCharacterSet()); - assertEquals("\n", csvFormatOne.getRecordSeparator()); - - assertEquals('\"', (char) csvFormatOne.getQuoteCharacter()); - assertFalse(csvFormatOne.getTrailingDelimiter()); - - assertFalse(csvFormatOne.getTrim()); - assertFalse(csvFormatOne.isNullStringSet()); - - assertNull(csvFormatOne.getNullString()); - assertFalse(csvFormatOne.getIgnoreSurroundingSpaces()); - - assertTrue(csvFormatTwo.isEscapeCharacterSet()); - assertNull(csvFormatTwo.getQuoteCharacter()); - - assertFalse(csvFormatTwo.getAllowMissingColumnNames()); - assertEquals(QuoteMode.ALL_NON_NULL, csvFormatTwo.getQuoteMode()); - - assertEquals('\t', csvFormatTwo.getDelimiter()); - assertArrayEquals(new char[] { '\t' }, csvFormatTwo.getDelimiterCharArray()); - assertEquals("\t", csvFormatTwo.getDelimiterString()); - assertEquals("\n", csvFormatTwo.getRecordSeparator()); - - assertFalse(csvFormatTwo.isQuoteCharacterSet()); - assertTrue(csvFormatTwo.isNullStringSet()); - - assertEquals('\\', (char) csvFormatTwo.getEscapeCharacter()); - assertFalse(csvFormatTwo.getIgnoreHeaderCase()); - - assertFalse(csvFormatTwo.getTrim()); - assertFalse(csvFormatTwo.getIgnoreEmptyLines()); - - assertEquals("\\N", csvFormatTwo.getNullString()); - assertFalse(csvFormatTwo.getIgnoreSurroundingSpaces()); - - assertFalse(csvFormatTwo.getTrailingDelimiter()); - assertFalse(csvFormatTwo.getSkipHeaderRecord()); - - assertNull(csvFormatTwo.getCommentMarker()); - assertFalse(csvFormatTwo.isCommentMarkerSet()); - - assertNotSame(csvFormatTwo, csvFormatOne); - Assertions.assertNotEquals(csvFormatTwo, csvFormatOne); - - assertEquals('\\', (char) csvFormatOne.getEscapeCharacter()); - assertNull(csvFormatOne.getQuoteMode()); - - assertTrue(csvFormatOne.getIgnoreEmptyLines()); - assertFalse(csvFormatOne.getSkipHeaderRecord()); - - assertFalse(csvFormatOne.getIgnoreHeaderCase()); - assertNull(csvFormatOne.getCommentMarker()); - - assertFalse(csvFormatOne.isCommentMarkerSet()); - assertTrue(csvFormatOne.isQuoteCharacterSet()); - - assertEquals('|', csvFormatOne.getDelimiter()); - assertFalse(csvFormatOne.getAllowMissingColumnNames()); - - assertTrue(csvFormatOne.isEscapeCharacterSet()); - assertEquals("\n", csvFormatOne.getRecordSeparator()); - - assertEquals('\"', (char) csvFormatOne.getQuoteCharacter()); - assertFalse(csvFormatOne.getTrailingDelimiter()); - - assertFalse(csvFormatOne.getTrim()); - assertFalse(csvFormatOne.isNullStringSet()); - - assertNull(csvFormatOne.getNullString()); - assertFalse(csvFormatOne.getIgnoreSurroundingSpaces()); - - assertTrue(csvFormatTwo.isEscapeCharacterSet()); - assertNull(csvFormatTwo.getQuoteCharacter()); - - assertFalse(csvFormatTwo.getAllowMissingColumnNames()); - assertEquals(QuoteMode.ALL_NON_NULL, csvFormatTwo.getQuoteMode()); - - assertEquals('\t', csvFormatTwo.getDelimiter()); - assertEquals("\n", csvFormatTwo.getRecordSeparator()); - - assertFalse(csvFormatTwo.isQuoteCharacterSet()); - assertTrue(csvFormatTwo.isNullStringSet()); - - assertEquals('\\', (char) csvFormatTwo.getEscapeCharacter()); - assertFalse(csvFormatTwo.getIgnoreHeaderCase()); - - assertFalse(csvFormatTwo.getTrim()); - assertFalse(csvFormatTwo.getIgnoreEmptyLines()); - - assertEquals("\\N", csvFormatTwo.getNullString()); - assertFalse(csvFormatTwo.getIgnoreSurroundingSpaces()); - - assertFalse(csvFormatTwo.getTrailingDelimiter()); - assertFalse(csvFormatTwo.getSkipHeaderRecord()); - - assertNull(csvFormatTwo.getCommentMarker()); - assertFalse(csvFormatTwo.isCommentMarkerSet()); - - assertNotSame(csvFormatOne, csvFormatTwo); - assertNotSame(csvFormatTwo, csvFormatOne); - - Assertions.assertNotEquals(csvFormatOne, csvFormatTwo); - Assertions.assertNotEquals(csvFormatTwo, csvFormatOne); - - Assertions.assertNotEquals(csvFormatTwo, csvFormatOne); - - } - - @Test - public void testEqualsQuoteChar() { - final CSVFormat right = CSVFormat.newFormat('\'').builder().setQuote('"').get(); - final CSVFormat left = right.builder().setQuote('!').get(); - - assertNotEquals(right, left); - } - - @SuppressWarnings("deprecation") - @Test - public void testEqualsQuoteChar_Deprecated() { - final CSVFormat right = CSVFormat.newFormat('\'').withQuote('"'); - final CSVFormat left = right.withQuote('!'); - - assertNotEquals(right, left); - } - - @Test - public void testEqualsQuotePolicy() { - final CSVFormat right = CSVFormat.newFormat('\'').builder().setQuote('"').setQuoteMode(QuoteMode.ALL).get(); - final CSVFormat left = right.builder().setQuoteMode(QuoteMode.MINIMAL).get(); - - assertNotEquals(right, left); - } - - @SuppressWarnings("deprecation") - @Test - public void testEqualsQuotePolicy_Deprecated() { - final CSVFormat right = CSVFormat.newFormat('\'').withQuote('"').withQuoteMode(QuoteMode.ALL); - final CSVFormat left = right.withQuoteMode(QuoteMode.MINIMAL); - - assertNotEquals(right, left); - } - - @Test - public void testEqualsRecordSeparator() { - final CSVFormat right = CSVFormat.newFormat('\'').builder().setRecordSeparator(CR).setCommentMarker('#').setEscape('+').setIgnoreEmptyLines(true) - .setIgnoreSurroundingSpaces(true).setQuote('"').setQuoteMode(QuoteMode.ALL).get(); - final CSVFormat left = right.builder().setRecordSeparator(LF).get(); - - assertNotEquals(right, left); - } - - @SuppressWarnings("deprecation") - @Test - public void testEqualsRecordSeparator_Deprecated() { - final CSVFormat right = CSVFormat.newFormat('\'').withRecordSeparator(CR).withCommentMarker('#').withEscape('+').withIgnoreEmptyLines() - .withIgnoreSurroundingSpaces().withQuote('"').withQuoteMode(QuoteMode.ALL); - final CSVFormat left = right.withRecordSeparator(LF); - - assertNotEquals(right, left); - } - - public void testEqualsSkipHeaderRecord() { - final CSVFormat right = CSVFormat.newFormat('\'').builder().setRecordSeparator(CR).setCommentMarker('#').setEscape('+').setIgnoreEmptyLines(true) - .setIgnoreSurroundingSpaces(true).setQuote('"').setQuoteMode(QuoteMode.ALL).setNullString("null").setSkipHeaderRecord(true).get(); - final CSVFormat left = right.builder().setSkipHeaderRecord(false).get(); - - assertNotEquals(right, left); - } - - @SuppressWarnings("deprecation") - @Test - public void testEqualsSkipHeaderRecord_Deprecated() { - final CSVFormat right = CSVFormat.newFormat('\'').withRecordSeparator(CR).withCommentMarker('#').withEscape('+').withIgnoreEmptyLines() - .withIgnoreSurroundingSpaces().withQuote('"').withQuoteMode(QuoteMode.ALL).withNullString("null").withSkipHeaderRecord(); - final CSVFormat left = right.withSkipHeaderRecord(false); - - assertNotEquals(right, left); - } - - @Test - public void testEqualsWithNull() { - - final CSVFormat csvFormat = CSVFormat.POSTGRESQL_TEXT; - - assertEquals('\\', (char) csvFormat.getEscapeCharacter()); - assertFalse(csvFormat.getIgnoreSurroundingSpaces()); - - assertFalse(csvFormat.getTrailingDelimiter()); - assertFalse(csvFormat.getTrim()); - - assertFalse(csvFormat.isQuoteCharacterSet()); - assertEquals("\\N", csvFormat.getNullString()); - - assertFalse(csvFormat.getIgnoreHeaderCase()); - assertTrue(csvFormat.isEscapeCharacterSet()); - - assertFalse(csvFormat.isCommentMarkerSet()); - assertNull(csvFormat.getCommentMarker()); - - assertFalse(csvFormat.getAllowMissingColumnNames()); - assertEquals(QuoteMode.ALL_NON_NULL, csvFormat.getQuoteMode()); - - assertEquals('\t', csvFormat.getDelimiter()); - assertFalse(csvFormat.getSkipHeaderRecord()); - - assertEquals("\n", csvFormat.getRecordSeparator()); - assertFalse(csvFormat.getIgnoreEmptyLines()); - - assertNull(csvFormat.getQuoteCharacter()); - assertTrue(csvFormat.isNullStringSet()); - - assertEquals('\\', (char) csvFormat.getEscapeCharacter()); - assertFalse(csvFormat.getIgnoreSurroundingSpaces()); - - assertFalse(csvFormat.getTrailingDelimiter()); - assertFalse(csvFormat.getTrim()); - - assertFalse(csvFormat.isQuoteCharacterSet()); - assertEquals("\\N", csvFormat.getNullString()); - - assertFalse(csvFormat.getIgnoreHeaderCase()); - assertTrue(csvFormat.isEscapeCharacterSet()); - - assertFalse(csvFormat.isCommentMarkerSet()); - assertNull(csvFormat.getCommentMarker()); - - assertFalse(csvFormat.getAllowMissingColumnNames()); - assertEquals(QuoteMode.ALL_NON_NULL, csvFormat.getQuoteMode()); - - assertEquals('\t', csvFormat.getDelimiter()); - assertFalse(csvFormat.getSkipHeaderRecord()); - - assertEquals("\n", csvFormat.getRecordSeparator()); - assertFalse(csvFormat.getIgnoreEmptyLines()); - - assertNull(csvFormat.getQuoteCharacter()); - assertTrue(csvFormat.isNullStringSet()); - - Assertions.assertNotEquals(null, csvFormat); - - } - - @Test - public void testEscapeSameAsCommentStartThrowsException() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setEscape('!').setCommentMarker('!').get()); - } - - @SuppressWarnings("deprecation") - @Test - public void testEscapeSameAsCommentStartThrowsException_Deprecated() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withEscape('!').withCommentMarker('!')); - } - - @Test - public void testEscapeSameAsCommentStartThrowsExceptionForWrapperType() { - // Cannot assume that callers won't use different Character objects - assertThrows(IllegalArgumentException.class, - () -> CSVFormat.DEFAULT.builder().setEscape(Character.valueOf('!')).setCommentMarker(Character.valueOf('!')).get()); - } - - @SuppressWarnings("deprecation") - @Test - public void testEscapeSameAsCommentStartThrowsExceptionForWrapperType_Deprecated() { - // Cannot assume that callers won't use different Character objects - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withEscape(Character.valueOf('!')).withCommentMarker(Character.valueOf('!'))); - } - - @Test - public void testFormat() { - final CSVFormat format = CSVFormat.DEFAULT; - - assertEquals("", format.format()); - assertEquals("a,b,c", format.format("a", "b", "c")); - assertEquals("\"x,y\",z", format.format("x,y", "z")); - } - - @Test // I assume this to be a defect. - public void testFormatThrowsNullPointerException() { - - final CSVFormat csvFormat = CSVFormat.MYSQL; - - final NullPointerException e = assertThrows(NullPointerException.class, () -> csvFormat.format((Object[]) null)); - assertEquals(Objects.class.getName(), e.getStackTrace()[0].getClassName()); - } - - @Test - public void testFormatToString() { - // @formatter:off - final CSVFormat format = CSVFormat.RFC4180 - .withEscape('?') - .withDelimiter(',') - .withQuoteMode(QuoteMode.MINIMAL) - .withRecordSeparator(CRLF) - .withQuote('"') - .withNullString("") - .withIgnoreHeaderCase(true) - .withHeaderComments("This is HeaderComments") - .withHeader("col1", "col2", "col3"); - // @formatter:on - assertEquals( - "Delimiter=<,> Escape= QuoteChar=<\"> QuoteMode= NullString=<> RecordSeparator=<" + CRLF + - "> IgnoreHeaderCase:ignored SkipHeaderRecord:false HeaderComments:[This is HeaderComments] Header:[col1, col2, col3]", - format.toString()); - } - - @Test - public void testGetAllowDuplicateHeaderNames() { - final Builder builder = CSVFormat.DEFAULT.builder(); - assertTrue(builder.get().getAllowDuplicateHeaderNames()); - assertTrue(builder.setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_ALL).get().getAllowDuplicateHeaderNames()); - assertFalse(builder.setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_EMPTY).get().getAllowDuplicateHeaderNames()); - assertFalse(builder.setDuplicateHeaderMode(DuplicateHeaderMode.DISALLOW).get().getAllowDuplicateHeaderNames()); - } - - @Test - public void testGetDuplicateHeaderMode() { - final Builder builder = CSVFormat.DEFAULT.builder(); - - assertEquals(DuplicateHeaderMode.ALLOW_ALL, builder.get().getDuplicateHeaderMode()); - assertEquals(DuplicateHeaderMode.ALLOW_ALL, builder.setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_ALL).get().getDuplicateHeaderMode()); - assertEquals(DuplicateHeaderMode.ALLOW_EMPTY, builder.setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_EMPTY).get().getDuplicateHeaderMode()); - assertEquals(DuplicateHeaderMode.DISALLOW, builder.setDuplicateHeaderMode(DuplicateHeaderMode.DISALLOW).get().getDuplicateHeaderMode()); - } - - @Test - public void testGetHeader() { - final String[] header = { "one", "two", "three" }; - final CSVFormat formatWithHeader = CSVFormat.DEFAULT.withHeader(header); - // getHeader() makes a copy of the header array. - final String[] headerCopy = formatWithHeader.getHeader(); - headerCopy[0] = "A"; - headerCopy[1] = "B"; - headerCopy[2] = "C"; - assertFalse(Arrays.equals(formatWithHeader.getHeader(), headerCopy)); - assertNotSame(formatWithHeader.getHeader(), headerCopy); - } - - @Test - public void testHashCodeAndWithIgnoreHeaderCase() { - - final CSVFormat csvFormat = CSVFormat.INFORMIX_UNLOAD_CSV; - final CSVFormat csvFormatTwo = csvFormat.withIgnoreHeaderCase(); - csvFormatTwo.hashCode(); - - assertFalse(csvFormat.getIgnoreHeaderCase()); - assertTrue(csvFormatTwo.getIgnoreHeaderCase()); // now different - assertFalse(csvFormatTwo.getTrailingDelimiter()); - - Assertions.assertNotEquals(csvFormatTwo, csvFormat); // CSV-244 - should not be equal - assertFalse(csvFormatTwo.getAllowMissingColumnNames()); - - assertFalse(csvFormatTwo.getTrim()); - - } - - @Test - public void testJiraCsv236() { - CSVFormat.DEFAULT.builder().setAllowDuplicateHeaderNames(true).setHeader("CC", "VV", "VV").get(); - } - - @SuppressWarnings("deprecation") - @Test - public void testJiraCsv236__Deprecated() { - CSVFormat.DEFAULT.withAllowDuplicateHeaderNames().withHeader("CC", "VV", "VV"); - } - - @Test - public void testNewFormat() { - - final CSVFormat csvFormat = CSVFormat.newFormat('X'); - - assertFalse(csvFormat.getSkipHeaderRecord()); - assertFalse(csvFormat.isEscapeCharacterSet()); - - assertNull(csvFormat.getRecordSeparator()); - assertNull(csvFormat.getQuoteMode()); - - assertNull(csvFormat.getCommentMarker()); - assertFalse(csvFormat.getIgnoreHeaderCase()); - - assertFalse(csvFormat.getAllowMissingColumnNames()); - assertFalse(csvFormat.getTrim()); - - assertFalse(csvFormat.isNullStringSet()); - assertNull(csvFormat.getEscapeCharacter()); - - assertFalse(csvFormat.getIgnoreSurroundingSpaces()); - assertFalse(csvFormat.getTrailingDelimiter()); - - assertEquals('X', csvFormat.getDelimiter()); - assertNull(csvFormat.getNullString()); - - assertFalse(csvFormat.isQuoteCharacterSet()); - assertFalse(csvFormat.isCommentMarkerSet()); - - assertNull(csvFormat.getQuoteCharacter()); - assertFalse(csvFormat.getIgnoreEmptyLines()); - - assertFalse(csvFormat.getSkipHeaderRecord()); - assertFalse(csvFormat.isEscapeCharacterSet()); - - assertNull(csvFormat.getRecordSeparator()); - assertNull(csvFormat.getQuoteMode()); - - assertNull(csvFormat.getCommentMarker()); - assertFalse(csvFormat.getIgnoreHeaderCase()); - - assertFalse(csvFormat.getAllowMissingColumnNames()); - assertFalse(csvFormat.getTrim()); - - assertFalse(csvFormat.isNullStringSet()); - assertNull(csvFormat.getEscapeCharacter()); - - assertFalse(csvFormat.getIgnoreSurroundingSpaces()); - assertFalse(csvFormat.getTrailingDelimiter()); - - assertEquals('X', csvFormat.getDelimiter()); - assertNull(csvFormat.getNullString()); - - assertFalse(csvFormat.isQuoteCharacterSet()); - assertFalse(csvFormat.isCommentMarkerSet()); - - assertNull(csvFormat.getQuoteCharacter()); - assertFalse(csvFormat.getIgnoreEmptyLines()); - - } - - @Test - public void testNullRecordSeparatorCsv106() { - final CSVFormat format = CSVFormat.newFormat(';').builder().setSkipHeaderRecord(true).setHeader("H1", "H2").get(); - final String formatStr = format.format("A", "B"); - assertNotNull(formatStr); - assertFalse(formatStr.endsWith("null")); - } - - @SuppressWarnings("deprecation") - @Test - public void testNullRecordSeparatorCsv106__Deprecated() { - final CSVFormat format = CSVFormat.newFormat(';').withSkipHeaderRecord().withHeader("H1", "H2"); - final String formatStr = format.format("A", "B"); - assertNotNull(formatStr); - assertFalse(formatStr.endsWith("null")); - } - - @Test - public void testPrintRecord() throws IOException { - final Appendable out = new StringBuilder(); - final CSVFormat format = CSVFormat.RFC4180; - format.printRecord(out, "a", "b", "c"); - assertEquals("a,b,c" + format.getRecordSeparator(), out.toString()); - } - - @Test - public void testPrintRecordEmpty() throws IOException { - final Appendable out = new StringBuilder(); - final CSVFormat format = CSVFormat.RFC4180; - format.printRecord(out); - assertEquals(format.getRecordSeparator(), out.toString()); - } - - @Test - public void testPrintWithEscapesEndWithCRLF() throws IOException { - final Reader in = new StringReader("x,y,x\r\na,?b,c\r\n"); - final Appendable out = new StringBuilder(); - final CSVFormat format = CSVFormat.RFC4180.withEscape('?').withDelimiter(',').withQuote(null).withRecordSeparator(CRLF); - format.print(in, out, true); - assertEquals("x?,y?,x?r?na?,??b?,c?r?n", out.toString()); - } - - @Test - public void testPrintWithEscapesEndWithoutCRLF() throws IOException { - final Reader in = new StringReader("x,y,x"); - final Appendable out = new StringBuilder(); - final CSVFormat format = CSVFormat.RFC4180.withEscape('?').withDelimiter(',').withQuote(null).withRecordSeparator(CRLF); - format.print(in, out, true); - assertEquals("x?,y?,x", out.toString()); - } - - @Test - public void testPrintWithoutQuotes() throws IOException { - final Reader in = new StringReader(""); - final Appendable out = new StringBuilder(); - final CSVFormat format = CSVFormat.RFC4180.withDelimiter(',').withQuote('"').withEscape('?').withQuoteMode(QuoteMode.NON_NUMERIC); - format.print(in, out, true); - assertEquals("\"\"", out.toString()); - } - - @Test - public void testPrintWithQuoteModeIsNONE() throws IOException { - final Reader in = new StringReader("a,b,c"); - final Appendable out = new StringBuilder(); - final CSVFormat format = CSVFormat.RFC4180.withDelimiter(',').withQuote('"').withEscape('?').withQuoteMode(QuoteMode.NONE); - format.print(in, out, true); - assertEquals("a?,b?,c", out.toString()); - } - - @Test - public void testPrintWithQuotes() throws IOException { - final Reader in = new StringReader("\"a,b,c\r\nx,y,z"); - final Appendable out = new StringBuilder(); - final CSVFormat format = CSVFormat.RFC4180.withDelimiter(',').withQuote('"').withEscape('?').withQuoteMode(QuoteMode.NON_NUMERIC); - format.print(in, out, true); - assertEquals("\"\"\"a,b,c\r\nx,y,z\"", out.toString()); - } - - @Test - public void testQuoteCharSameAsCommentStartThrowsException() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setQuote('!').setCommentMarker('!').get()); - } - - @SuppressWarnings("deprecation") - @Test - public void testQuoteCharSameAsCommentStartThrowsException_Deprecated() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withQuote('!').withCommentMarker('!')); - } - - @Test - public void testQuoteCharSameAsCommentStartThrowsExceptionForWrapperType() { - // Cannot assume that callers won't use different Character objects - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setQuote(Character.valueOf('!')).setCommentMarker('!').get()); - } - - @SuppressWarnings("deprecation") - @Test - public void testQuoteCharSameAsCommentStartThrowsExceptionForWrapperType_Deprecated() { - // Cannot assume that callers won't use different Character objects - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withQuote(Character.valueOf('!')).withCommentMarker('!')); - } - - @Test - public void testQuoteCharSameAsDelimiterThrowsException() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setQuote('!').setDelimiter('!').get()); - } - - @SuppressWarnings("deprecation") - @Test - public void testQuoteCharSameAsDelimiterThrowsException_Deprecated() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withQuote('!').withDelimiter('!')); - } - - @Test - public void testQuoteModeNoneShouldReturnMeaningfulExceptionMessage() { - final Exception exception = assertThrows(IllegalArgumentException.class, () -> - // @formatter:off - CSVFormat.DEFAULT.builder() - .setHeader("Col1", "Col2", "Col3", "Col4") - .setQuoteMode(QuoteMode.NONE) - .get() - // @formatter:on - ); - final String actualMessage = exception.getMessage(); - final String expectedMessage = "Quote mode set to NONE but no escape character is set"; - assertEquals(expectedMessage, actualMessage); - } - - @Test - public void testQuotePolicyNoneWithoutEscapeThrowsException() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.newFormat('!').builder().setQuoteMode(QuoteMode.NONE).get()); - } - - @SuppressWarnings("deprecation") - @Test - public void testQuotePolicyNoneWithoutEscapeThrowsException_Deprecated() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.newFormat('!').withQuoteMode(QuoteMode.NONE)); - } - - @Test - public void testRFC4180() { - assertNull(RFC4180.getCommentMarker()); - assertEquals(',', RFC4180.getDelimiter()); - assertNull(RFC4180.getEscapeCharacter()); - assertFalse(RFC4180.getIgnoreEmptyLines()); - assertEquals(Character.valueOf('"'), RFC4180.getQuoteCharacter()); - assertNull(RFC4180.getQuoteMode()); - assertEquals("\r\n", RFC4180.getRecordSeparator()); - } - - @SuppressWarnings("boxing") // no need to worry about boxing here - @Test - public void testSerialization() throws Exception { - final ByteArrayOutputStream out = new ByteArrayOutputStream(); - - try (final ObjectOutputStream oos = new ObjectOutputStream(out)) { - oos.writeObject(CSVFormat.DEFAULT); - oos.flush(); - } - - final ObjectInputStream in = new ObjectInputStream(new ByteArrayInputStream(out.toByteArray())); - final CSVFormat format = (CSVFormat) in.readObject(); - - assertNotNull(format); - assertEquals(CSVFormat.DEFAULT.getDelimiter(), format.getDelimiter(), "delimiter"); - assertEquals(CSVFormat.DEFAULT.getQuoteCharacter(), format.getQuoteCharacter(), "encapsulator"); - assertEquals(CSVFormat.DEFAULT.getCommentMarker(), format.getCommentMarker(), "comment start"); - assertEquals(CSVFormat.DEFAULT.getRecordSeparator(), format.getRecordSeparator(), "record separator"); - assertEquals(CSVFormat.DEFAULT.getEscapeCharacter(), format.getEscapeCharacter(), "escape"); - assertEquals(CSVFormat.DEFAULT.getIgnoreSurroundingSpaces(), format.getIgnoreSurroundingSpaces(), "trim"); - assertEquals(CSVFormat.DEFAULT.getIgnoreEmptyLines(), format.getIgnoreEmptyLines(), "empty lines"); - } - - @Test - public void testToString() { - - final String string = CSVFormat.INFORMIX_UNLOAD.toString(); - - assertEquals("Delimiter=<|> Escape=<\\> QuoteChar=<\"> RecordSeparator=<\n> EmptyLines:ignored SkipHeaderRecord:false", string); - - } - - @Test - public void testToStringAndWithCommentMarkerTakingCharacter() { - - final CSVFormat.Predefined csvFormat_Predefined = CSVFormat.Predefined.Default; - final CSVFormat csvFormat = csvFormat_Predefined.getFormat(); - - assertNull(csvFormat.getEscapeCharacter()); - assertTrue(csvFormat.isQuoteCharacterSet()); - - assertFalse(csvFormat.getTrim()); - assertFalse(csvFormat.getIgnoreSurroundingSpaces()); - - assertFalse(csvFormat.getTrailingDelimiter()); - assertEquals(',', csvFormat.getDelimiter()); - - assertFalse(csvFormat.getIgnoreHeaderCase()); - assertEquals("\r\n", csvFormat.getRecordSeparator()); - - assertFalse(csvFormat.isCommentMarkerSet()); - assertNull(csvFormat.getCommentMarker()); - - assertFalse(csvFormat.isNullStringSet()); - assertFalse(csvFormat.getAllowMissingColumnNames()); - - assertFalse(csvFormat.isEscapeCharacterSet()); - assertFalse(csvFormat.getSkipHeaderRecord()); - - assertNull(csvFormat.getNullString()); - assertNull(csvFormat.getQuoteMode()); - - assertTrue(csvFormat.getIgnoreEmptyLines()); - assertEquals('\"', (char) csvFormat.getQuoteCharacter()); - - final Character character = Character.valueOf('n'); - - final CSVFormat csvFormatTwo = csvFormat.withCommentMarker(character); - - assertNull(csvFormat.getEscapeCharacter()); - assertTrue(csvFormat.isQuoteCharacterSet()); - - assertFalse(csvFormat.getTrim()); - assertFalse(csvFormat.getIgnoreSurroundingSpaces()); - - assertFalse(csvFormat.getTrailingDelimiter()); - assertEquals(',', csvFormat.getDelimiter()); - - assertFalse(csvFormat.getIgnoreHeaderCase()); - assertEquals("\r\n", csvFormat.getRecordSeparator()); - - assertFalse(csvFormat.isCommentMarkerSet()); - assertNull(csvFormat.getCommentMarker()); - - assertFalse(csvFormat.isNullStringSet()); - assertFalse(csvFormat.getAllowMissingColumnNames()); - - assertFalse(csvFormat.isEscapeCharacterSet()); - assertFalse(csvFormat.getSkipHeaderRecord()); - - assertNull(csvFormat.getNullString()); - assertNull(csvFormat.getQuoteMode()); - - assertTrue(csvFormat.getIgnoreEmptyLines()); - assertEquals('\"', (char) csvFormat.getQuoteCharacter()); - - assertFalse(csvFormatTwo.isNullStringSet()); - assertFalse(csvFormatTwo.getAllowMissingColumnNames()); - - assertEquals('\"', (char) csvFormatTwo.getQuoteCharacter()); - assertNull(csvFormatTwo.getNullString()); - - assertEquals(',', csvFormatTwo.getDelimiter()); - assertFalse(csvFormatTwo.getTrailingDelimiter()); - - assertTrue(csvFormatTwo.isCommentMarkerSet()); - assertFalse(csvFormatTwo.getIgnoreHeaderCase()); - - assertFalse(csvFormatTwo.getTrim()); - assertNull(csvFormatTwo.getEscapeCharacter()); - - assertTrue(csvFormatTwo.isQuoteCharacterSet()); - assertFalse(csvFormatTwo.getIgnoreSurroundingSpaces()); - - assertEquals("\r\n", csvFormatTwo.getRecordSeparator()); - assertNull(csvFormatTwo.getQuoteMode()); - - assertEquals('n', (char) csvFormatTwo.getCommentMarker()); - assertFalse(csvFormatTwo.getSkipHeaderRecord()); - - assertFalse(csvFormatTwo.isEscapeCharacterSet()); - assertTrue(csvFormatTwo.getIgnoreEmptyLines()); - - assertNotSame(csvFormat, csvFormatTwo); - assertNotSame(csvFormatTwo, csvFormat); - - Assertions.assertNotEquals(csvFormatTwo, csvFormat); - - assertNull(csvFormat.getEscapeCharacter()); - assertTrue(csvFormat.isQuoteCharacterSet()); - - assertFalse(csvFormat.getTrim()); - assertFalse(csvFormat.getIgnoreSurroundingSpaces()); - - assertFalse(csvFormat.getTrailingDelimiter()); - assertEquals(',', csvFormat.getDelimiter()); - - assertFalse(csvFormat.getIgnoreHeaderCase()); - assertEquals("\r\n", csvFormat.getRecordSeparator()); - - assertFalse(csvFormat.isCommentMarkerSet()); - assertNull(csvFormat.getCommentMarker()); - - assertFalse(csvFormat.isNullStringSet()); - assertFalse(csvFormat.getAllowMissingColumnNames()); - - assertFalse(csvFormat.isEscapeCharacterSet()); - assertFalse(csvFormat.getSkipHeaderRecord()); - - assertNull(csvFormat.getNullString()); - assertNull(csvFormat.getQuoteMode()); - - assertTrue(csvFormat.getIgnoreEmptyLines()); - assertEquals('\"', (char) csvFormat.getQuoteCharacter()); - - assertFalse(csvFormatTwo.isNullStringSet()); - assertFalse(csvFormatTwo.getAllowMissingColumnNames()); - - assertEquals('\"', (char) csvFormatTwo.getQuoteCharacter()); - assertNull(csvFormatTwo.getNullString()); - - assertEquals(',', csvFormatTwo.getDelimiter()); - assertFalse(csvFormatTwo.getTrailingDelimiter()); - - assertTrue(csvFormatTwo.isCommentMarkerSet()); - assertFalse(csvFormatTwo.getIgnoreHeaderCase()); - - assertFalse(csvFormatTwo.getTrim()); - assertNull(csvFormatTwo.getEscapeCharacter()); - - assertTrue(csvFormatTwo.isQuoteCharacterSet()); - assertFalse(csvFormatTwo.getIgnoreSurroundingSpaces()); - - assertEquals("\r\n", csvFormatTwo.getRecordSeparator()); - assertNull(csvFormatTwo.getQuoteMode()); - - assertEquals('n', (char) csvFormatTwo.getCommentMarker()); - assertFalse(csvFormatTwo.getSkipHeaderRecord()); - - assertFalse(csvFormatTwo.isEscapeCharacterSet()); - assertTrue(csvFormatTwo.getIgnoreEmptyLines()); - - assertNotSame(csvFormat, csvFormatTwo); - assertNotSame(csvFormatTwo, csvFormat); - - Assertions.assertNotEquals(csvFormat, csvFormatTwo); - - Assertions.assertNotEquals(csvFormatTwo, csvFormat); - assertEquals("Delimiter=<,> QuoteChar=<\"> CommentStart= " + "RecordSeparator=<\r\n> EmptyLines:ignored SkipHeaderRecord:false", - csvFormatTwo.toString()); - - } - - @Test - public void testTrim() throws IOException { - final CSVFormat formatWithTrim = CSVFormat.DEFAULT.withDelimiter(',').withTrim().withQuote(null).withRecordSeparator(CRLF); - - CharSequence in = "a,b,c"; - final StringBuilder out = new StringBuilder(); - formatWithTrim.print(in, out, true); - assertEquals("a,b,c", out.toString()); - - in = new StringBuilder(" x,y,z"); - out.setLength(0); - formatWithTrim.print(in, out, true); - assertEquals("x,y,z", out.toString()); - - in = new StringBuilder(""); - out.setLength(0); - formatWithTrim.print(in, out, true); - assertEquals("", out.toString()); - - in = new StringBuilder("header\r\n"); - out.setLength(0); - formatWithTrim.print(in, out, true); - assertEquals("header", out.toString()); - } - - @Test - public void testWithCommentStart() { - final CSVFormat formatWithCommentStart = CSVFormat.DEFAULT.withCommentMarker('#'); - assertEquals(Character.valueOf('#'), formatWithCommentStart.getCommentMarker()); - } - - @Test - public void testWithCommentStartCRThrowsException() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withCommentMarker(CR)); - } - - @Test - public void testWithDelimiter() { - final CSVFormat formatWithDelimiter = CSVFormat.DEFAULT.withDelimiter('!'); - assertEquals('!', formatWithDelimiter.getDelimiter()); - } - - @Test - public void testWithDelimiterLFThrowsException() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withDelimiter(LF)); - } - - @Test - public void testWithEmptyDuplicates() { - final CSVFormat formatWithEmptyDuplicates = CSVFormat.DEFAULT.builder().setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_EMPTY).get(); - - assertEquals(DuplicateHeaderMode.ALLOW_EMPTY, formatWithEmptyDuplicates.getDuplicateHeaderMode()); - assertFalse(formatWithEmptyDuplicates.getAllowDuplicateHeaderNames()); - } - - @Test - public void testWithEmptyEnum() { - final CSVFormat formatWithHeader = CSVFormat.DEFAULT.withHeader(EmptyEnum.class); - assertEquals(0, formatWithHeader.getHeader().length); - } - - @Test - public void testWithEscape() { - final CSVFormat formatWithEscape = CSVFormat.DEFAULT.withEscape('&'); - assertEquals(Character.valueOf('&'), formatWithEscape.getEscapeCharacter()); - } - - @Test - public void testWithEscapeCRThrowsExceptions() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withEscape(CR)); - } - - @Test - public void testWithFirstRecordAsHeader() { - final CSVFormat formatWithFirstRecordAsHeader = CSVFormat.DEFAULT.withFirstRecordAsHeader(); - assertTrue(formatWithFirstRecordAsHeader.getSkipHeaderRecord()); - assertEquals(0, formatWithFirstRecordAsHeader.getHeader().length); - } - - @Test - public void testWithHeader() { - final String[] header = { "one", "two", "three" }; - // withHeader() makes a copy of the header array. - final CSVFormat formatWithHeader = CSVFormat.DEFAULT.withHeader(header); - assertArrayEquals(header, formatWithHeader.getHeader()); - assertNotSame(header, formatWithHeader.getHeader()); - } - - @Test - public void testWithHeaderComments() { - - final CSVFormat csvFormat = CSVFormat.DEFAULT; - - assertEquals('\"', (char) csvFormat.getQuoteCharacter()); - assertFalse(csvFormat.isCommentMarkerSet()); - - assertFalse(csvFormat.isEscapeCharacterSet()); - assertTrue(csvFormat.isQuoteCharacterSet()); - - assertFalse(csvFormat.getSkipHeaderRecord()); - assertNull(csvFormat.getQuoteMode()); - - assertEquals(',', csvFormat.getDelimiter()); - assertTrue(csvFormat.getIgnoreEmptyLines()); - - assertFalse(csvFormat.getIgnoreHeaderCase()); - assertNull(csvFormat.getCommentMarker()); - - assertEquals("\r\n", csvFormat.getRecordSeparator()); - assertFalse(csvFormat.getTrailingDelimiter()); - - assertFalse(csvFormat.getAllowMissingColumnNames()); - assertFalse(csvFormat.getTrim()); - - assertFalse(csvFormat.isNullStringSet()); - assertNull(csvFormat.getNullString()); - - assertFalse(csvFormat.getIgnoreSurroundingSpaces()); - assertNull(csvFormat.getEscapeCharacter()); - - final Object[] objectArray = new Object[8]; - final CSVFormat csvFormatTwo = csvFormat.withHeaderComments(objectArray); - - assertEquals('\"', (char) csvFormat.getQuoteCharacter()); - assertFalse(csvFormat.isCommentMarkerSet()); - - assertFalse(csvFormat.isEscapeCharacterSet()); - assertTrue(csvFormat.isQuoteCharacterSet()); - - assertFalse(csvFormat.getSkipHeaderRecord()); - assertNull(csvFormat.getQuoteMode()); - - assertEquals(',', csvFormat.getDelimiter()); - assertTrue(csvFormat.getIgnoreEmptyLines()); - - assertFalse(csvFormat.getIgnoreHeaderCase()); - assertNull(csvFormat.getCommentMarker()); - - assertEquals("\r\n", csvFormat.getRecordSeparator()); - assertFalse(csvFormat.getTrailingDelimiter()); - - assertFalse(csvFormat.getAllowMissingColumnNames()); - assertFalse(csvFormat.getTrim()); - - assertFalse(csvFormat.isNullStringSet()); - assertNull(csvFormat.getNullString()); - - assertFalse(csvFormat.getIgnoreSurroundingSpaces()); - assertNull(csvFormat.getEscapeCharacter()); - - assertFalse(csvFormatTwo.getIgnoreHeaderCase()); - assertNull(csvFormatTwo.getQuoteMode()); - - assertTrue(csvFormatTwo.getIgnoreEmptyLines()); - assertFalse(csvFormatTwo.getIgnoreSurroundingSpaces()); - - assertNull(csvFormatTwo.getEscapeCharacter()); - assertFalse(csvFormatTwo.getTrim()); - - assertFalse(csvFormatTwo.isEscapeCharacterSet()); - assertTrue(csvFormatTwo.isQuoteCharacterSet()); - - assertFalse(csvFormatTwo.getSkipHeaderRecord()); - assertEquals('\"', (char) csvFormatTwo.getQuoteCharacter()); - - assertFalse(csvFormatTwo.getAllowMissingColumnNames()); - assertNull(csvFormatTwo.getNullString()); - - assertFalse(csvFormatTwo.isNullStringSet()); - assertFalse(csvFormatTwo.getTrailingDelimiter()); - - assertEquals("\r\n", csvFormatTwo.getRecordSeparator()); - assertEquals(',', csvFormatTwo.getDelimiter()); - - assertNull(csvFormatTwo.getCommentMarker()); - assertFalse(csvFormatTwo.isCommentMarkerSet()); - - assertNotSame(csvFormat, csvFormatTwo); - assertNotSame(csvFormatTwo, csvFormat); - - Assertions.assertNotEquals(csvFormatTwo, csvFormat); // CSV-244 - should not be equal - - final String string = csvFormatTwo.format(objectArray); - - assertEquals('\"', (char) csvFormat.getQuoteCharacter()); - assertFalse(csvFormat.isCommentMarkerSet()); - - assertFalse(csvFormat.isEscapeCharacterSet()); - assertTrue(csvFormat.isQuoteCharacterSet()); - - assertFalse(csvFormat.getSkipHeaderRecord()); - assertNull(csvFormat.getQuoteMode()); - - assertEquals(',', csvFormat.getDelimiter()); - assertTrue(csvFormat.getIgnoreEmptyLines()); - - assertFalse(csvFormat.getIgnoreHeaderCase()); - assertNull(csvFormat.getCommentMarker()); - - assertEquals("\r\n", csvFormat.getRecordSeparator()); - assertFalse(csvFormat.getTrailingDelimiter()); - - assertFalse(csvFormat.getAllowMissingColumnNames()); - assertFalse(csvFormat.getTrim()); - - assertFalse(csvFormat.isNullStringSet()); - assertNull(csvFormat.getNullString()); - - assertFalse(csvFormat.getIgnoreSurroundingSpaces()); - assertNull(csvFormat.getEscapeCharacter()); - - assertFalse(csvFormatTwo.getIgnoreHeaderCase()); - assertNull(csvFormatTwo.getQuoteMode()); - - assertTrue(csvFormatTwo.getIgnoreEmptyLines()); - assertFalse(csvFormatTwo.getIgnoreSurroundingSpaces()); - - assertNull(csvFormatTwo.getEscapeCharacter()); - assertFalse(csvFormatTwo.getTrim()); - - assertFalse(csvFormatTwo.isEscapeCharacterSet()); - assertTrue(csvFormatTwo.isQuoteCharacterSet()); - - assertFalse(csvFormatTwo.getSkipHeaderRecord()); - assertEquals('\"', (char) csvFormatTwo.getQuoteCharacter()); - - assertFalse(csvFormatTwo.getAllowMissingColumnNames()); - assertNull(csvFormatTwo.getNullString()); - - assertFalse(csvFormatTwo.isNullStringSet()); - assertFalse(csvFormatTwo.getTrailingDelimiter()); - - assertEquals("\r\n", csvFormatTwo.getRecordSeparator()); - assertEquals(',', csvFormatTwo.getDelimiter()); - - assertNull(csvFormatTwo.getCommentMarker()); - assertFalse(csvFormatTwo.isCommentMarkerSet()); - - assertNotSame(csvFormat, csvFormatTwo); - assertNotSame(csvFormatTwo, csvFormat); - - assertNotNull(string); - Assertions.assertNotEquals(csvFormat, csvFormatTwo); // CSV-244 - should not be equal - - Assertions.assertNotEquals(csvFormatTwo, csvFormat); // CSV-244 - should not be equal - assertEquals(",,,,,,,", string); - - } - - @Test - public void testWithHeaderEnum() { - final CSVFormat formatWithHeader = CSVFormat.DEFAULT.withHeader(Header.class); - assertArrayEquals(new String[] { "Name", "Email", "Phone" }, formatWithHeader.getHeader()); - } - - @Test - public void testWithHeaderEnumNull() { - final CSVFormat format = CSVFormat.DEFAULT; - final Class> simpleName = null; - format.withHeader(simpleName); - } - - @Test - public void testWithHeaderResultSetNull() throws SQLException { - final CSVFormat format = CSVFormat.DEFAULT; - final ResultSet resultSet = null; - format.withHeader(resultSet); - } - - @Test - public void testWithIgnoreEmptyLines() { - assertFalse(CSVFormat.DEFAULT.withIgnoreEmptyLines(false).getIgnoreEmptyLines()); - assertTrue(CSVFormat.DEFAULT.withIgnoreEmptyLines().getIgnoreEmptyLines()); - } - - @Test - public void testWithIgnoreSurround() { - assertFalse(CSVFormat.DEFAULT.withIgnoreSurroundingSpaces(false).getIgnoreSurroundingSpaces()); - assertTrue(CSVFormat.DEFAULT.withIgnoreSurroundingSpaces().getIgnoreSurroundingSpaces()); - } - - @Test - public void testWithNullString() { - final CSVFormat formatWithNullString = CSVFormat.DEFAULT.withNullString("null"); - assertEquals("null", formatWithNullString.getNullString()); - } - - @Test - public void testWithQuoteChar() { - final CSVFormat formatWithQuoteChar = CSVFormat.DEFAULT.withQuote('"'); - assertEquals(Character.valueOf('"'), formatWithQuoteChar.getQuoteCharacter()); - } - - @Test - public void testWithQuoteLFThrowsException() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withQuote(LF)); - } - - @Test - public void testWithQuotePolicy() { - final CSVFormat formatWithQuotePolicy = CSVFormat.DEFAULT.withQuoteMode(QuoteMode.ALL); - assertEquals(QuoteMode.ALL, formatWithQuotePolicy.getQuoteMode()); - } - - @Test - public void testWithRecordSeparatorCR() { - final CSVFormat formatWithRecordSeparator = CSVFormat.DEFAULT.withRecordSeparator(CR); - assertEquals(String.valueOf(CR), formatWithRecordSeparator.getRecordSeparator()); - } - - @Test - public void testWithRecordSeparatorCRLF() { - final CSVFormat formatWithRecordSeparator = CSVFormat.DEFAULT.withRecordSeparator(CRLF); - assertEquals(CRLF, formatWithRecordSeparator.getRecordSeparator()); - } - - @Test - public void testWithRecordSeparatorLF() { - final CSVFormat formatWithRecordSeparator = CSVFormat.DEFAULT.withRecordSeparator(LF); - assertEquals(String.valueOf(LF), formatWithRecordSeparator.getRecordSeparator()); - } - - @Test - public void testWithSystemRecordSeparator() { - final CSVFormat formatWithRecordSeparator = CSVFormat.DEFAULT.withSystemRecordSeparator(); - assertEquals(System.lineSeparator(), formatWithRecordSeparator.getRecordSeparator()); - } -} +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.commons.csv; + +import static org.apache.commons.csv.CSVFormat.RFC4180; +import static org.apache.commons.csv.Constants.CR; +import static org.apache.commons.csv.Constants.CRLF; +import static org.apache.commons.csv.Constants.LF; +import static org.junit.jupiter.api.Assertions.assertArrayEquals; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNotSame; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.junit.jupiter.api.Assertions.fail; + +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.ObjectInputStream; +import java.io.ObjectOutputStream; +import java.io.Reader; +import java.io.StringReader; +import java.lang.reflect.Method; +import java.lang.reflect.Modifier; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.util.Arrays; +import java.util.Objects; + +import org.apache.commons.csv.CSVFormat.Builder; +import org.junit.jupiter.api.Test; + +/** + * Tests {@link CSVFormat}. + */ +class CSVFormatTest { + + public enum EmptyEnum { + // empty enum. + } + + public enum Header { + Name, Email, Phone + } + + private static void assertNotEqualsFlip(final Object right, final Object left) { + assertNotEquals(right, left); + assertNotEquals(left, right); + } + + private static CSVFormat copy(final CSVFormat format) { + return format.builder().setDelimiter(format.getDelimiter()).get(); + } + + private void assertNotEqualsHash(final String name, final String type, final Object left, final Object right) { + if (left.equals(right) || right.equals(left)) { + fail("Objects must not compare equal for " + name + "(" + type + ")"); + } + if (left.hashCode() == right.hashCode()) { + fail("Hash code should not be equal for " + name + "(" + type + ")"); + } + } + + @Test + void testBuildVsGet() { + final Builder builder = CSVFormat.DEFAULT.builder(); + assertNotSame(builder.get(), builder.build()); + } + + @Test + void testDelimiterCharLineBreakCrThrowsException1() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setDelimiter(Constants.CR).get()); + } + + @Test + void testDelimiterCharLineBreakLfThrowsException1() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setDelimiter(Constants.LF).get()); + } + + @Test + void testDelimiterEmptyStringThrowsException1() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setDelimiter("").get()); + } + + @SuppressWarnings("deprecation") + @Test + void testDelimiterSameAsCommentStartThrowsException_Deprecated() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withDelimiter('!').withCommentMarker('!')); + } + + @Test + void testDelimiterSameAsCommentStartThrowsException1() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setDelimiter('!').setCommentMarker('!').get()); + } + + @SuppressWarnings("deprecation") + @Test + void testDelimiterSameAsEscapeThrowsException_Deprecated() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withDelimiter('!').withEscape('!')); + } + + @Test + void testDelimiterSameAsEscapeThrowsException1() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setDelimiter('!').setEscape('!').get()); + } + + @Test + void testDelimiterSameAsRecordSeparatorThrowsException() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.newFormat(CR)); + } + + @Test + void testDelimiterStringLineBreakCrThrowsException1() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setDelimiter(String.valueOf(Constants.CR)).get()); + } + + @Test + void testDelimiterStringLineBreakLfThrowsException1() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setDelimiter(String.valueOf(Constants.LF)).get()); + } + + @Test + void testDuplicateHeaderElements() { + final String[] header = { "A", "A" }; + final CSVFormat format = CSVFormat.DEFAULT.builder().setHeader(header).get(); + assertEquals(2, format.getHeader().length); + assertArrayEquals(header, format.getHeader()); + } + + @SuppressWarnings("deprecation") + @Test + void testDuplicateHeaderElements_Deprecated() { + final String[] header = { "A", "A" }; + final CSVFormat format = CSVFormat.DEFAULT.withHeader(header); + assertEquals(2, format.getHeader().length); + assertArrayEquals(header, format.getHeader()); + } + + @Test + void testDuplicateHeaderElementsFalse() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setAllowDuplicateHeaderNames(false).setHeader("A", "A").get()); + } + + @SuppressWarnings("deprecation") + @Test + void testDuplicateHeaderElementsFalse_Deprecated() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withAllowDuplicateHeaderNames(false).withHeader("A", "A")); + } + + @Test + void testDuplicateHeaderElementsTrue() { + CSVFormat.DEFAULT.builder().setAllowDuplicateHeaderNames(true).setHeader("A", "A").get(); + } + + @SuppressWarnings("deprecation") + @Test + void testDuplicateHeaderElementsTrue_Deprecated() { + CSVFormat.DEFAULT.withAllowDuplicateHeaderNames(true).withHeader("A", "A"); + } + + @Test + void testDuplicateHeaderElementsTrueContainsEmpty1() { + CSVFormat.DEFAULT.builder().setAllowDuplicateHeaderNames(false).setHeader("A", "", "B", "").get(); + } + + @Test + void testDuplicateHeaderElementsTrueContainsEmpty2() { + CSVFormat.DEFAULT.builder().setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_EMPTY).setHeader("A", "", "B", "").get(); + } + + @Test + void testDuplicateHeaderElementsTrueContainsEmpty3() { + CSVFormat.DEFAULT.builder().setAllowDuplicateHeaderNames(false).setAllowMissingColumnNames(true).setHeader("A", "", "B", "").get(); + } + + @Test + void testEquals() { + final CSVFormat right = CSVFormat.DEFAULT; + final CSVFormat left = copy(right); + assertNotEquals(null, right); + assertNotEquals("A String Instance", right); + assertEquals(right, right); + assertEquals(right, left); + assertEquals(left, right); + assertEquals(right.hashCode(), right.hashCode()); + assertEquals(right.hashCode(), left.hashCode()); + } + + @Test + void testEqualsCommentStart() { + final CSVFormat right = CSVFormat.newFormat('\'').builder().setQuote('"').setCommentMarker('#').setQuoteMode(QuoteMode.ALL).get(); + final CSVFormat left = right.builder().setCommentMarker('!').get(); + + assertNotEqualsFlip(right, left); + } + + @SuppressWarnings("deprecation") + @Test + void testEqualsCommentStart_Deprecated() { + final CSVFormat right = CSVFormat.newFormat('\'').withQuote('"').withCommentMarker('#').withQuoteMode(QuoteMode.ALL); + final CSVFormat left = right.withCommentMarker('!'); + + assertNotEqualsFlip(right, left); + } + + @Test + void testEqualsDelimiter() { + final CSVFormat right = CSVFormat.newFormat('!'); + final CSVFormat left = CSVFormat.newFormat('?'); + + assertNotEqualsFlip(right, left); + } + + @Test + void testEqualsEscape() { + final CSVFormat right = CSVFormat.newFormat('\'').builder().setQuote('"').setCommentMarker('#').setEscape('+').setQuoteMode(QuoteMode.ALL).get(); + final CSVFormat left = right.builder().setEscape('!').get(); + + assertNotEqualsFlip(right, left); + } + + @SuppressWarnings("deprecation") + @Test + void testEqualsEscape_Deprecated() { + final CSVFormat right = CSVFormat.newFormat('\'').withQuote('"').withCommentMarker('#').withEscape('+').withQuoteMode(QuoteMode.ALL); + final CSVFormat left = right.withEscape('!'); + + assertNotEqualsFlip(right, left); + } + + @Test + void testEqualsHash() throws Exception { + final Method[] methods = CSVFormat.class.getDeclaredMethods(); + for (final Method method : methods) { + if (Modifier.isPublic(method.getModifiers())) { + final String name = method.getName(); + if (name.startsWith("with")) { + for (final Class cls : method.getParameterTypes()) { + final String type = cls.getCanonicalName(); + switch (type) { + case "boolean": { + final Object defTrue = method.invoke(CSVFormat.DEFAULT, Boolean.TRUE); + final Object defFalse = method.invoke(CSVFormat.DEFAULT, Boolean.FALSE); + assertNotEqualsHash(name, type, defTrue, defFalse); + break; + } + case "char": { + final Object a = method.invoke(CSVFormat.DEFAULT, 'a'); + final Object b = method.invoke(CSVFormat.DEFAULT, 'b'); + assertNotEqualsHash(name, type, a, b); + break; + } + case "java.lang.Character": { + final Object a = method.invoke(CSVFormat.DEFAULT, new Object[] { null }); + final Object b = method.invoke(CSVFormat.DEFAULT, Character.valueOf('d')); + assertNotEqualsHash(name, type, a, b); + break; + } + case "java.lang.String": { + final Object a = method.invoke(CSVFormat.DEFAULT, new Object[] { null }); + final Object b = method.invoke(CSVFormat.DEFAULT, "e"); + assertNotEqualsHash(name, type, a, b); + break; + } + case "java.lang.String[]": { + final Object a = method.invoke(CSVFormat.DEFAULT, new Object[] { new String[] { null, null } }); + final Object b = method.invoke(CSVFormat.DEFAULT, new Object[] { new String[] { "f", "g" } }); + assertNotEqualsHash(name, type, a, b); + break; + } + case "org.apache.commons.csv.QuoteMode": { + final Object a = method.invoke(CSVFormat.DEFAULT, QuoteMode.MINIMAL); + final Object b = method.invoke(CSVFormat.DEFAULT, QuoteMode.ALL); + assertNotEqualsHash(name, type, a, b); + break; + } + case "org.apache.commons.csv.DuplicateHeaderMode": { + final Object a = method.invoke(CSVFormat.DEFAULT, DuplicateHeaderMode.ALLOW_ALL); + final Object b = method.invoke(CSVFormat.DEFAULT, DuplicateHeaderMode.DISALLOW); + assertNotEqualsHash(name, type, a, b); + break; + } + case "java.lang.Object[]": { + final Object a = method.invoke(CSVFormat.DEFAULT, new Object[] { new Object[] { null, null } }); + final Object b = method.invoke(CSVFormat.DEFAULT, new Object[] { new Object[] { new Object(), new Object() } }); + assertNotEqualsHash(name, type, a, b); + break; + } + default: + if ("withHeader".equals(name)) { // covered above by String[] + // ignored + } else { + fail("Unhandled method: " + name + "(" + type + ")"); + } + break; + } + } + } + } + } + } + + @Test + void testEqualsHeader() { + final CSVFormat right = CSVFormat.newFormat('\'').builder().setRecordSeparator(CR).setCommentMarker('#').setEscape('+').setHeader("One", "Two", "Three") + .setIgnoreEmptyLines(true).setIgnoreSurroundingSpaces(true).setQuote('"').setQuoteMode(QuoteMode.ALL).get(); + final CSVFormat left = right.builder().setHeader("Three", "Two", "One").get(); + + assertNotEqualsFlip(right, left); + } + + @SuppressWarnings("deprecation") + @Test + void testEqualsHeader_Deprecated() { + final CSVFormat right = CSVFormat.newFormat('\'').withRecordSeparator(CR).withCommentMarker('#').withEscape('+').withHeader("One", "Two", "Three") + .withIgnoreEmptyLines().withIgnoreSurroundingSpaces().withQuote('"').withQuoteMode(QuoteMode.ALL); + final CSVFormat left = right.withHeader("Three", "Two", "One"); + + assertNotEqualsFlip(right, left); + } + + @Test + void testEqualsIgnoreEmptyLines() { + final CSVFormat right = CSVFormat.newFormat('\'').builder().setCommentMarker('#').setEscape('+').setIgnoreEmptyLines(true) + .setIgnoreSurroundingSpaces(true).setQuote('"').setQuoteMode(QuoteMode.ALL).get(); + final CSVFormat left = right.builder().setIgnoreEmptyLines(false).get(); + + assertNotEqualsFlip(right, left); + } + + @SuppressWarnings("deprecation") + @Test + void testEqualsIgnoreEmptyLines_Deprecated() { + final CSVFormat right = CSVFormat.newFormat('\'').withCommentMarker('#').withEscape('+').withIgnoreEmptyLines().withIgnoreSurroundingSpaces() + .withQuote('"').withQuoteMode(QuoteMode.ALL); + final CSVFormat left = right.withIgnoreEmptyLines(false); + + assertNotEqualsFlip(right, left); + } + + @Test + void testEqualsIgnoreSurroundingSpaces() { + final CSVFormat right = CSVFormat.newFormat('\'').builder().setCommentMarker('#').setEscape('+').setIgnoreSurroundingSpaces(true).setQuote('"') + .setQuoteMode(QuoteMode.ALL).get(); + final CSVFormat left = right.builder().setIgnoreSurroundingSpaces(false).get(); + + assertNotEqualsFlip(right, left); + } + + @SuppressWarnings("deprecation") + @Test + void testEqualsIgnoreSurroundingSpaces_Deprecated() { + final CSVFormat right = CSVFormat.newFormat('\'').withCommentMarker('#').withEscape('+').withIgnoreSurroundingSpaces().withQuote('"') + .withQuoteMode(QuoteMode.ALL); + final CSVFormat left = right.withIgnoreSurroundingSpaces(false); + + assertNotEqualsFlip(right, left); + } + + @Test + void testEqualsLeftNoQuoteRightQuote() { + final CSVFormat left = CSVFormat.newFormat(',').builder().setQuote(null).get(); + final CSVFormat right = left.builder().setQuote('#').get(); + + assertNotEqualsFlip(left, right); + } + + @SuppressWarnings("deprecation") + @Test + void testEqualsLeftNoQuoteRightQuote_Deprecated() { + final CSVFormat left = CSVFormat.newFormat(',').withQuote(null); + final CSVFormat right = left.withQuote('#'); + + assertNotEqualsFlip(left, right); + } + + @Test + void testEqualsMaxRows() { + final CSVFormat right = CSVFormat.DEFAULT.builder().setMaxRows(10).get(); + final CSVFormat left = CSVFormat.DEFAULT.builder().setMaxRows(1000).get(); + assertNotEqualsFlip(right, left); + assertNotEquals(right.hashCode(), left.hashCode()); + } + + @Test + void testEqualsNoQuotes() { + final CSVFormat left = CSVFormat.newFormat(',').builder().setQuote(null).get(); + final CSVFormat right = left.builder().setQuote(null).get(); + + assertEquals(left, right); + } + + @SuppressWarnings("deprecation") + @Test + void testEqualsNoQuotes_Deprecated() { + final CSVFormat left = CSVFormat.newFormat(',').withQuote(null); + final CSVFormat right = left.withQuote(null); + + assertEquals(left, right); + } + + @Test + void testEqualsNullString() { + final CSVFormat right = CSVFormat.newFormat('\'').builder().setRecordSeparator(CR).setCommentMarker('#').setEscape('+').setIgnoreEmptyLines(true) + .setIgnoreSurroundingSpaces(true).setQuote('"').setQuoteMode(QuoteMode.ALL).setNullString("null").get(); + final CSVFormat left = right.builder().setNullString("---").get(); + + assertNotEqualsFlip(right, left); + } + + @SuppressWarnings("deprecation") + @Test + void testEqualsNullString_Deprecated() { + final CSVFormat right = CSVFormat.newFormat('\'').withRecordSeparator(CR).withCommentMarker('#').withEscape('+').withIgnoreEmptyLines() + .withIgnoreSurroundingSpaces().withQuote('"').withQuoteMode(QuoteMode.ALL).withNullString("null"); + final CSVFormat left = right.withNullString("---"); + + assertNotEqualsFlip(right, left); + } + + @Test + void testEqualsOne() { + + final CSVFormat csvFormatOne = CSVFormat.INFORMIX_UNLOAD; + final CSVFormat csvFormatTwo = CSVFormat.MYSQL; + + assertEquals('\\', (char) csvFormatOne.getEscapeCharacter()); + assertEquals('\\', csvFormatOne.getEscapeChar()); + assertNull(csvFormatOne.getQuoteMode()); + + assertTrue(csvFormatOne.getIgnoreEmptyLines()); + assertFalse(csvFormatOne.getSkipHeaderRecord()); + + assertFalse(csvFormatOne.getIgnoreHeaderCase()); + assertNull(csvFormatOne.getCommentMarker()); + + assertFalse(csvFormatOne.isCommentMarkerSet()); + assertTrue(csvFormatOne.isQuoteCharacterSet()); + + assertEquals('|', csvFormatOne.getDelimiter()); + assertFalse(csvFormatOne.getAllowMissingColumnNames()); + + assertTrue(csvFormatOne.isEscapeCharacterSet()); + assertEquals("\n", csvFormatOne.getRecordSeparator()); + + assertEquals('\"', (char) csvFormatOne.getQuoteCharacter()); + assertFalse(csvFormatOne.getTrailingDelimiter()); + + assertFalse(csvFormatOne.getTrim()); + assertFalse(csvFormatOne.isNullStringSet()); + + assertNull(csvFormatOne.getNullString()); + assertFalse(csvFormatOne.getIgnoreSurroundingSpaces()); + + assertTrue(csvFormatTwo.isEscapeCharacterSet()); + assertNull(csvFormatTwo.getQuoteCharacter()); + + assertFalse(csvFormatTwo.getAllowMissingColumnNames()); + assertEquals(QuoteMode.ALL_NON_NULL, csvFormatTwo.getQuoteMode()); + + assertEquals('\t', csvFormatTwo.getDelimiter()); + assertArrayEquals(new char[] { '\t' }, csvFormatTwo.getDelimiterCharArray()); + assertEquals("\t", csvFormatTwo.getDelimiterString()); + assertEquals("\n", csvFormatTwo.getRecordSeparator()); + + assertFalse(csvFormatTwo.isQuoteCharacterSet()); + assertTrue(csvFormatTwo.isNullStringSet()); + + assertEquals('\\', (char) csvFormatTwo.getEscapeCharacter()); + assertFalse(csvFormatTwo.getIgnoreHeaderCase()); + + assertFalse(csvFormatTwo.getTrim()); + assertFalse(csvFormatTwo.getIgnoreEmptyLines()); + + assertEquals("\\N", csvFormatTwo.getNullString()); + assertFalse(csvFormatTwo.getIgnoreSurroundingSpaces()); + + assertFalse(csvFormatTwo.getTrailingDelimiter()); + assertFalse(csvFormatTwo.getSkipHeaderRecord()); + + assertNull(csvFormatTwo.getCommentMarker()); + assertFalse(csvFormatTwo.isCommentMarkerSet()); + + assertNotSame(csvFormatTwo, csvFormatOne); + assertNotEquals(csvFormatTwo, csvFormatOne); + + assertEquals('\\', (char) csvFormatOne.getEscapeCharacter()); + assertNull(csvFormatOne.getQuoteMode()); + + assertTrue(csvFormatOne.getIgnoreEmptyLines()); + assertFalse(csvFormatOne.getSkipHeaderRecord()); + + assertFalse(csvFormatOne.getIgnoreHeaderCase()); + assertNull(csvFormatOne.getCommentMarker()); + + assertFalse(csvFormatOne.isCommentMarkerSet()); + assertTrue(csvFormatOne.isQuoteCharacterSet()); + + assertEquals('|', csvFormatOne.getDelimiter()); + assertFalse(csvFormatOne.getAllowMissingColumnNames()); + + assertTrue(csvFormatOne.isEscapeCharacterSet()); + assertEquals("\n", csvFormatOne.getRecordSeparator()); + + assertEquals('\"', (char) csvFormatOne.getQuoteCharacter()); + assertFalse(csvFormatOne.getTrailingDelimiter()); + + assertFalse(csvFormatOne.getTrim()); + assertFalse(csvFormatOne.isNullStringSet()); + + assertNull(csvFormatOne.getNullString()); + assertFalse(csvFormatOne.getIgnoreSurroundingSpaces()); + + assertTrue(csvFormatTwo.isEscapeCharacterSet()); + assertNull(csvFormatTwo.getQuoteCharacter()); + + assertFalse(csvFormatTwo.getAllowMissingColumnNames()); + assertEquals(QuoteMode.ALL_NON_NULL, csvFormatTwo.getQuoteMode()); + + assertEquals('\t', csvFormatTwo.getDelimiter()); + assertEquals("\n", csvFormatTwo.getRecordSeparator()); + + assertFalse(csvFormatTwo.isQuoteCharacterSet()); + assertTrue(csvFormatTwo.isNullStringSet()); + + assertEquals('\\', (char) csvFormatTwo.getEscapeCharacter()); + assertFalse(csvFormatTwo.getIgnoreHeaderCase()); + + assertFalse(csvFormatTwo.getTrim()); + assertFalse(csvFormatTwo.getIgnoreEmptyLines()); + + assertEquals("\\N", csvFormatTwo.getNullString()); + assertFalse(csvFormatTwo.getIgnoreSurroundingSpaces()); + + assertFalse(csvFormatTwo.getTrailingDelimiter()); + assertFalse(csvFormatTwo.getSkipHeaderRecord()); + + assertNull(csvFormatTwo.getCommentMarker()); + assertFalse(csvFormatTwo.isCommentMarkerSet()); + + assertNotSame(csvFormatOne, csvFormatTwo); + assertNotSame(csvFormatTwo, csvFormatOne); + + assertNotEquals(csvFormatOne, csvFormatTwo); + assertNotEquals(csvFormatTwo, csvFormatOne); + + assertNotEquals(csvFormatTwo, csvFormatOne); + + } + + @Test + void testEqualsQuoteChar() { + final CSVFormat right = CSVFormat.newFormat('\'').builder().setQuote('"').get(); + final CSVFormat left = right.builder().setQuote('!').get(); + + assertNotEqualsFlip(right, left); + } + + @SuppressWarnings("deprecation") + @Test + void testEqualsQuoteChar_Deprecated() { + final CSVFormat right = CSVFormat.newFormat('\'').withQuote('"'); + final CSVFormat left = right.withQuote('!'); + + assertNotEqualsFlip(right, left); + } + + @Test + void testEqualsQuotePolicy() { + final CSVFormat right = CSVFormat.newFormat('\'').builder().setQuote('"').setQuoteMode(QuoteMode.ALL).get(); + final CSVFormat left = right.builder().setQuoteMode(QuoteMode.MINIMAL).get(); + + assertNotEqualsFlip(right, left); + } + + @SuppressWarnings("deprecation") + @Test + void testEqualsQuotePolicy_Deprecated() { + final CSVFormat right = CSVFormat.newFormat('\'').withQuote('"').withQuoteMode(QuoteMode.ALL); + final CSVFormat left = right.withQuoteMode(QuoteMode.MINIMAL); + + assertNotEqualsFlip(right, left); + } + + @Test + void testEqualsRecordSeparator() { + final CSVFormat right = CSVFormat.newFormat('\'').builder().setRecordSeparator(CR).setCommentMarker('#').setEscape('+').setIgnoreEmptyLines(true) + .setIgnoreSurroundingSpaces(true).setQuote('"').setQuoteMode(QuoteMode.ALL).get(); + final CSVFormat left = right.builder().setRecordSeparator(LF).get(); + + assertNotEqualsFlip(right, left); + } + + @SuppressWarnings("deprecation") + @Test + void testEqualsRecordSeparator_Deprecated() { + final CSVFormat right = CSVFormat.newFormat('\'').withRecordSeparator(CR).withCommentMarker('#').withEscape('+').withIgnoreEmptyLines() + .withIgnoreSurroundingSpaces().withQuote('"').withQuoteMode(QuoteMode.ALL); + final CSVFormat left = right.withRecordSeparator(LF); + + assertNotEqualsFlip(right, left); + } + + void testEqualsSkipHeaderRecord() { + final CSVFormat right = CSVFormat.newFormat('\'').builder().setRecordSeparator(CR).setCommentMarker('#').setEscape('+').setIgnoreEmptyLines(true) + .setIgnoreSurroundingSpaces(true).setQuote('"').setQuoteMode(QuoteMode.ALL).setNullString("null").setSkipHeaderRecord(true).get(); + final CSVFormat left = right.builder().setSkipHeaderRecord(false).get(); + + assertNotEqualsFlip(right, left); + } + + @SuppressWarnings("deprecation") + @Test + void testEqualsSkipHeaderRecord_Deprecated() { + final CSVFormat right = CSVFormat.newFormat('\'').withRecordSeparator(CR).withCommentMarker('#').withEscape('+').withIgnoreEmptyLines() + .withIgnoreSurroundingSpaces().withQuote('"').withQuoteMode(QuoteMode.ALL).withNullString("null").withSkipHeaderRecord(); + final CSVFormat left = right.withSkipHeaderRecord(false); + + assertNotEqualsFlip(right, left); + } + + @Test + void testEqualsWithNull() { + + final CSVFormat csvFormat = CSVFormat.POSTGRESQL_TEXT; + + assertEquals('\\', (char) csvFormat.getEscapeCharacter()); + assertFalse(csvFormat.getIgnoreSurroundingSpaces()); + + assertFalse(csvFormat.getTrailingDelimiter()); + assertFalse(csvFormat.getTrim()); + + assertFalse(csvFormat.isQuoteCharacterSet()); + assertEquals("\\N", csvFormat.getNullString()); + + assertFalse(csvFormat.getIgnoreHeaderCase()); + assertTrue(csvFormat.isEscapeCharacterSet()); + + assertFalse(csvFormat.isCommentMarkerSet()); + assertNull(csvFormat.getCommentMarker()); + + assertFalse(csvFormat.getAllowMissingColumnNames()); + assertEquals(QuoteMode.ALL_NON_NULL, csvFormat.getQuoteMode()); + + assertEquals('\t', csvFormat.getDelimiter()); + assertFalse(csvFormat.getSkipHeaderRecord()); + + assertEquals("\n", csvFormat.getRecordSeparator()); + assertFalse(csvFormat.getIgnoreEmptyLines()); + + assertNull(csvFormat.getQuoteCharacter()); + assertTrue(csvFormat.isNullStringSet()); + + assertEquals('\\', (char) csvFormat.getEscapeCharacter()); + assertFalse(csvFormat.getIgnoreSurroundingSpaces()); + + assertFalse(csvFormat.getTrailingDelimiter()); + assertFalse(csvFormat.getTrim()); + + assertFalse(csvFormat.isQuoteCharacterSet()); + assertEquals("\\N", csvFormat.getNullString()); + + assertFalse(csvFormat.getIgnoreHeaderCase()); + assertTrue(csvFormat.isEscapeCharacterSet()); + + assertFalse(csvFormat.isCommentMarkerSet()); + assertNull(csvFormat.getCommentMarker()); + + assertFalse(csvFormat.getAllowMissingColumnNames()); + assertEquals(QuoteMode.ALL_NON_NULL, csvFormat.getQuoteMode()); + + assertEquals('\t', csvFormat.getDelimiter()); + assertFalse(csvFormat.getSkipHeaderRecord()); + + assertEquals("\n", csvFormat.getRecordSeparator()); + assertFalse(csvFormat.getIgnoreEmptyLines()); + + assertNull(csvFormat.getQuoteCharacter()); + assertTrue(csvFormat.isNullStringSet()); + + assertNotEquals(null, csvFormat); + + } + + @Test + void testEscapeSameAsCommentStartThrowsException() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setEscape('!').setCommentMarker('!').get()); + } + + @SuppressWarnings("deprecation") + @Test + void testEscapeSameAsCommentStartThrowsException_Deprecated() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withEscape('!').withCommentMarker('!')); + } + + @Test + void testEscapeSameAsCommentStartThrowsExceptionForWrapperType() { + // Cannot assume that callers won't use different Character objects + assertThrows(IllegalArgumentException.class, + () -> CSVFormat.DEFAULT.builder().setEscape(Character.valueOf('!')).setCommentMarker(Character.valueOf('!')).get()); + } + + @SuppressWarnings("deprecation") + @Test + void testEscapeSameAsCommentStartThrowsExceptionForWrapperType_Deprecated() { + // Cannot assume that callers won't use different Character objects + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withEscape(Character.valueOf('!')).withCommentMarker(Character.valueOf('!'))); + } + + @Test + void testFormat() { + final CSVFormat format = CSVFormat.DEFAULT; + + assertEquals("", format.format()); + assertEquals("a,b,c", format.format("a", "b", "c")); + assertEquals("\"x,y\",z", format.format("x,y", "z")); + } + + @Test // I assume this to be a defect. + void testFormatThrowsNullPointerException() { + + final CSVFormat csvFormat = CSVFormat.MYSQL; + + final NullPointerException e = assertThrows(NullPointerException.class, () -> csvFormat.format((Object[]) null)); + assertEquals(Objects.class.getName(), e.getStackTrace()[0].getClassName()); + } + + @Test + void testFormatToString() { + // @formatter:off + final CSVFormat format = CSVFormat.RFC4180 + .withEscape('?') + .withDelimiter(',') + .withQuoteMode(QuoteMode.MINIMAL) + .withRecordSeparator(CRLF) + .withQuote('"') + .withNullString("") + .withIgnoreHeaderCase(true) + .withHeaderComments("This is HeaderComments") + .withHeader("col1", "col2", "col3"); + // @formatter:on + assertEquals( + "Delimiter=<,> Escape= QuoteChar=<\"> QuoteMode= NullString=<> RecordSeparator=<" + CRLF + + "> IgnoreHeaderCase:ignored SkipHeaderRecord:false HeaderComments:[This is HeaderComments] Header:[col1, col2, col3]", + format.toString()); + } + + @Test + void testGetAllowDuplicateHeaderNames() { + final Builder builder = CSVFormat.DEFAULT.builder(); + assertTrue(builder.get().getAllowDuplicateHeaderNames()); + assertTrue(builder.setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_ALL).get().getAllowDuplicateHeaderNames()); + assertFalse(builder.setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_EMPTY).get().getAllowDuplicateHeaderNames()); + assertFalse(builder.setDuplicateHeaderMode(DuplicateHeaderMode.DISALLOW).get().getAllowDuplicateHeaderNames()); + } + + @Test + void testGetDuplicateHeaderMode() { + final Builder builder = CSVFormat.DEFAULT.builder(); + + assertEquals(DuplicateHeaderMode.ALLOW_ALL, builder.get().getDuplicateHeaderMode()); + assertEquals(DuplicateHeaderMode.ALLOW_ALL, builder.setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_ALL).get().getDuplicateHeaderMode()); + assertEquals(DuplicateHeaderMode.ALLOW_EMPTY, builder.setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_EMPTY).get().getDuplicateHeaderMode()); + assertEquals(DuplicateHeaderMode.DISALLOW, builder.setDuplicateHeaderMode(DuplicateHeaderMode.DISALLOW).get().getDuplicateHeaderMode()); + } + + @Test + void testGetHeader() { + final String[] header = { "one", "two", "three" }; + final CSVFormat formatWithHeader = CSVFormat.DEFAULT.withHeader(header); + // getHeader() makes a copy of the header array. + final String[] headerCopy = formatWithHeader.getHeader(); + headerCopy[0] = "A"; + headerCopy[1] = "B"; + headerCopy[2] = "C"; + assertFalse(Arrays.equals(formatWithHeader.getHeader(), headerCopy)); + assertNotSame(formatWithHeader.getHeader(), headerCopy); + } + + @Test + void testHashCodeAndWithIgnoreHeaderCase() { + + final CSVFormat csvFormat = CSVFormat.INFORMIX_UNLOAD_CSV; + final CSVFormat csvFormatTwo = csvFormat.withIgnoreHeaderCase(); + csvFormatTwo.hashCode(); + + assertFalse(csvFormat.getIgnoreHeaderCase()); + assertTrue(csvFormatTwo.getIgnoreHeaderCase()); // now different + assertFalse(csvFormatTwo.getTrailingDelimiter()); + + assertNotEquals(csvFormatTwo, csvFormat); // CSV-244 - should not be equal + assertFalse(csvFormatTwo.getAllowMissingColumnNames()); + + assertFalse(csvFormatTwo.getTrim()); + + } + + @Test + void testJiraCsv236() { + CSVFormat.DEFAULT.builder().setAllowDuplicateHeaderNames(true).setHeader("CC", "VV", "VV").get(); + } + + @SuppressWarnings("deprecation") + @Test + void testJiraCsv236__Deprecated() { + CSVFormat.DEFAULT.withAllowDuplicateHeaderNames().withHeader("CC", "VV", "VV"); + } + + @Test + void testNewFormat() { + + final CSVFormat csvFormat = CSVFormat.newFormat('X'); + + assertFalse(csvFormat.getSkipHeaderRecord()); + assertFalse(csvFormat.isEscapeCharacterSet()); + + assertNull(csvFormat.getRecordSeparator()); + assertNull(csvFormat.getQuoteMode()); + + assertNull(csvFormat.getCommentMarker()); + assertFalse(csvFormat.getIgnoreHeaderCase()); + + assertFalse(csvFormat.getAllowMissingColumnNames()); + assertFalse(csvFormat.getTrim()); + + assertFalse(csvFormat.isNullStringSet()); + assertNull(csvFormat.getEscapeCharacter()); + + assertFalse(csvFormat.getIgnoreSurroundingSpaces()); + assertFalse(csvFormat.getTrailingDelimiter()); + + assertEquals('X', csvFormat.getDelimiter()); + assertNull(csvFormat.getNullString()); + + assertFalse(csvFormat.isQuoteCharacterSet()); + assertFalse(csvFormat.isCommentMarkerSet()); + + assertNull(csvFormat.getQuoteCharacter()); + assertFalse(csvFormat.getIgnoreEmptyLines()); + + assertFalse(csvFormat.getSkipHeaderRecord()); + assertFalse(csvFormat.isEscapeCharacterSet()); + + assertNull(csvFormat.getRecordSeparator()); + assertNull(csvFormat.getQuoteMode()); + + assertNull(csvFormat.getCommentMarker()); + assertFalse(csvFormat.getIgnoreHeaderCase()); + + assertFalse(csvFormat.getAllowMissingColumnNames()); + assertFalse(csvFormat.getTrim()); + + assertFalse(csvFormat.isNullStringSet()); + assertNull(csvFormat.getEscapeCharacter()); + + assertFalse(csvFormat.getIgnoreSurroundingSpaces()); + assertFalse(csvFormat.getTrailingDelimiter()); + + assertEquals('X', csvFormat.getDelimiter()); + assertNull(csvFormat.getNullString()); + + assertFalse(csvFormat.isQuoteCharacterSet()); + assertFalse(csvFormat.isCommentMarkerSet()); + + assertNull(csvFormat.getQuoteCharacter()); + assertFalse(csvFormat.getIgnoreEmptyLines()); + + } + + @Test + void testNullRecordSeparatorCsv106() { + final CSVFormat format = CSVFormat.newFormat(';').builder().setSkipHeaderRecord(true).setHeader("H1", "H2").get(); + final String formatStr = format.format("A", "B"); + assertNotNull(formatStr); + assertFalse(formatStr.endsWith("null")); + } + + @SuppressWarnings("deprecation") + @Test + void testNullRecordSeparatorCsv106__Deprecated() { + final CSVFormat format = CSVFormat.newFormat(';').withSkipHeaderRecord().withHeader("H1", "H2"); + final String formatStr = format.format("A", "B"); + assertNotNull(formatStr); + assertFalse(formatStr.endsWith("null")); + } + + @Test + void testPrintRecord() throws IOException { + final Appendable out = new StringBuilder(); + final CSVFormat format = CSVFormat.RFC4180; + format.printRecord(out, "a", "b", "c"); + assertEquals("a,b,c" + format.getRecordSeparator(), out.toString()); + } + + @Test + void testPrintRecordEmpty() throws IOException { + final Appendable out = new StringBuilder(); + final CSVFormat format = CSVFormat.RFC4180; + format.printRecord(out); + assertEquals(format.getRecordSeparator(), out.toString()); + } + + @Test + void testPrintWithEscapesEndWithCRLF() throws IOException { + final Reader in = new StringReader("x,y,x\r\na,?b,c\r\n"); + final Appendable out = new StringBuilder(); + final CSVFormat format = CSVFormat.RFC4180.withEscape('?').withDelimiter(',').withQuote(null).withRecordSeparator(CRLF); + format.print(in, out, true); + assertEquals("x?,y?,x?r?na?,??b?,c?r?n", out.toString()); + } + + @Test + void testPrintWithEscapesEndWithoutCRLF() throws IOException { + final Reader in = new StringReader("x,y,x"); + final Appendable out = new StringBuilder(); + final CSVFormat format = CSVFormat.RFC4180.withEscape('?').withDelimiter(',').withQuote(null).withRecordSeparator(CRLF); + format.print(in, out, true); + assertEquals("x?,y?,x", out.toString()); + } + + @Test + void testPrintWithoutQuotes() throws IOException { + final Reader in = new StringReader(""); + final Appendable out = new StringBuilder(); + final CSVFormat format = CSVFormat.RFC4180.withDelimiter(',').withQuote('"').withEscape('?').withQuoteMode(QuoteMode.NON_NUMERIC); + format.print(in, out, true); + assertEquals("\"\"", out.toString()); + } + + @Test + void testPrintWithQuoteModeIsNONE() throws IOException { + final Reader in = new StringReader("a,b,c"); + final Appendable out = new StringBuilder(); + final CSVFormat format = CSVFormat.RFC4180.withDelimiter(',').withQuote('"').withEscape('?').withQuoteMode(QuoteMode.NONE); + format.print(in, out, true); + assertEquals("a?,b?,c", out.toString()); + } + + @Test + void testPrintWithQuotes() throws IOException { + final Reader in = new StringReader("\"a,b,c\r\nx,y,z"); + final Appendable out = new StringBuilder(); + final CSVFormat format = CSVFormat.RFC4180.withDelimiter(',').withQuote('"').withEscape('?').withQuoteMode(QuoteMode.NON_NUMERIC); + format.print(in, out, true); + assertEquals("\"\"\"a,b,c\r\nx,y,z\"", out.toString()); + } + + /** + * Tests CSV-326. + */ + @Test + void testPrintWithQuotesEscapeBeforeQuote() throws IOException { + final CSVFormat format = CSVFormat.DEFAULT.builder() + .setEscape('\\') + .setQuote('"') + .get(); + final String value = "\\\""; + final Appendable out = new StringBuilder(); + format.print(new StringReader(value), out, true); + try (CSVParser parser = CSVParser.parse(out.toString(), format)) { + assertEquals(value, parser.getRecords().get(0).get(0)); + } + } + + @Test + void testQuoteCharSameAsCommentStartThrowsException() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setQuote('!').setCommentMarker('!').get()); + } + + @SuppressWarnings("deprecation") + @Test + void testQuoteCharSameAsCommentStartThrowsException_Deprecated() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withQuote('!').withCommentMarker('!')); + } + + @Test + void testQuoteCharSameAsCommentStartThrowsExceptionForWrapperType() { + // Cannot assume that callers won't use different Character objects + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setQuote(Character.valueOf('!')).setCommentMarker('!').get()); + } + + @SuppressWarnings("deprecation") + @Test + void testQuoteCharSameAsCommentStartThrowsExceptionForWrapperType_Deprecated() { + // Cannot assume that callers won't use different Character objects + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withQuote(Character.valueOf('!')).withCommentMarker('!')); + } + + @Test + void testQuoteCharSameAsDelimiterThrowsException() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.builder().setQuote('!').setDelimiter('!').get()); + } + + @SuppressWarnings("deprecation") + @Test + void testQuoteCharSameAsDelimiterThrowsException_Deprecated() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withQuote('!').withDelimiter('!')); + } + + @Test + void testQuotedNullStringTracksQuoteCharacter() throws IOException { + final StringBuilder out = new StringBuilder(); + // @formatter:off + final Builder builder = CSVFormat.DEFAULT.builder(); + final CSVFormat format = builder + .setQuoteMode(QuoteMode.ALL) + .setNullString("NULL") + .get(); + // @formatter:on + format.print(null, out, true); + assertEquals("\"NULL\"", out.toString()); + // set + out.setLength(0); + builder.setQuote('\''); + builder.get().print(null, out, true); + assertEquals("'NULL'", out.toString()); + // reset + out.setLength(0); + builder.setQuote((Character) null); + builder.get().print(null, out, true); + assertEquals("\"NULL\"", out.toString()); + // reset, reverse setter order + out.setLength(0); + builder.setNullString(null).setQuote((Character) null).setNullString("NULL"); + builder.get().print(null, out, true); + assertEquals("\"NULL\"", out.toString()); + } + + @Test + void testQuoteModeNoneShouldReturnMeaningfulExceptionMessage() { + final Exception exception = assertThrows(IllegalArgumentException.class, () -> + // @formatter:off + CSVFormat.DEFAULT.builder() + .setHeader("Col1", "Col2", "Col3", "Col4") + .setQuoteMode(QuoteMode.NONE) + .get() + // @formatter:on + ); + final String actualMessage = exception.getMessage(); + final String expectedMessage = "Quote mode set to NONE but no escape character is set"; + assertEquals(expectedMessage, actualMessage); + } + + @Test + void testQuotePolicyNoneWithoutEscapeThrowsException() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.newFormat('!').builder().setQuoteMode(QuoteMode.NONE).get()); + } + + @SuppressWarnings("deprecation") + @Test + void testQuotePolicyNoneWithoutEscapeThrowsException_Deprecated() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.newFormat('!').withQuoteMode(QuoteMode.NONE)); + } + + @Test + void testRFC4180() { + assertNull(RFC4180.getCommentMarker()); + assertEquals(',', RFC4180.getDelimiter()); + assertNull(RFC4180.getEscapeCharacter()); + assertFalse(RFC4180.getIgnoreEmptyLines()); + assertEquals(Character.valueOf('"'), RFC4180.getQuoteCharacter()); + assertNull(RFC4180.getQuoteMode()); + assertEquals("\r\n", RFC4180.getRecordSeparator()); + } + + @SuppressWarnings("boxing") // no need to worry about boxing here + @Test + void testSerialization() throws Exception { + final ByteArrayOutputStream out = new ByteArrayOutputStream(); + + try (ObjectOutputStream oos = new ObjectOutputStream(out)) { + oos.writeObject(CSVFormat.DEFAULT); + oos.flush(); + } + + final ObjectInputStream in = new ObjectInputStream(new ByteArrayInputStream(out.toByteArray())); + final CSVFormat format = (CSVFormat) in.readObject(); + + assertNotNull(format); + assertEquals(CSVFormat.DEFAULT.getDelimiter(), format.getDelimiter(), "delimiter"); + assertEquals(CSVFormat.DEFAULT.getQuoteCharacter(), format.getQuoteCharacter(), "encapsulator"); + assertEquals(CSVFormat.DEFAULT.getCommentMarker(), format.getCommentMarker(), "comment start"); + assertEquals(CSVFormat.DEFAULT.getRecordSeparator(), format.getRecordSeparator(), "record separator"); + assertEquals(CSVFormat.DEFAULT.getEscapeCharacter(), format.getEscapeCharacter(), "escape"); + assertEquals(CSVFormat.DEFAULT.getIgnoreSurroundingSpaces(), format.getIgnoreSurroundingSpaces(), "trim"); + assertEquals(CSVFormat.DEFAULT.getIgnoreEmptyLines(), format.getIgnoreEmptyLines(), "empty lines"); + } + + @Test + void testToString() { + + final String string = CSVFormat.INFORMIX_UNLOAD.toString(); + + assertEquals("Delimiter=<|> Escape=<\\> QuoteChar=<\"> RecordSeparator=<\n> EmptyLines:ignored SkipHeaderRecord:false", string); + + } + + @Test + void testToStringAndWithCommentMarkerTakingCharacter() { + + final CSVFormat.Predefined csvFormatPredefined = CSVFormat.Predefined.Default; + final CSVFormat csvFormat = csvFormatPredefined.getFormat(); + + assertNull(csvFormat.getEscapeCharacter()); + assertTrue(csvFormat.isQuoteCharacterSet()); + + assertFalse(csvFormat.getTrim()); + assertFalse(csvFormat.getIgnoreSurroundingSpaces()); + + assertFalse(csvFormat.getTrailingDelimiter()); + assertEquals(',', csvFormat.getDelimiter()); + + assertFalse(csvFormat.getIgnoreHeaderCase()); + assertEquals("\r\n", csvFormat.getRecordSeparator()); + + assertFalse(csvFormat.isCommentMarkerSet()); + assertNull(csvFormat.getCommentMarker()); + + assertFalse(csvFormat.isNullStringSet()); + assertFalse(csvFormat.getAllowMissingColumnNames()); + + assertFalse(csvFormat.isEscapeCharacterSet()); + assertFalse(csvFormat.getSkipHeaderRecord()); + + assertNull(csvFormat.getNullString()); + assertNull(csvFormat.getQuoteMode()); + + assertTrue(csvFormat.getIgnoreEmptyLines()); + assertEquals('\"', (char) csvFormat.getQuoteCharacter()); + + final Character character = Character.valueOf('n'); + + final CSVFormat csvFormatTwo = csvFormat.withCommentMarker(character); + + assertNull(csvFormat.getEscapeCharacter()); + assertTrue(csvFormat.isQuoteCharacterSet()); + + assertFalse(csvFormat.getTrim()); + assertFalse(csvFormat.getIgnoreSurroundingSpaces()); + + assertFalse(csvFormat.getTrailingDelimiter()); + assertEquals(',', csvFormat.getDelimiter()); + + assertFalse(csvFormat.getIgnoreHeaderCase()); + assertEquals("\r\n", csvFormat.getRecordSeparator()); + + assertFalse(csvFormat.isCommentMarkerSet()); + assertNull(csvFormat.getCommentMarker()); + + assertFalse(csvFormat.isNullStringSet()); + assertFalse(csvFormat.getAllowMissingColumnNames()); + + assertFalse(csvFormat.isEscapeCharacterSet()); + assertFalse(csvFormat.getSkipHeaderRecord()); + + assertNull(csvFormat.getNullString()); + assertNull(csvFormat.getQuoteMode()); + + assertTrue(csvFormat.getIgnoreEmptyLines()); + assertEquals('\"', (char) csvFormat.getQuoteCharacter()); + + assertFalse(csvFormatTwo.isNullStringSet()); + assertFalse(csvFormatTwo.getAllowMissingColumnNames()); + + assertEquals('\"', (char) csvFormatTwo.getQuoteCharacter()); + assertNull(csvFormatTwo.getNullString()); + + assertEquals(',', csvFormatTwo.getDelimiter()); + assertFalse(csvFormatTwo.getTrailingDelimiter()); + + assertTrue(csvFormatTwo.isCommentMarkerSet()); + assertFalse(csvFormatTwo.getIgnoreHeaderCase()); + + assertFalse(csvFormatTwo.getTrim()); + assertNull(csvFormatTwo.getEscapeCharacter()); + + assertTrue(csvFormatTwo.isQuoteCharacterSet()); + assertFalse(csvFormatTwo.getIgnoreSurroundingSpaces()); + + assertEquals("\r\n", csvFormatTwo.getRecordSeparator()); + assertNull(csvFormatTwo.getQuoteMode()); + + assertEquals('n', (char) csvFormatTwo.getCommentMarker()); + assertFalse(csvFormatTwo.getSkipHeaderRecord()); + + assertFalse(csvFormatTwo.isEscapeCharacterSet()); + assertTrue(csvFormatTwo.getIgnoreEmptyLines()); + + assertNotSame(csvFormat, csvFormatTwo); + assertNotSame(csvFormatTwo, csvFormat); + + assertNotEquals(csvFormatTwo, csvFormat); + + assertNull(csvFormat.getEscapeCharacter()); + assertTrue(csvFormat.isQuoteCharacterSet()); + + assertFalse(csvFormat.getTrim()); + assertFalse(csvFormat.getIgnoreSurroundingSpaces()); + + assertFalse(csvFormat.getTrailingDelimiter()); + assertEquals(',', csvFormat.getDelimiter()); + + assertFalse(csvFormat.getIgnoreHeaderCase()); + assertEquals("\r\n", csvFormat.getRecordSeparator()); + + assertFalse(csvFormat.isCommentMarkerSet()); + assertNull(csvFormat.getCommentMarker()); + + assertFalse(csvFormat.isNullStringSet()); + assertFalse(csvFormat.getAllowMissingColumnNames()); + + assertFalse(csvFormat.isEscapeCharacterSet()); + assertFalse(csvFormat.getSkipHeaderRecord()); + + assertNull(csvFormat.getNullString()); + assertNull(csvFormat.getQuoteMode()); + + assertTrue(csvFormat.getIgnoreEmptyLines()); + assertEquals('\"', (char) csvFormat.getQuoteCharacter()); + + assertFalse(csvFormatTwo.isNullStringSet()); + assertFalse(csvFormatTwo.getAllowMissingColumnNames()); + + assertEquals('\"', (char) csvFormatTwo.getQuoteCharacter()); + assertNull(csvFormatTwo.getNullString()); + + assertEquals(',', csvFormatTwo.getDelimiter()); + assertFalse(csvFormatTwo.getTrailingDelimiter()); + + assertTrue(csvFormatTwo.isCommentMarkerSet()); + assertFalse(csvFormatTwo.getIgnoreHeaderCase()); + + assertFalse(csvFormatTwo.getTrim()); + assertNull(csvFormatTwo.getEscapeCharacter()); + + assertTrue(csvFormatTwo.isQuoteCharacterSet()); + assertFalse(csvFormatTwo.getIgnoreSurroundingSpaces()); + + assertEquals("\r\n", csvFormatTwo.getRecordSeparator()); + assertNull(csvFormatTwo.getQuoteMode()); + + assertEquals('n', (char) csvFormatTwo.getCommentMarker()); + assertFalse(csvFormatTwo.getSkipHeaderRecord()); + + assertFalse(csvFormatTwo.isEscapeCharacterSet()); + assertTrue(csvFormatTwo.getIgnoreEmptyLines()); + + assertNotSame(csvFormat, csvFormatTwo); + assertNotSame(csvFormatTwo, csvFormat); + + assertNotEquals(csvFormat, csvFormatTwo); + + assertNotEquals(csvFormatTwo, csvFormat); + assertEquals("Delimiter=<,> QuoteChar=<\"> CommentStart= RecordSeparator=<\r\n> EmptyLines:ignored SkipHeaderRecord:false", + csvFormatTwo.toString()); + + } + + @Test + void testTrim() throws IOException { + final CSVFormat formatWithTrim = CSVFormat.DEFAULT.withDelimiter(',').withTrim().withQuote(null).withRecordSeparator(CRLF); + + CharSequence in = "a,b,c"; + final StringBuilder out = new StringBuilder(); + formatWithTrim.print(in, out, true); + assertEquals("a,b,c", out.toString()); + + in = new StringBuilder(" x,y,z"); + out.setLength(0); + formatWithTrim.print(in, out, true); + assertEquals("x,y,z", out.toString()); + + in = new StringBuilder(""); + out.setLength(0); + formatWithTrim.print(in, out, true); + assertEquals("", out.toString()); + + in = new StringBuilder("header\r\n"); + out.setLength(0); + formatWithTrim.print(in, out, true); + assertEquals("header", out.toString()); + } + + @Test + void testWithCommentStart() { + final CSVFormat formatWithCommentStart = CSVFormat.DEFAULT.withCommentMarker('#'); + assertEquals(Character.valueOf('#'), formatWithCommentStart.getCommentMarker()); + } + + @Test + void testWithCommentStartCRThrowsException() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withCommentMarker(CR)); + } + + @Test + void testWithDelimiter() { + final CSVFormat formatWithDelimiter = CSVFormat.DEFAULT.withDelimiter('!'); + assertEquals('!', formatWithDelimiter.getDelimiter()); + } + + @Test + void testWithDelimiterLFThrowsException() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withDelimiter(LF)); + } + + @Test + void testWithEmptyDuplicates() { + final CSVFormat formatWithEmptyDuplicates = CSVFormat.DEFAULT.builder().setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_EMPTY).get(); + + assertEquals(DuplicateHeaderMode.ALLOW_EMPTY, formatWithEmptyDuplicates.getDuplicateHeaderMode()); + assertFalse(formatWithEmptyDuplicates.getAllowDuplicateHeaderNames()); + } + + @Test + void testWithEmptyEnum() { + final CSVFormat formatWithHeader = CSVFormat.DEFAULT.withHeader(EmptyEnum.class); + assertEquals(0, formatWithHeader.getHeader().length); + } + + @Test + void testWithEscape() { + final CSVFormat formatWithEscape = CSVFormat.DEFAULT.withEscape('&'); + assertEquals(Character.valueOf('&'), formatWithEscape.getEscapeCharacter()); + } + + @Test + void testWithEscapeCRThrowsExceptions() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withEscape(CR)); + } + + @Test + void testWithFirstRecordAsHeader() { + final CSVFormat formatWithFirstRecordAsHeader = CSVFormat.DEFAULT.withFirstRecordAsHeader(); + assertTrue(formatWithFirstRecordAsHeader.getSkipHeaderRecord()); + assertEquals(0, formatWithFirstRecordAsHeader.getHeader().length); + } + + @Test + void testWithHeader() { + final String[] header = { "one", "two", "three" }; + // withHeader() makes a copy of the header array. + final CSVFormat formatWithHeader = CSVFormat.DEFAULT.withHeader(header); + assertArrayEquals(header, formatWithHeader.getHeader()); + assertNotSame(header, formatWithHeader.getHeader()); + } + + @Test + void testWithHeaderComments() { + + final CSVFormat csvFormat = CSVFormat.DEFAULT; + + assertEquals('\"', (char) csvFormat.getQuoteCharacter()); + assertFalse(csvFormat.isCommentMarkerSet()); + + assertFalse(csvFormat.isEscapeCharacterSet()); + assertTrue(csvFormat.isQuoteCharacterSet()); + + assertFalse(csvFormat.getSkipHeaderRecord()); + assertNull(csvFormat.getQuoteMode()); + + assertEquals(',', csvFormat.getDelimiter()); + assertTrue(csvFormat.getIgnoreEmptyLines()); + + assertFalse(csvFormat.getIgnoreHeaderCase()); + assertNull(csvFormat.getCommentMarker()); + + assertEquals("\r\n", csvFormat.getRecordSeparator()); + assertFalse(csvFormat.getTrailingDelimiter()); + + assertFalse(csvFormat.getAllowMissingColumnNames()); + assertFalse(csvFormat.getTrim()); + + assertFalse(csvFormat.isNullStringSet()); + assertNull(csvFormat.getNullString()); + + assertFalse(csvFormat.getIgnoreSurroundingSpaces()); + assertNull(csvFormat.getEscapeCharacter()); + + final Object[] objectArray = new Object[8]; + final CSVFormat csvFormatTwo = csvFormat.withHeaderComments(objectArray); + + assertEquals('\"', (char) csvFormat.getQuoteCharacter()); + assertFalse(csvFormat.isCommentMarkerSet()); + + assertFalse(csvFormat.isEscapeCharacterSet()); + assertTrue(csvFormat.isQuoteCharacterSet()); + + assertFalse(csvFormat.getSkipHeaderRecord()); + assertNull(csvFormat.getQuoteMode()); + + assertEquals(',', csvFormat.getDelimiter()); + assertTrue(csvFormat.getIgnoreEmptyLines()); + + assertFalse(csvFormat.getIgnoreHeaderCase()); + assertNull(csvFormat.getCommentMarker()); + + assertEquals("\r\n", csvFormat.getRecordSeparator()); + assertFalse(csvFormat.getTrailingDelimiter()); + + assertFalse(csvFormat.getAllowMissingColumnNames()); + assertFalse(csvFormat.getTrim()); + + assertFalse(csvFormat.isNullStringSet()); + assertNull(csvFormat.getNullString()); + + assertFalse(csvFormat.getIgnoreSurroundingSpaces()); + assertNull(csvFormat.getEscapeCharacter()); + + assertFalse(csvFormatTwo.getIgnoreHeaderCase()); + assertNull(csvFormatTwo.getQuoteMode()); + + assertTrue(csvFormatTwo.getIgnoreEmptyLines()); + assertFalse(csvFormatTwo.getIgnoreSurroundingSpaces()); + + assertNull(csvFormatTwo.getEscapeCharacter()); + assertFalse(csvFormatTwo.getTrim()); + + assertFalse(csvFormatTwo.isEscapeCharacterSet()); + assertTrue(csvFormatTwo.isQuoteCharacterSet()); + + assertFalse(csvFormatTwo.getSkipHeaderRecord()); + assertEquals('\"', (char) csvFormatTwo.getQuoteCharacter()); + + assertFalse(csvFormatTwo.getAllowMissingColumnNames()); + assertNull(csvFormatTwo.getNullString()); + + assertFalse(csvFormatTwo.isNullStringSet()); + assertFalse(csvFormatTwo.getTrailingDelimiter()); + + assertEquals("\r\n", csvFormatTwo.getRecordSeparator()); + assertEquals(',', csvFormatTwo.getDelimiter()); + + assertNull(csvFormatTwo.getCommentMarker()); + assertFalse(csvFormatTwo.isCommentMarkerSet()); + + assertNotSame(csvFormat, csvFormatTwo); + assertNotSame(csvFormatTwo, csvFormat); + + assertNotEquals(csvFormatTwo, csvFormat); // CSV-244 - should not be equal + + final String string = csvFormatTwo.format(objectArray); + + assertEquals('\"', (char) csvFormat.getQuoteCharacter()); + assertFalse(csvFormat.isCommentMarkerSet()); + + assertFalse(csvFormat.isEscapeCharacterSet()); + assertTrue(csvFormat.isQuoteCharacterSet()); + + assertFalse(csvFormat.getSkipHeaderRecord()); + assertNull(csvFormat.getQuoteMode()); + + assertEquals(',', csvFormat.getDelimiter()); + assertTrue(csvFormat.getIgnoreEmptyLines()); + + assertFalse(csvFormat.getIgnoreHeaderCase()); + assertNull(csvFormat.getCommentMarker()); + + assertEquals("\r\n", csvFormat.getRecordSeparator()); + assertFalse(csvFormat.getTrailingDelimiter()); + + assertFalse(csvFormat.getAllowMissingColumnNames()); + assertFalse(csvFormat.getTrim()); + + assertFalse(csvFormat.isNullStringSet()); + assertNull(csvFormat.getNullString()); + + assertFalse(csvFormat.getIgnoreSurroundingSpaces()); + assertNull(csvFormat.getEscapeCharacter()); + + assertFalse(csvFormatTwo.getIgnoreHeaderCase()); + assertNull(csvFormatTwo.getQuoteMode()); + + assertTrue(csvFormatTwo.getIgnoreEmptyLines()); + assertFalse(csvFormatTwo.getIgnoreSurroundingSpaces()); + + assertNull(csvFormatTwo.getEscapeCharacter()); + assertFalse(csvFormatTwo.getTrim()); + + assertFalse(csvFormatTwo.isEscapeCharacterSet()); + assertTrue(csvFormatTwo.isQuoteCharacterSet()); + + assertFalse(csvFormatTwo.getSkipHeaderRecord()); + assertEquals('\"', (char) csvFormatTwo.getQuoteCharacter()); + + assertFalse(csvFormatTwo.getAllowMissingColumnNames()); + assertNull(csvFormatTwo.getNullString()); + + assertFalse(csvFormatTwo.isNullStringSet()); + assertFalse(csvFormatTwo.getTrailingDelimiter()); + + assertEquals("\r\n", csvFormatTwo.getRecordSeparator()); + assertEquals(',', csvFormatTwo.getDelimiter()); + + assertNull(csvFormatTwo.getCommentMarker()); + assertFalse(csvFormatTwo.isCommentMarkerSet()); + + assertNotSame(csvFormat, csvFormatTwo); + assertNotSame(csvFormatTwo, csvFormat); + + assertNotNull(string); + assertNotEquals(csvFormat, csvFormatTwo); // CSV-244 - should not be equal + + assertNotEquals(csvFormatTwo, csvFormat); // CSV-244 - should not be equal + assertEquals(",,,,,,,", string); + + } + + @Test + void testWithHeaderEnum() { + final CSVFormat formatWithHeader = CSVFormat.DEFAULT.withHeader(Header.class); + assertArrayEquals(new String[] { "Name", "Email", "Phone" }, formatWithHeader.getHeader()); + } + + @Test + void testWithHeaderEnumNull() { + final CSVFormat format = CSVFormat.DEFAULT; + final Class> simpleName = null; + format.withHeader(simpleName); + } + + @Test + void testWithHeaderResultSetNull() throws SQLException { + final CSVFormat format = CSVFormat.DEFAULT; + final ResultSet resultSet = null; + format.withHeader(resultSet); + } + + @Test + void testWithIgnoreEmptyLines() { + assertFalse(CSVFormat.DEFAULT.withIgnoreEmptyLines(false).getIgnoreEmptyLines()); + assertTrue(CSVFormat.DEFAULT.withIgnoreEmptyLines().getIgnoreEmptyLines()); + } + + @Test + void testWithIgnoreSurround() { + assertFalse(CSVFormat.DEFAULT.withIgnoreSurroundingSpaces(false).getIgnoreSurroundingSpaces()); + assertTrue(CSVFormat.DEFAULT.withIgnoreSurroundingSpaces().getIgnoreSurroundingSpaces()); + } + + @Test + void testWithNullString() { + final CSVFormat formatWithNullString = CSVFormat.DEFAULT.withNullString("null"); + assertEquals("null", formatWithNullString.getNullString()); + } + + @Test + void testWithQuoteChar() { + final CSVFormat formatWithQuoteChar = CSVFormat.DEFAULT.withQuote('"'); + assertEquals(Character.valueOf('"'), formatWithQuoteChar.getQuoteCharacter()); + } + + @Test + void testWithQuoteLFThrowsException() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withQuote(LF)); + } + + @Test + void testWithQuotePolicy() { + final CSVFormat formatWithQuotePolicy = CSVFormat.DEFAULT.withQuoteMode(QuoteMode.ALL); + assertEquals(QuoteMode.ALL, formatWithQuotePolicy.getQuoteMode()); + } + + @Test + void testWithRecordSeparatorCR() { + final CSVFormat formatWithRecordSeparator = CSVFormat.DEFAULT.withRecordSeparator(CR); + assertEquals(String.valueOf(CR), formatWithRecordSeparator.getRecordSeparator()); + } + + @Test + void testWithRecordSeparatorCRLF() { + final CSVFormat formatWithRecordSeparator = CSVFormat.DEFAULT.withRecordSeparator(CRLF); + assertEquals(CRLF, formatWithRecordSeparator.getRecordSeparator()); + } + + @Test + void testWithRecordSeparatorLF() { + final CSVFormat formatWithRecordSeparator = CSVFormat.DEFAULT.withRecordSeparator(LF); + assertEquals(String.valueOf(LF), formatWithRecordSeparator.getRecordSeparator()); + } + + @Test + void testWithSystemRecordSeparator() { + final CSVFormat formatWithRecordSeparator = CSVFormat.DEFAULT.withSystemRecordSeparator(); + assertEquals(System.lineSeparator(), formatWithRecordSeparator.getRecordSeparator()); + } +} diff --git a/src/test/java/org/apache/commons/csv/CSVParserTest.java b/src/test/java/org/apache/commons/csv/CSVParserTest.java index 8f5d577f66..6d9bdd9e80 100644 --- a/src/test/java/org/apache/commons/csv/CSVParserTest.java +++ b/src/test/java/org/apache/commons/csv/CSVParserTest.java @@ -1,1740 +1,2116 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.apache.commons.csv; - -import static org.apache.commons.csv.Constants.CR; -import static org.apache.commons.csv.Constants.CRLF; -import static org.apache.commons.csv.Constants.LF; -import static org.junit.jupiter.api.Assertions.assertArrayEquals; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertFalse; -import static org.junit.jupiter.api.Assertions.assertInstanceOf; -import static org.junit.jupiter.api.Assertions.assertNotNull; -import static org.junit.jupiter.api.Assertions.assertNull; -import static org.junit.jupiter.api.Assertions.assertThrows; -import static org.junit.jupiter.api.Assertions.assertTrue; - -import java.io.File; -import java.io.IOException; -import java.io.InputStreamReader; -import java.io.PipedReader; -import java.io.PipedWriter; -import java.io.Reader; -import java.io.StringReader; -import java.io.StringWriter; -import java.io.UncheckedIOException; -import java.net.URL; -import java.nio.charset.Charset; -import java.nio.charset.StandardCharsets; -import java.nio.file.Files; -import java.nio.file.Path; -import java.nio.file.Paths; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Iterator; -import java.util.List; -import java.util.Map; -import java.util.NoSuchElementException; -import java.util.stream.Collectors; -import java.util.stream.Stream; - -import org.apache.commons.io.input.BOMInputStream; -import org.apache.commons.io.input.BrokenInputStream; -import org.junit.jupiter.api.Assertions; -import org.junit.jupiter.api.Disabled; -import org.junit.jupiter.api.Test; -import org.junit.jupiter.params.ParameterizedTest; -import org.junit.jupiter.params.provider.EnumSource; - -/** - * CSVParserTest - * - * The test are organized in three different sections: The 'setter/getter' section, the lexer section and finally the parser section. In case a test fails, you - * should follow a top-down approach for fixing a potential bug (its likely that the parser itself fails if the lexer has problems...). - */ -public class CSVParserTest { - - private static final CSVFormat EXCEL_WITH_HEADER = CSVFormat.EXCEL.withHeader(); - - private static final Charset UTF_8 = StandardCharsets.UTF_8; - - private static final String UTF_8_NAME = UTF_8.name(); - - private static final String CSV_INPUT = "a,b,c,d\n" + " a , b , 1 2 \n" + "\"foo baar\", b,\n" + - // + " \"foo\n,,\n\"\",,\n\\\"\",d,e\n"; - " \"foo\n,,\n\"\",,\n\"\"\",d,e\n"; // changed to use standard CSV escaping - - private static final String CSV_INPUT_1 = "a,b,c,d"; - - private static final String CSV_INPUT_2 = "a,b,1 2"; - - private static final String[][] RESULT = { { "a", "b", "c", "d" }, { "a", "b", "1 2" }, { "foo baar", "b", "" }, { "foo\n,,\n\",,\n\"", "d", "e" } }; - - // CSV with no header comments - static private final String CSV_INPUT_NO_COMMENT = "A,B" + CRLF + "1,2" + CRLF; - - // CSV with a header comment - static private final String CSV_INPUT_HEADER_COMMENT = "# header comment" + CRLF + "A,B" + CRLF + "1,2" + CRLF; - - // CSV with a single line header and trailer comment - static private final String CSV_INPUT_HEADER_TRAILER_COMMENT = "# header comment" + CRLF + "A,B" + CRLF + "1,2" + CRLF + "# comment"; - - // CSV with a multi-line header and trailer comment - static private final String CSV_INPUT_MULTILINE_HEADER_TRAILER_COMMENT = "# multi-line" + CRLF + "# header comment" + CRLF + "A,B" + CRLF + "1,2" + CRLF + - "# multi-line" + CRLF + "# comment"; - - // Format with auto-detected header - static private final CSVFormat FORMAT_AUTO_HEADER = CSVFormat.Builder.create(CSVFormat.DEFAULT).setCommentMarker('#').setHeader().get(); - - // Format with explicit header - // @formatter:off - static private final CSVFormat FORMAT_EXPLICIT_HEADER = CSVFormat.Builder.create(CSVFormat.DEFAULT) - .setSkipHeaderRecord(true) - .setCommentMarker('#') - .setHeader("A", "B") - .get(); - // @formatter:on - - // Format with explicit header that does not skip the header line - // @formatter:off - CSVFormat FORMAT_EXPLICIT_HEADER_NOSKIP = CSVFormat.Builder.create(CSVFormat.DEFAULT) - .setCommentMarker('#') - .setHeader("A", "B") - .get(); - // @formatter:on - - @SuppressWarnings("resource") // caller releases - private BOMInputStream createBOMInputStream(final String resource) throws IOException { - return new BOMInputStream(ClassLoader.getSystemClassLoader().getResource(resource).openStream()); - } - - CSVRecord parse(final CSVParser parser, final int failParseRecordNo) throws IOException { - if (parser.getRecordNumber() + 1 == failParseRecordNo) { - assertThrows(IOException.class, () -> parser.nextRecord()); - return null; - } - return parser.nextRecord(); - } - - private void parseFully(final CSVParser parser) { - parser.forEach(Assertions::assertNotNull); - } - - @Test - public void testBackslashEscaping() throws IOException { - // To avoid confusion over the need for escaping chars in java code, - // We will test with a forward slash as the escape char, and a single - // quote as the encapsulator. - - // @formatter:off - final String code = "one,two,three\n" + // 0 - "'',''\n" + // 1) empty encapsulators - "/',/'\n" + // 2) single encapsulators - "'/'','/''\n" + // 3) single encapsulators encapsulated via escape - "'''',''''\n" + // 4) single encapsulators encapsulated via doubling - "/,,/,\n" + // 5) separator escaped - "//,//\n" + // 6) escape escaped - "'//','//'\n" + // 7) escape escaped in encapsulation - " 8 , \"quoted \"\" /\" // string\" \n" + // don't eat spaces - "9, /\n \n" + // escaped newline - ""; - final String[][] res = {{"one", "two", "three"}, // 0 - {"", ""}, // 1 - {"'", "'"}, // 2 - {"'", "'"}, // 3 - {"'", "'"}, // 4 - {",", ","}, // 5 - {"/", "/"}, // 6 - {"/", "/"}, // 7 - {" 8 ", " \"quoted \"\" /\" / string\" "}, {"9", " \n "} }; - // @formatter:on - final CSVFormat format = CSVFormat.newFormat(',').withQuote('\'').withRecordSeparator(CRLF).withEscape('/').withIgnoreEmptyLines(); - try (final CSVParser parser = CSVParser.parse(code, format)) { - final List records = parser.getRecords(); - assertFalse(records.isEmpty()); - Utils.compare("Records do not match expected result", res, records); - } - } - - @Test - public void testBackslashEscaping2() throws IOException { - // To avoid confusion over the need for escaping chars in java code, - // We will test with a forward slash as the escape char, and a single - // quote as the encapsulator. - // @formatter:off - final String code = "" + " , , \n" + // 1) - " \t , , \n" + // 2) - " // , /, , /,\n" + // 3) - ""; - final String[][] res = {{" ", " ", " "}, // 1 - {" \t ", " ", " "}, // 2 - {" / ", " , ", " ,"}, // 3 - }; - // @formatter:on - final CSVFormat format = CSVFormat.newFormat(',').withRecordSeparator(CRLF).withEscape('/').withIgnoreEmptyLines(); - try (final CSVParser parser = CSVParser.parse(code, format)) { - final List records = parser.getRecords(); - assertFalse(records.isEmpty()); - Utils.compare("", res, records); - } - } - - @Test - @Disabled - public void testBackslashEscapingOld() throws IOException { - final String code = "one,two,three\n" + "on\\\"e,two\n" + "on\"e,two\n" + "one,\"tw\\\"o\"\n" + "one,\"t\\,wo\"\n" + "one,two,\"th,ree\"\n" + - "\"a\\\\\"\n" + "a\\,b\n" + "\"a\\\\,b\""; - final String[][] res = { { "one", "two", "three" }, { "on\\\"e", "two" }, { "on\"e", "two" }, { "one", "tw\"o" }, { "one", "t\\,wo" }, // backslash in - // quotes only - // escapes a - // delimiter - // (",") - { "one", "two", "th,ree" }, { "a\\\\" }, // backslash in quotes only escapes a delimiter (",") - { "a\\", "b" }, // a backslash must be returned - { "a\\\\,b" } // backslash in quotes only escapes a delimiter (",") - }; - try (final CSVParser parser = CSVParser.parse(code, CSVFormat.DEFAULT)) { - final List records = parser.getRecords(); - assertEquals(res.length, records.size()); - assertFalse(records.isEmpty()); - for (int i = 0; i < res.length; i++) { - assertArrayEquals(res[i], records.get(i).values()); - } - } - } - - @Test - @Disabled("CSV-107") - public void testBOM() throws IOException { - final URL url = ClassLoader.getSystemClassLoader().getResource("org/apache/commons/csv/CSVFileParser/bom.csv"); - try (final CSVParser parser = CSVParser.parse(url, StandardCharsets.UTF_8, EXCEL_WITH_HEADER)) { - parser.forEach(record -> assertNotNull(record.get("Date"))); - } - } - - @Test - public void testBOMInputStreamParserWithInputStream() throws IOException { - try (final BOMInputStream inputStream = createBOMInputStream("org/apache/commons/csv/CSVFileParser/bom.csv"); - final CSVParser parser = CSVParser.parse(inputStream, UTF_8, EXCEL_WITH_HEADER)) { - parser.forEach(record -> assertNotNull(record.get("Date"))); - } - } - - @Test - public void testBOMInputStreamParserWithReader() throws IOException { - try (final Reader reader = new InputStreamReader(createBOMInputStream("org/apache/commons/csv/CSVFileParser/bom.csv"), UTF_8_NAME); - final CSVParser parser = CSVParser.builder() - .setReader(reader) - .setFormat(EXCEL_WITH_HEADER) - .get()) { - parser.forEach(record -> assertNotNull(record.get("Date"))); - } - } - - @Test - public void testBOMInputStreamParseWithReader() throws IOException { - try (final Reader reader = new InputStreamReader(createBOMInputStream("org/apache/commons/csv/CSVFileParser/bom.csv"), UTF_8_NAME); - final CSVParser parser = CSVParser.builder() - .setReader(reader) - .setFormat(EXCEL_WITH_HEADER) - .get()) { - parser.forEach(record -> assertNotNull(record.get("Date"))); - } - } - - @Test - public void testCarriageReturnEndings() throws IOException { - final String string = "foo\rbaar,\rhello,world\r,kanu"; - try (final CSVParser parser = CSVParser.builder().setCharSequence(string).get()) { - final List records = parser.getRecords(); - assertEquals(4, records.size()); - } - } - - @Test - public void testCarriageReturnLineFeedEndings() throws IOException { - final String string = "foo\r\nbaar,\r\nhello,world\r\n,kanu"; - try (final CSVParser parser = CSVParser.builder().setCharSequence(string).get()) { - final List records = parser.getRecords(); - assertEquals(4, records.size()); - } - } - - @Test - public void testClose() throws Exception { - final Reader in = new StringReader("# comment\na,b,c\n1,2,3\nx,y,z"); - final Iterator records; - try (final CSVParser parser = CSVFormat.DEFAULT.withCommentMarker('#').withHeader().parse(in)) { - records = parser.iterator(); - assertTrue(records.hasNext()); - } - assertFalse(records.hasNext()); - assertThrows(NoSuchElementException.class, records::next); - } - - @Test - public void testCSV141CSVFormat_DEFAULT() throws Exception { - testCSV141Failure(CSVFormat.DEFAULT, 3); - } - - @Test - public void testCSV141CSVFormat_INFORMIX_UNLOAD() throws Exception { - testCSV141Failure(CSVFormat.INFORMIX_UNLOAD, 1); - } - - @Test - public void testCSV141CSVFormat_INFORMIX_UNLOAD_CSV() throws Exception { - testCSV141Failure(CSVFormat.INFORMIX_UNLOAD_CSV, 3); - } - - @Test - public void testCSV141CSVFormat_ORACLE() throws Exception { - testCSV141Failure(CSVFormat.ORACLE, 2); - } - - @Test - public void testCSV141CSVFormat_POSTGRESQL_CSV() throws Exception { - testCSV141Failure(CSVFormat.POSTGRESQL_CSV, 3); - } - - @Test - public void testCSV141Excel() throws Exception { - testCSV141Ok(CSVFormat.EXCEL); - } - - private void testCSV141Failure(final CSVFormat format, final int failParseRecordNo) throws IOException { - final Path path = Paths.get("src/test/resources/org/apache/commons/csv/CSV-141/csv-141.csv"); - try (final CSVParser parser = CSVParser.parse(path, StandardCharsets.UTF_8, format)) { - // row 1 - CSVRecord record = parse(parser, failParseRecordNo); - if (record == null) { - return; // expected failure - } - assertEquals("1414770317901", record.get(0)); - assertEquals("android.widget.EditText", record.get(1)); - assertEquals("pass sem1 _84*|*", record.get(2)); - assertEquals("0", record.get(3)); - assertEquals("pass sem1 _8", record.get(4)); - assertEquals(5, record.size()); - // row 2 - record = parse(parser, failParseRecordNo); - if (record == null) { - return; // expected failure - } - assertEquals("1414770318470", record.get(0)); - assertEquals("android.widget.EditText", record.get(1)); - assertEquals("pass sem1 _84:|", record.get(2)); - assertEquals("0", record.get(3)); - assertEquals("pass sem1 _84:\\", record.get(4)); - assertEquals(5, record.size()); - // row 3: Fail for certain - assertThrows(IOException.class, () -> parser.nextRecord()); - } - } - - private void testCSV141Ok(final CSVFormat format) throws IOException { - final Path path = Paths.get("src/test/resources/org/apache/commons/csv/CSV-141/csv-141.csv"); - try (final CSVParser parser = CSVParser.parse(path, StandardCharsets.UTF_8, format)) { - // row 1 - CSVRecord record = parser.nextRecord(); - assertEquals("1414770317901", record.get(0)); - assertEquals("android.widget.EditText", record.get(1)); - assertEquals("pass sem1 _84*|*", record.get(2)); - assertEquals("0", record.get(3)); - assertEquals("pass sem1 _8", record.get(4)); - assertEquals(5, record.size()); - // row 2 - record = parser.nextRecord(); - assertEquals("1414770318470", record.get(0)); - assertEquals("android.widget.EditText", record.get(1)); - assertEquals("pass sem1 _84:|", record.get(2)); - assertEquals("0", record.get(3)); - assertEquals("pass sem1 _84:\\", record.get(4)); - assertEquals(5, record.size()); - // row 3 - record = parser.nextRecord(); - assertEquals("1414770318327", record.get(0)); - assertEquals("android.widget.EditText", record.get(1)); - assertEquals("pass sem1\n1414770318628\"", record.get(2)); - assertEquals("android.widget.EditText", record.get(3)); - assertEquals("pass sem1 _84*|*", record.get(4)); - assertEquals("0", record.get(5)); - assertEquals("pass sem1\n", record.get(6)); - assertEquals(7, record.size()); - // EOF - record = parser.nextRecord(); - assertNull(record); - } - } - - @Test - public void testCSV141RFC4180() throws Exception { - testCSV141Failure(CSVFormat.RFC4180, 3); - } - - @Test - public void testCSV235() throws IOException { - final String dqString = "\"aaa\",\"b\"\"bb\",\"ccc\""; // "aaa","b""bb","ccc" - try (final CSVParser parser = CSVFormat.RFC4180.parse(new StringReader(dqString))) { - final Iterator records = parser.iterator(); - final CSVRecord record = records.next(); - assertFalse(records.hasNext()); - assertEquals(3, record.size()); - assertEquals("aaa", record.get(0)); - assertEquals("b\"bb", record.get(1)); - assertEquals("ccc", record.get(2)); - } - } - - @Test - public void testCSV57() throws Exception { - try (final CSVParser parser = CSVParser.parse("", CSVFormat.DEFAULT)) { - final List list = parser.getRecords(); - assertNotNull(list); - assertEquals(0, list.size()); - } - } - - @Test - public void testDefaultFormat() throws IOException { - // @formatter:off - final String code = "" + "a,b#\n" + // 1) - "\"\n\",\" \",#\n" + // 2) - "#,\"\"\n" + // 3) - "# Final comment\n" // 4) - ; - // @formatter:on - final String[][] res = { { "a", "b#" }, { "\n", " ", "#" }, { "#", "" }, { "# Final comment" } }; - CSVFormat format = CSVFormat.DEFAULT; - assertFalse(format.isCommentMarkerSet()); - final String[][] res_comments = { { "a", "b#" }, { "\n", " ", "#" } }; - try (final CSVParser parser = CSVParser.parse(code, format)) { - final List records = parser.getRecords(); - assertFalse(records.isEmpty()); - Utils.compare("Failed to parse without comments", res, records); - format = CSVFormat.DEFAULT.withCommentMarker('#'); - } - try (final CSVParser parser = CSVParser.parse(code, format)) { - final List records = parser.getRecords(); - Utils.compare("Failed to parse with comments", res_comments, records); - } - } - - @Test - public void testDuplicateHeadersAllowedByDefault() throws Exception { - try (CSVParser parser = CSVParser.parse("a,b,a\n1,2,3\nx,y,z", CSVFormat.DEFAULT.withHeader())) { - // noop - } - } - - @Test - public void testDuplicateHeadersNotAllowed() { - assertThrows(IllegalArgumentException.class, - () -> CSVParser.parse("a,b,a\n1,2,3\nx,y,z", CSVFormat.DEFAULT.withHeader().withAllowDuplicateHeaderNames(false))); - } - - @Test - public void testEmptyFile() throws Exception { - try (final CSVParser parser = CSVParser.parse(Paths.get("src/test/resources/org/apache/commons/csv/empty.txt"), StandardCharsets.UTF_8, - CSVFormat.DEFAULT)) { - assertNull(parser.nextRecord()); - } - } - - @Test - public void testEmptyFileHeaderParsing() throws Exception { - try (final CSVParser parser = CSVParser.parse("", CSVFormat.DEFAULT.withFirstRecordAsHeader())) { - assertNull(parser.nextRecord()); - assertTrue(parser.getHeaderNames().isEmpty()); - } - } - - @Test - public void testEmptyLineBehaviorCSV() throws Exception { - final String[] codes = { "hello,\r\n\r\n\r\n", "hello,\n\n\n", "hello,\"\"\r\n\r\n\r\n", "hello,\"\"\n\n\n" }; - final String[][] res = { { "hello", "" } // CSV format ignores empty lines - }; - for (final String code : codes) { - try (final CSVParser parser = CSVParser.parse(code, CSVFormat.DEFAULT)) { - final List records = parser.getRecords(); - assertEquals(res.length, records.size()); - assertFalse(records.isEmpty()); - for (int i = 0; i < res.length; i++) { - assertArrayEquals(res[i], records.get(i).values()); - } - } - } - } - - @Test - public void testEmptyLineBehaviorExcel() throws Exception { - final String[] codes = { "hello,\r\n\r\n\r\n", "hello,\n\n\n", "hello,\"\"\r\n\r\n\r\n", "hello,\"\"\n\n\n" }; - final String[][] res = { { "hello", "" }, { "" }, // Excel format does not ignore empty lines - { "" } }; - for (final String code : codes) { - try (final CSVParser parser = CSVParser.parse(code, CSVFormat.EXCEL)) { - final List records = parser.getRecords(); - assertEquals(res.length, records.size()); - assertFalse(records.isEmpty()); - for (int i = 0; i < res.length; i++) { - assertArrayEquals(res[i], records.get(i).values()); - } - } - } - } - - @Test - public void testEmptyString() throws Exception { - try (final CSVParser parser = CSVParser.parse("", CSVFormat.DEFAULT)) { - assertNull(parser.nextRecord()); - } - } - - @Test - public void testEndOfFileBehaviorCSV() throws Exception { - final String[] codes = { "hello,\r\n\r\nworld,\r\n", "hello,\r\n\r\nworld,", "hello,\r\n\r\nworld,\"\"\r\n", "hello,\r\n\r\nworld,\"\"", - "hello,\r\n\r\nworld,\n", "hello,\r\n\r\nworld,", "hello,\r\n\r\nworld,\"\"\n", "hello,\r\n\r\nworld,\"\"" }; - final String[][] res = { { "hello", "" }, // CSV format ignores empty lines - { "world", "" } }; - for (final String code : codes) { - try (final CSVParser parser = CSVParser.parse(code, CSVFormat.DEFAULT)) { - final List records = parser.getRecords(); - assertEquals(res.length, records.size()); - assertFalse(records.isEmpty()); - for (int i = 0; i < res.length; i++) { - assertArrayEquals(res[i], records.get(i).values()); - } - } - } - } - - @Test - public void testEndOfFileBehaviorExcel() throws Exception { - final String[] codes = { "hello,\r\n\r\nworld,\r\n", "hello,\r\n\r\nworld,", "hello,\r\n\r\nworld,\"\"\r\n", "hello,\r\n\r\nworld,\"\"", - "hello,\r\n\r\nworld,\n", "hello,\r\n\r\nworld,", "hello,\r\n\r\nworld,\"\"\n", "hello,\r\n\r\nworld,\"\"" }; - final String[][] res = { { "hello", "" }, { "" }, // Excel format does not ignore empty lines - { "world", "" } }; - - for (final String code : codes) { - try (final CSVParser parser = CSVParser.parse(code, CSVFormat.EXCEL)) { - final List records = parser.getRecords(); - assertEquals(res.length, records.size()); - assertFalse(records.isEmpty()); - for (int i = 0; i < res.length; i++) { - assertArrayEquals(res[i], records.get(i).values()); - } - } - } - } - - @Test - public void testExcelFormat1() throws IOException { - final String code = "value1,value2,value3,value4\r\na,b,c,d\r\n x,,," + "\r\n\r\n\"\"\"hello\"\"\",\" \"\"world\"\"\",\"abc\ndef\",\r\n"; - final String[][] res = { { "value1", "value2", "value3", "value4" }, { "a", "b", "c", "d" }, { " x", "", "", "" }, { "" }, - { "\"hello\"", " \"world\"", "abc\ndef", "" } }; - try (final CSVParser parser = CSVParser.parse(code, CSVFormat.EXCEL)) { - final List records = parser.getRecords(); - assertEquals(res.length, records.size()); - assertFalse(records.isEmpty()); - for (int i = 0; i < res.length; i++) { - assertArrayEquals(res[i], records.get(i).values()); - } - } - } - - @Test - public void testExcelFormat2() throws Exception { - final String code = "foo,baar\r\n\r\nhello,\r\n\r\nworld,\r\n"; - final String[][] res = { { "foo", "baar" }, { "" }, { "hello", "" }, { "" }, { "world", "" } }; - try (final CSVParser parser = CSVParser.parse(code, CSVFormat.EXCEL)) { - final List records = parser.getRecords(); - assertEquals(res.length, records.size()); - assertFalse(records.isEmpty()); - for (int i = 0; i < res.length; i++) { - assertArrayEquals(res[i], records.get(i).values()); - } - } - } - - /** - * Tests an exported Excel worksheet with a header row and rows that have more columns than the headers - */ - @Test - public void testExcelHeaderCountLessThanData() throws Exception { - final String code = "A,B,C,,\r\na,b,c,d,e\r\n"; - try (final CSVParser parser = CSVParser.parse(code, EXCEL_WITH_HEADER)) { - parser.getRecords().forEach(record -> { - assertEquals("a", record.get("A")); - assertEquals("b", record.get("B")); - assertEquals("c", record.get("C")); - }); - } - } - - @Test - public void testFirstEndOfLineCr() throws IOException { - final String data = "foo\rbaar,\rhello,world\r,kanu"; - try (final CSVParser parser = CSVParser.parse(data, CSVFormat.DEFAULT)) { - final List records = parser.getRecords(); - assertEquals(4, records.size()); - assertEquals("\r", parser.getFirstEndOfLine()); - } - } - - @Test - public void testFirstEndOfLineCrLf() throws IOException { - final String data = "foo\r\nbaar,\r\nhello,world\r\n,kanu"; - try (final CSVParser parser = CSVParser.parse(data, CSVFormat.DEFAULT)) { - final List records = parser.getRecords(); - assertEquals(4, records.size()); - assertEquals("\r\n", parser.getFirstEndOfLine()); - } - } - - @Test - public void testFirstEndOfLineLf() throws IOException { - final String data = "foo\nbaar,\nhello,world\n,kanu"; - try (final CSVParser parser = CSVParser.parse(data, CSVFormat.DEFAULT)) { - final List records = parser.getRecords(); - assertEquals(4, records.size()); - assertEquals("\n", parser.getFirstEndOfLine()); - } - } - - @Test - public void testForEach() throws Exception { - try (final Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); - final CSVParser parser = CSVFormat.DEFAULT.parse(in)) { - final List records = new ArrayList<>(); - for (final CSVRecord record : parser) { - records.add(record); - } - assertEquals(3, records.size()); - assertArrayEquals(new String[] { "a", "b", "c" }, records.get(0).values()); - assertArrayEquals(new String[] { "1", "2", "3" }, records.get(1).values()); - assertArrayEquals(new String[] { "x", "y", "z" }, records.get(2).values()); - } - } - - @Test - public void testGetHeaderComment_HeaderComment1() throws IOException { - try (CSVParser parser = CSVParser.parse(CSV_INPUT_HEADER_COMMENT, FORMAT_AUTO_HEADER)) { - parser.getRecords(); - // Expect a header comment - assertTrue(parser.hasHeaderComment()); - assertEquals("header comment", parser.getHeaderComment()); - } - } - - @Test - public void testGetHeaderComment_HeaderComment2() throws IOException { - try (CSVParser parser = CSVParser.parse(CSV_INPUT_HEADER_COMMENT, FORMAT_EXPLICIT_HEADER)) { - parser.getRecords(); - // Expect a header comment - assertTrue(parser.hasHeaderComment()); - assertEquals("header comment", parser.getHeaderComment()); - } - } - - @Test - public void testGetHeaderComment_HeaderComment3() throws IOException { - try (CSVParser parser = CSVParser.parse(CSV_INPUT_HEADER_COMMENT, FORMAT_EXPLICIT_HEADER_NOSKIP)) { - parser.getRecords(); - // Expect no header comment - the text "comment" is attached to the first record - assertFalse(parser.hasHeaderComment()); - assertNull(parser.getHeaderComment()); - } - } - - @Test - public void testGetHeaderComment_HeaderTrailerComment() throws IOException { - try (CSVParser parser = CSVParser.parse(CSV_INPUT_MULTILINE_HEADER_TRAILER_COMMENT, FORMAT_AUTO_HEADER)) { - parser.getRecords(); - // Expect a header comment - assertTrue(parser.hasHeaderComment()); - assertEquals("multi-line" + LF + "header comment", parser.getHeaderComment()); - } - } - - @Test - public void testGetHeaderComment_NoComment1() throws IOException { - try (CSVParser parser = CSVParser.parse(CSV_INPUT_NO_COMMENT, FORMAT_AUTO_HEADER)) { - parser.getRecords(); - // Expect no header comment - assertFalse(parser.hasHeaderComment()); - assertNull(parser.getHeaderComment()); - } - } - - @Test - public void testGetHeaderComment_NoComment2() throws IOException { - try (CSVParser parser = CSVParser.parse(CSV_INPUT_NO_COMMENT, FORMAT_EXPLICIT_HEADER)) { - parser.getRecords(); - // Expect no header comment - assertFalse(parser.hasHeaderComment()); - assertNull(parser.getHeaderComment()); - } - } - - @Test - public void testGetHeaderComment_NoComment3() throws IOException { - try (CSVParser parser = CSVParser.parse(CSV_INPUT_NO_COMMENT, FORMAT_EXPLICIT_HEADER_NOSKIP)) { - parser.getRecords(); - // Expect no header comment - assertFalse(parser.hasHeaderComment()); - assertNull(parser.getHeaderComment()); - } - } - - @Test - public void testGetHeaderMap() throws Exception { - try (final CSVParser parser = CSVParser.parse("a,b,c\n1,2,3\nx,y,z", CSVFormat.DEFAULT.withHeader("A", "B", "C"))) { - final Map headerMap = parser.getHeaderMap(); - final Iterator columnNames = headerMap.keySet().iterator(); - // Headers are iterated in column order. - assertEquals("A", columnNames.next()); - assertEquals("B", columnNames.next()); - assertEquals("C", columnNames.next()); - final Iterator records = parser.iterator(); - - // Parse to make sure getHeaderMap did not have a side-effect. - for (int i = 0; i < 3; i++) { - assertTrue(records.hasNext()); - final CSVRecord record = records.next(); - assertEquals(record.get(0), record.get("A")); - assertEquals(record.get(1), record.get("B")); - assertEquals(record.get(2), record.get("C")); - } - - assertFalse(records.hasNext()); - } - } - - @Test - public void testGetHeaderNames() throws IOException { - try (final CSVParser parser = CSVParser.parse("a,b,c\n1,2,3\nx,y,z", CSVFormat.DEFAULT.withHeader("A", "B", "C"))) { - final Map nameIndexMap = parser.getHeaderMap(); - final List headerNames = parser.getHeaderNames(); - assertNotNull(headerNames); - assertEquals(nameIndexMap.size(), headerNames.size()); - for (int i = 0; i < headerNames.size(); i++) { - final String name = headerNames.get(i); - assertEquals(i, nameIndexMap.get(name).intValue()); - } - } - } - - @Test - public void testGetHeaderNamesReadOnly() throws IOException { - try (final CSVParser parser = CSVParser.parse("a,b,c\n1,2,3\nx,y,z", CSVFormat.DEFAULT.withHeader("A", "B", "C"))) { - final List headerNames = parser.getHeaderNames(); - assertNotNull(headerNames); - assertThrows(UnsupportedOperationException.class, () -> headerNames.add("This is a read-only list.")); - } - } - - @Test - public void testGetLine() throws IOException { - try (final CSVParser parser = CSVParser.parse(CSV_INPUT, CSVFormat.DEFAULT.withIgnoreSurroundingSpaces())) { - for (final String[] re : RESULT) { - assertArrayEquals(re, parser.nextRecord().values()); - } - - assertNull(parser.nextRecord()); - } - } - - @Test - public void testGetLineNumberWithCR() throws Exception { - validateLineNumbers(String.valueOf(CR)); - } - - @Test - public void testGetLineNumberWithCRLF() throws Exception { - validateLineNumbers(CRLF); - } - - @Test - public void testGetLineNumberWithLF() throws Exception { - validateLineNumbers(String.valueOf(LF)); - } - - @Test - public void testGetOneLine() throws IOException { - try (final CSVParser parser = CSVParser.parse(CSV_INPUT_1, CSVFormat.DEFAULT)) { - final CSVRecord record = parser.getRecords().get(0); - assertArrayEquals(RESULT[0], record.values()); - } - } - - /** - * Tests reusing a parser to process new string records one at a time as they are being discovered. See [CSV-110]. - * - * @throws IOException when an I/O error occurs. - */ - @Test - public void testGetOneLineOneParser() throws IOException { - final CSVFormat format = CSVFormat.DEFAULT; - try (final PipedWriter writer = new PipedWriter(); - final CSVParser parser = CSVParser.builder() - .setReader(new PipedReader(writer)) - .setFormat(format) - .get()) { - writer.append(CSV_INPUT_1); - writer.append(format.getRecordSeparator()); - final CSVRecord record1 = parser.nextRecord(); - assertArrayEquals(RESULT[0], record1.values()); - writer.append(CSV_INPUT_2); - writer.append(format.getRecordSeparator()); - final CSVRecord record2 = parser.nextRecord(); - assertArrayEquals(RESULT[1], record2.values()); - } - } - - @Test - public void testGetRecordNumberWithCR() throws Exception { - validateRecordNumbers(String.valueOf(CR)); - } - - @Test - public void testGetRecordNumberWithCRLF() throws Exception { - validateRecordNumbers(CRLF); - } - - @Test - public void testGetRecordNumberWithLF() throws Exception { - validateRecordNumbers(String.valueOf(LF)); - } - - @Test - public void testGetRecordPositionWithCRLF() throws Exception { - validateRecordPosition(CRLF); - } - - @Test - public void testGetRecordPositionWithLF() throws Exception { - validateRecordPosition(String.valueOf(LF)); - } - - @Test - public void testGetRecords() throws IOException { - try (final CSVParser parser = CSVParser.parse(CSV_INPUT, CSVFormat.DEFAULT.withIgnoreSurroundingSpaces())) { - final List records = parser.getRecords(); - assertEquals(RESULT.length, records.size()); - assertFalse(records.isEmpty()); - for (int i = 0; i < RESULT.length; i++) { - assertArrayEquals(RESULT[i], records.get(i).values()); - } - } - } - - @Test - public void testGetRecordsFromBrokenInputStream() throws IOException { - @SuppressWarnings("resource") // We also get an exception on close, which is OK but can't assert in a try. - final CSVParser parser = CSVParser.parse(new BrokenInputStream(), UTF_8, CSVFormat.DEFAULT); - assertThrows(UncheckedIOException.class, parser::getRecords); - - } - - @Test - public void testGetRecordWithMultiLineValues() throws Exception { - try (final CSVParser parser = CSVParser.parse("\"a\r\n1\",\"a\r\n2\"" + CRLF + "\"b\r\n1\",\"b\r\n2\"" + CRLF + "\"c\r\n1\",\"c\r\n2\"", - CSVFormat.DEFAULT.withRecordSeparator(CRLF))) { - CSVRecord record; - assertEquals(0, parser.getRecordNumber()); - assertEquals(0, parser.getCurrentLineNumber()); - assertNotNull(record = parser.nextRecord()); - assertEquals(3, parser.getCurrentLineNumber()); - assertEquals(1, record.getRecordNumber()); - assertEquals(1, parser.getRecordNumber()); - assertNotNull(record = parser.nextRecord()); - assertEquals(6, parser.getCurrentLineNumber()); - assertEquals(2, record.getRecordNumber()); - assertEquals(2, parser.getRecordNumber()); - assertNotNull(record = parser.nextRecord()); - assertEquals(9, parser.getCurrentLineNumber()); - assertEquals(3, record.getRecordNumber()); - assertEquals(3, parser.getRecordNumber()); - assertNull(record = parser.nextRecord()); - assertEquals(9, parser.getCurrentLineNumber()); - assertEquals(3, parser.getRecordNumber()); - } - } - - @Test - public void testGetTrailerComment_HeaderComment1() throws IOException { - try (CSVParser parser = CSVParser.parse(CSV_INPUT_HEADER_COMMENT, FORMAT_AUTO_HEADER)) { - parser.getRecords(); - assertFalse(parser.hasTrailerComment()); - assertNull(parser.getTrailerComment()); - } - } - - @Test - public void testGetTrailerComment_HeaderComment2() throws IOException { - try (CSVParser parser = CSVParser.parse(CSV_INPUT_HEADER_COMMENT, FORMAT_EXPLICIT_HEADER)) { - parser.getRecords(); - assertFalse(parser.hasTrailerComment()); - assertNull(parser.getTrailerComment()); - } - } - - @Test - public void testGetTrailerComment_HeaderComment3() throws IOException { - try (CSVParser parser = CSVParser.parse(CSV_INPUT_HEADER_COMMENT, FORMAT_EXPLICIT_HEADER_NOSKIP)) { - parser.getRecords(); - assertFalse(parser.hasTrailerComment()); - assertNull(parser.getTrailerComment()); - } - } - - @Test - public void testGetTrailerComment_HeaderTrailerComment1() throws IOException { - try (CSVParser parser = CSVParser.parse(CSV_INPUT_HEADER_TRAILER_COMMENT, FORMAT_AUTO_HEADER)) { - parser.getRecords(); - assertTrue(parser.hasTrailerComment()); - assertEquals("comment", parser.getTrailerComment()); - } - } - - @Test - public void testGetTrailerComment_HeaderTrailerComment2() throws IOException { - try (CSVParser parser = CSVParser.parse(CSV_INPUT_HEADER_TRAILER_COMMENT, FORMAT_EXPLICIT_HEADER)) { - parser.getRecords(); - assertTrue(parser.hasTrailerComment()); - assertEquals("comment", parser.getTrailerComment()); - } - } - - @Test - public void testGetTrailerComment_HeaderTrailerComment3() throws IOException { - try (CSVParser parser = CSVParser.parse(CSV_INPUT_HEADER_TRAILER_COMMENT, FORMAT_EXPLICIT_HEADER_NOSKIP)) { - parser.getRecords(); - assertTrue(parser.hasTrailerComment()); - assertEquals("comment", parser.getTrailerComment()); - } - } - - @Test - public void testGetTrailerComment_MultilineComment() throws IOException { - try (CSVParser parser = CSVParser.parse(CSV_INPUT_MULTILINE_HEADER_TRAILER_COMMENT, FORMAT_AUTO_HEADER)) { - parser.getRecords(); - assertTrue(parser.hasTrailerComment()); - assertEquals("multi-line" + LF + "comment", parser.getTrailerComment()); - } - } - - @Test - public void testHeader() throws Exception { - final Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); - - try (final CSVParser parser = CSVFormat.DEFAULT.withHeader().parse(in)) { - final Iterator records = parser.iterator(); - - for (int i = 0; i < 2; i++) { - assertTrue(records.hasNext()); - final CSVRecord record = records.next(); - assertEquals(record.get(0), record.get("a")); - assertEquals(record.get(1), record.get("b")); - assertEquals(record.get(2), record.get("c")); - } - - assertFalse(records.hasNext()); - } - } - - @Test - public void testHeaderComment() throws Exception { - final Reader in = new StringReader("# comment\na,b,c\n1,2,3\nx,y,z"); - try (final CSVParser parser = CSVFormat.DEFAULT.withCommentMarker('#').withHeader().parse(in)) { - final Iterator records = parser.iterator(); - for (int i = 0; i < 2; i++) { - assertTrue(records.hasNext()); - final CSVRecord record = records.next(); - assertEquals(record.get(0), record.get("a")); - assertEquals(record.get(1), record.get("b")); - assertEquals(record.get(2), record.get("c")); - } - assertFalse(records.hasNext()); - } - } - - @Test - public void testHeaderMissing() throws Exception { - final Reader in = new StringReader("a,,c\n1,2,3\nx,y,z"); - try (final CSVParser parser = CSVFormat.DEFAULT.withHeader().withAllowMissingColumnNames().parse(in)) { - final Iterator records = parser.iterator(); - for (int i = 0; i < 2; i++) { - assertTrue(records.hasNext()); - final CSVRecord record = records.next(); - assertEquals(record.get(0), record.get("a")); - assertEquals(record.get(2), record.get("c")); - } - assertFalse(records.hasNext()); - } - } - - @Test - public void testHeaderMissingWithNull() throws Exception { - final Reader in = new StringReader("a,,c,,e\n1,2,3,4,5\nv,w,x,y,z"); - try (final CSVParser parser = CSVFormat.DEFAULT.withHeader().withNullString("").withAllowMissingColumnNames().parse(in)) { - parser.iterator(); - } - } - - @Test - public void testHeadersMissing() throws Exception { - try (final Reader in = new StringReader("a,,c,,e\n1,2,3,4,5\nv,w,x,y,z"); - final CSVParser parser = CSVFormat.DEFAULT.withHeader().withAllowMissingColumnNames().parse(in)) { - parser.iterator(); - } - } - - @Test - public void testHeadersMissingException() { - final Reader in = new StringReader("a,,c,,e\n1,2,3,4,5\nv,w,x,y,z"); - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withHeader().parse(in).iterator()); - } - - @Test - public void testHeadersMissingOneColumnException() { - final Reader in = new StringReader("a,,c,d,e\n1,2,3,4,5\nv,w,x,y,z"); - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withHeader().parse(in).iterator()); - } - - @Test - public void testHeadersWithNullColumnName() throws IOException { - final Reader in = new StringReader("header1,null,header3\n1,2,3\n4,5,6"); - try (final CSVParser parser = CSVFormat.DEFAULT.withHeader().withNullString("null").withAllowMissingColumnNames().parse(in)) { - final Iterator records = parser.iterator(); - final CSVRecord record = records.next(); - // Expect the null header to be missing - @SuppressWarnings("resource") - final CSVParser recordParser = record.getParser(); - assertEquals(Arrays.asList("header1", "header3"), recordParser.getHeaderNames()); - assertEquals(2, recordParser.getHeaderMap().size()); - } - } - - @Test - public void testIgnoreCaseHeaderMapping() throws Exception { - final Reader reader = new StringReader("1,2,3"); - try (final CSVParser parser = CSVFormat.DEFAULT.withHeader("One", "TWO", "three").withIgnoreHeaderCase().parse(reader)) { - final Iterator records = parser.iterator(); - final CSVRecord record = records.next(); - assertEquals("1", record.get("one")); - assertEquals("2", record.get("two")); - assertEquals("3", record.get("THREE")); - } - } - - @Test - public void testIgnoreEmptyLines() throws IOException { - final String code = "\nfoo,baar\n\r\n,\n\n,world\r\n\n"; - // String code = "world\r\n\n"; - // String code = "foo;baar\r\n\r\nhello;\r\n\r\nworld;\r\n"; - try (final CSVParser parser = CSVParser.parse(code, CSVFormat.DEFAULT)) { - final List records = parser.getRecords(); - assertEquals(3, records.size()); - } - } - - @Test - public void testInvalidFormat() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withDelimiter(CR)); - } - - @Test - public void testIterator() throws Exception { - final Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); - try (final CSVParser parser = CSVFormat.DEFAULT.parse(in)) { - final Iterator iterator = parser.iterator(); - assertTrue(iterator.hasNext()); - assertThrows(UnsupportedOperationException.class, iterator::remove); - assertArrayEquals(new String[] { "a", "b", "c" }, iterator.next().values()); - assertArrayEquals(new String[] { "1", "2", "3" }, iterator.next().values()); - assertTrue(iterator.hasNext()); - assertTrue(iterator.hasNext()); - assertTrue(iterator.hasNext()); - assertArrayEquals(new String[] { "x", "y", "z" }, iterator.next().values()); - assertFalse(iterator.hasNext()); - assertThrows(NoSuchElementException.class, iterator::next); - } - } - - @Test - public void testIteratorSequenceBreaking() throws IOException { - final String fiveRows = "1\n2\n3\n4\n5\n"; - // Iterator hasNext() shouldn't break sequence - try (CSVParser parser = CSVFormat.DEFAULT.parse(new StringReader(fiveRows))) { - final Iterator iter = parser.iterator(); - int recordNumber = 0; - while (iter.hasNext()) { - final CSVRecord record = iter.next(); - recordNumber++; - assertEquals(String.valueOf(recordNumber), record.get(0)); - if (recordNumber >= 2) { - break; - } - } - iter.hasNext(); - while (iter.hasNext()) { - final CSVRecord record = iter.next(); - recordNumber++; - assertEquals(String.valueOf(recordNumber), record.get(0)); - } - } - // Consecutive enhanced for loops shouldn't break sequence - try (CSVParser parser = CSVFormat.DEFAULT.parse(new StringReader(fiveRows))) { - int recordNumber = 0; - for (final CSVRecord record : parser) { - recordNumber++; - assertEquals(String.valueOf(recordNumber), record.get(0)); - if (recordNumber >= 2) { - break; - } - } - for (final CSVRecord record : parser) { - recordNumber++; - assertEquals(String.valueOf(recordNumber), record.get(0)); - } - } - // Consecutive enhanced for loops with hasNext() peeking shouldn't break sequence - try (CSVParser parser = CSVFormat.DEFAULT.parse(new StringReader(fiveRows))) { - int recordNumber = 0; - for (final CSVRecord record : parser) { - recordNumber++; - assertEquals(String.valueOf(recordNumber), record.get(0)); - if (recordNumber >= 2) { - break; - } - } - parser.iterator().hasNext(); - for (final CSVRecord record : parser) { - recordNumber++; - assertEquals(String.valueOf(recordNumber), record.get(0)); - } - } - } - - @Test - public void testLineFeedEndings() throws IOException { - final String code = "foo\nbaar,\nhello,world\n,kanu"; - try (final CSVParser parser = CSVParser.parse(code, CSVFormat.DEFAULT)) { - final List records = parser.getRecords(); - assertEquals(4, records.size()); - } - } - - @Test - public void testMappedButNotSetAsOutlook2007ContactExport() throws Exception { - final Reader in = new StringReader("a,b,c\n1,2\nx,y,z"); - try (final CSVParser parser = CSVFormat.DEFAULT.withHeader("A", "B", "C").withSkipHeaderRecord().parse(in)) { - final Iterator records = parser.iterator(); - CSVRecord record; - // 1st record - record = records.next(); - assertTrue(record.isMapped("A")); - assertTrue(record.isMapped("B")); - assertTrue(record.isMapped("C")); - assertTrue(record.isSet("A")); - assertTrue(record.isSet("B")); - assertFalse(record.isSet("C")); - assertEquals("1", record.get("A")); - assertEquals("2", record.get("B")); - assertFalse(record.isConsistent()); - // 2nd record - record = records.next(); - assertTrue(record.isMapped("A")); - assertTrue(record.isMapped("B")); - assertTrue(record.isMapped("C")); - assertTrue(record.isSet("A")); - assertTrue(record.isSet("B")); - assertTrue(record.isSet("C")); - assertEquals("x", record.get("A")); - assertEquals("y", record.get("B")); - assertEquals("z", record.get("C")); - assertTrue(record.isConsistent()); - // end - assertFalse(records.hasNext()); - } - } - - @Test - @Disabled - public void testMongoDbCsv() throws Exception { - try (final CSVParser parser = CSVParser.parse("\"a a\",b,c" + LF + "d,e,f", CSVFormat.MONGODB_CSV)) { - final Iterator itr1 = parser.iterator(); - final Iterator itr2 = parser.iterator(); - - final CSVRecord first = itr1.next(); - assertEquals("a a", first.get(0)); - assertEquals("b", first.get(1)); - assertEquals("c", first.get(2)); - - final CSVRecord second = itr2.next(); - assertEquals("d", second.get(0)); - assertEquals("e", second.get(1)); - assertEquals("f", second.get(2)); - } - } - - @Test - // TODO this may lead to strange behavior, throw an exception if iterator() has already been called? - public void testMultipleIterators() throws Exception { - try (final CSVParser parser = CSVParser.parse("a,b,c" + CRLF + "d,e,f", CSVFormat.DEFAULT)) { - final Iterator itr1 = parser.iterator(); - - final CSVRecord first = itr1.next(); - assertEquals("a", first.get(0)); - assertEquals("b", first.get(1)); - assertEquals("c", first.get(2)); - - final CSVRecord second = itr1.next(); - assertEquals("d", second.get(0)); - assertEquals("e", second.get(1)); - assertEquals("f", second.get(2)); - } - } - - @Test - public void testNewCSVParserNullReaderFormat() { - assertThrows(NullPointerException.class, () -> new CSVParser(null, CSVFormat.DEFAULT)); - } - - @Test - public void testNewCSVParserReaderNullFormat() { - assertThrows(NullPointerException.class, () -> new CSVParser(new StringReader(""), null)); - } - - @Test - public void testNoHeaderMap() throws Exception { - try (final CSVParser parser = CSVParser.parse("a,b,c\n1,2,3\nx,y,z", CSVFormat.DEFAULT)) { - assertNull(parser.getHeaderMap()); - } - } - - @Test - public void testNotValueCSV() throws IOException { - final String source = "#"; - final CSVFormat csvFormat = CSVFormat.DEFAULT.withCommentMarker('#'); - try (final CSVParser csvParser = csvFormat.parse(new StringReader(source))) { - final CSVRecord csvRecord = csvParser.nextRecord(); - assertNull(csvRecord); - } - } - - @Test - public void testParse() throws Exception { - final ClassLoader loader = ClassLoader.getSystemClassLoader(); - final URL url = loader.getResource("org/apache/commons/csv/CSVFileParser/test.csv"); - final CSVFormat format = CSVFormat.DEFAULT.builder().setHeader("A", "B", "C", "D").get(); - final Charset charset = StandardCharsets.UTF_8; - // Reader - try (final CSVParser parser = CSVParser.parse(new InputStreamReader(url.openStream(), charset), format)) { - parseFully(parser); - } - try (final CSVParser parser = CSVParser.builder().setReader(new InputStreamReader(url.openStream(), charset)).setFormat(format).get()) { - parseFully(parser); - } - // String - final Path path = Paths.get(url.toURI()); - final String string = new String(Files.readAllBytes(path), charset); - try (final CSVParser parser = CSVParser.parse(string, format)) { - parseFully(parser); - } - try (final CSVParser parser = CSVParser.builder().setCharSequence(string).setFormat(format).get()) { - parseFully(parser); - } - // File - final File file = new File(url.toURI()); - try (final CSVParser parser = CSVParser.parse(file, charset, format)) { - parseFully(parser); - } - try (final CSVParser parser = CSVParser.builder().setFile(file).setCharset(charset).setFormat(format).get()) { - parseFully(parser); - } - // InputStream - try (final CSVParser parser = CSVParser.parse(url.openStream(), charset, format)) { - parseFully(parser); - } - try (final CSVParser parser = CSVParser.builder().setInputStream(url.openStream()).setCharset(charset).setFormat(format).get()) { - parseFully(parser); - } - // Path - try (final CSVParser parser = CSVParser.parse(path, charset, format)) { - parseFully(parser); - } - try (final CSVParser parser = CSVParser.builder().setPath(path).setCharset(charset).setFormat(format).get()) { - parseFully(parser); - } - // URL - try (final CSVParser parser = CSVParser.parse(url, charset, format)) { - parseFully(parser); - } - try (final CSVParser parser = CSVParser.builder().setURI(url.toURI()).setCharset(charset).setFormat(format).get()) { - parseFully(parser); - } - // InputStreamReader - try (final CSVParser parser = new CSVParser(new InputStreamReader(url.openStream(), charset), format)) { - parseFully(parser); - } - try (final CSVParser parser = CSVParser.builder().setReader(new InputStreamReader(url.openStream(), charset)).setFormat(format).get()) { - parseFully(parser); - } - // InputStreamReader with longs - try (final CSVParser parser = new CSVParser(new InputStreamReader(url.openStream(), charset), format, /* characterOffset= */0, /* recordNumber= */1)) { - parseFully(parser); - } - try (final CSVParser parser = CSVParser.builder().setReader(new InputStreamReader(url.openStream(), charset)).setFormat(format).setCharacterOffset(0) - .setRecordNumber(0).get()) { - parseFully(parser); - } - } - - @Test - public void testParseFileNullFormat() { - assertThrows(NullPointerException.class, () -> CSVParser.parse(new File("CSVFileParser/test.csv"), Charset.defaultCharset(), null)); - } - - @Test - public void testParseNullFileFormat() { - assertThrows(NullPointerException.class, () -> CSVParser.parse((File) null, Charset.defaultCharset(), CSVFormat.DEFAULT)); - } - - @Test - public void testParseNullPathFormat() { - assertThrows(NullPointerException.class, () -> CSVParser.parse((Path) null, Charset.defaultCharset(), CSVFormat.DEFAULT)); - } - - @Test - public void testParseNullStringFormat() { - assertThrows(NullPointerException.class, () -> CSVParser.parse((String) null, CSVFormat.DEFAULT)); - } - - @Test - public void testParseNullUrlCharsetFormat() { - assertThrows(NullPointerException.class, () -> CSVParser.parse((URL) null, Charset.defaultCharset(), CSVFormat.DEFAULT)); - } - - @Test - public void testParserUrlNullCharsetFormat() { - assertThrows(NullPointerException.class, () -> CSVParser.parse(new URL("https://commons.apache.org"), null, CSVFormat.DEFAULT)); - } - - @Test - public void testParseStringNullFormat() { - assertThrows(NullPointerException.class, () -> CSVParser.parse("csv data", (CSVFormat) null)); - } - - @Test - public void testParseUrlCharsetNullFormat() { - assertThrows(NullPointerException.class, () -> CSVParser.parse(new URL("https://commons.apache.org"), Charset.defaultCharset(), null)); - } - - @Test - public void testParseWithDelimiterStringWithEscape() throws IOException { - final String source = "a![!|!]b![|]c[|]xyz\r\nabc[abc][|]xyz"; - final CSVFormat csvFormat = CSVFormat.DEFAULT.builder().setDelimiter("[|]").setEscape('!').get(); - try (CSVParser csvParser = csvFormat.parse(new StringReader(source))) { - CSVRecord csvRecord = csvParser.nextRecord(); - assertEquals("a[|]b![|]c", csvRecord.get(0)); - assertEquals("xyz", csvRecord.get(1)); - csvRecord = csvParser.nextRecord(); - assertEquals("abc[abc]", csvRecord.get(0)); - assertEquals("xyz", csvRecord.get(1)); - } - } - - @Test - public void testParseWithDelimiterStringWithQuote() throws IOException { - final String source = "'a[|]b[|]c'[|]xyz\r\nabc[abc][|]xyz"; - final CSVFormat csvFormat = CSVFormat.DEFAULT.builder().setDelimiter("[|]").setQuote('\'').get(); - try (CSVParser csvParser = csvFormat.parse(new StringReader(source))) { - CSVRecord csvRecord = csvParser.nextRecord(); - assertEquals("a[|]b[|]c", csvRecord.get(0)); - assertEquals("xyz", csvRecord.get(1)); - csvRecord = csvParser.nextRecord(); - assertEquals("abc[abc]", csvRecord.get(0)); - assertEquals("xyz", csvRecord.get(1)); - } - } - - @Test - public void testParseWithDelimiterWithEscape() throws IOException { - final String source = "a!,b!,c,xyz"; - final CSVFormat csvFormat = CSVFormat.DEFAULT.withEscape('!'); - try (CSVParser csvParser = csvFormat.parse(new StringReader(source))) { - final CSVRecord csvRecord = csvParser.nextRecord(); - assertEquals("a,b,c", csvRecord.get(0)); - assertEquals("xyz", csvRecord.get(1)); - } - } - - @Test - public void testParseWithDelimiterWithQuote() throws IOException { - final String source = "'a,b,c',xyz"; - final CSVFormat csvFormat = CSVFormat.DEFAULT.withQuote('\''); - try (CSVParser csvParser = csvFormat.parse(new StringReader(source))) { - final CSVRecord csvRecord = csvParser.nextRecord(); - assertEquals("a,b,c", csvRecord.get(0)); - assertEquals("xyz", csvRecord.get(1)); - } - } - - @Test - public void testParseWithQuoteThrowsException() { - final CSVFormat csvFormat = CSVFormat.DEFAULT.withQuote('\''); - assertThrows(IOException.class, () -> csvFormat.parse(new StringReader("'a,b,c','")).nextRecord()); - assertThrows(IOException.class, () -> csvFormat.parse(new StringReader("'a,b,c'abc,xyz")).nextRecord()); - assertThrows(IOException.class, () -> csvFormat.parse(new StringReader("'abc'a,b,c',xyz")).nextRecord()); - } - - @Test - public void testParseWithQuoteWithEscape() throws IOException { - final String source = "'a?,b?,c?d',xyz"; - final CSVFormat csvFormat = CSVFormat.DEFAULT.withQuote('\'').withEscape('?'); - try (CSVParser csvParser = csvFormat.parse(new StringReader(source))) { - final CSVRecord csvRecord = csvParser.nextRecord(); - assertEquals("a,b,c?d", csvRecord.get(0)); - assertEquals("xyz", csvRecord.get(1)); - } - } - - @ParameterizedTest - @EnumSource(CSVFormat.Predefined.class) - public void testParsingPrintedEmptyFirstColumn(final CSVFormat.Predefined format) throws Exception { - final String[][] lines = { { "a", "b" }, { "", "x" } }; - final StringWriter buf = new StringWriter(); - try (CSVPrinter printer = new CSVPrinter(buf, format.getFormat())) { - printer.printRecords(Stream.of(lines)); - } - try (CSVParser csvRecords = CSVParser.builder() - .setReader(new StringReader(buf.toString())) - .setFormat(format.getFormat()) - .get()) { - for (final String[] line : lines) { - assertArrayEquals(line, csvRecords.nextRecord().values()); - } - assertNull(csvRecords.nextRecord()); - } - } - - @Test - public void testProvidedHeader() throws Exception { - final Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); - - try (final CSVParser parser = CSVFormat.DEFAULT.withHeader("A", "B", "C").parse(in)) { - final Iterator records = parser.iterator(); - - for (int i = 0; i < 3; i++) { - assertTrue(records.hasNext()); - final CSVRecord record = records.next(); - assertTrue(record.isMapped("A")); - assertTrue(record.isMapped("B")); - assertTrue(record.isMapped("C")); - assertFalse(record.isMapped("NOT MAPPED")); - assertEquals(record.get(0), record.get("A")); - assertEquals(record.get(1), record.get("B")); - assertEquals(record.get(2), record.get("C")); - } - - assertFalse(records.hasNext()); - } - } - - @Test - public void testProvidedHeaderAuto() throws Exception { - final Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); - - try (final CSVParser parser = CSVFormat.DEFAULT.withHeader().parse(in)) { - final Iterator records = parser.iterator(); - - for (int i = 0; i < 2; i++) { - assertTrue(records.hasNext()); - final CSVRecord record = records.next(); - assertTrue(record.isMapped("a")); - assertTrue(record.isMapped("b")); - assertTrue(record.isMapped("c")); - assertFalse(record.isMapped("NOT MAPPED")); - assertEquals(record.get(0), record.get("a")); - assertEquals(record.get(1), record.get("b")); - assertEquals(record.get(2), record.get("c")); - } - - assertFalse(records.hasNext()); - } - } - - @Test - public void testRepeatedHeadersAreReturnedInCSVRecordHeaderNames() throws IOException { - final Reader in = new StringReader("header1,header2,header1\n1,2,3\n4,5,6"); - try (final CSVParser parser = CSVFormat.DEFAULT.withFirstRecordAsHeader().withTrim().parse(in)) { - final Iterator records = parser.iterator(); - final CSVRecord record = records.next(); - @SuppressWarnings("resource") - final CSVParser recordParser = record.getParser(); - assertEquals(Arrays.asList("header1", "header2", "header1"), recordParser.getHeaderNames()); - } - } - - @Test - public void testRoundtrip() throws Exception { - final StringWriter out = new StringWriter(); - final String data = "a,b,c\r\n1,2,3\r\nx,y,z\r\n"; - try (final CSVPrinter printer = new CSVPrinter(out, CSVFormat.DEFAULT); - final CSVParser parse = CSVParser.parse(data, CSVFormat.DEFAULT)) { - for (final CSVRecord record : parse) { - printer.printRecord(record); - } - assertEquals(data, out.toString()); - } - } - - @Test - public void testSkipAutoHeader() throws Exception { - final Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); - try (final CSVParser parser = CSVFormat.DEFAULT.withHeader().parse(in)) { - final Iterator records = parser.iterator(); - final CSVRecord record = records.next(); - assertEquals("1", record.get("a")); - assertEquals("2", record.get("b")); - assertEquals("3", record.get("c")); - } - } - - @Test - public void testSkipHeaderOverrideDuplicateHeaders() throws Exception { - final Reader in = new StringReader("a,a,a\n1,2,3\nx,y,z"); - try (final CSVParser parser = CSVFormat.DEFAULT.withHeader("X", "Y", "Z").withSkipHeaderRecord().parse(in)) { - final Iterator records = parser.iterator(); - final CSVRecord record = records.next(); - assertEquals("1", record.get("X")); - assertEquals("2", record.get("Y")); - assertEquals("3", record.get("Z")); - } - } - - @Test - public void testSkipSetAltHeaders() throws Exception { - final Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); - try (final CSVParser parser = CSVFormat.DEFAULT.withHeader("X", "Y", "Z").withSkipHeaderRecord().parse(in)) { - final Iterator records = parser.iterator(); - final CSVRecord record = records.next(); - assertEquals("1", record.get("X")); - assertEquals("2", record.get("Y")); - assertEquals("3", record.get("Z")); - } - } - - @Test - public void testSkipSetHeader() throws Exception { - final Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); - try (final CSVParser parser = CSVFormat.DEFAULT.withHeader("a", "b", "c").withSkipHeaderRecord().parse(in)) { - final Iterator records = parser.iterator(); - final CSVRecord record = records.next(); - assertEquals("1", record.get("a")); - assertEquals("2", record.get("b")); - assertEquals("3", record.get("c")); - } - } - - @Test - @Disabled - public void testStartWithEmptyLinesThenHeaders() throws Exception { - final String[] codes = { "\r\n\r\n\r\nhello,\r\n\r\n\r\n", "hello,\n\n\n", "hello,\"\"\r\n\r\n\r\n", "hello,\"\"\n\n\n" }; - final String[][] res = { { "hello", "" }, { "" }, // Excel format does not ignore empty lines - { "" } }; - for (final String code : codes) { - try (final CSVParser parser = CSVParser.parse(code, CSVFormat.EXCEL)) { - final List records = parser.getRecords(); - assertEquals(res.length, records.size()); - assertFalse(records.isEmpty()); - for (int i = 0; i < res.length; i++) { - assertArrayEquals(res[i], records.get(i).values()); - } - } - } - } - - @Test - public void testStream() throws Exception { - final Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); - try (final CSVParser parser = CSVFormat.DEFAULT.parse(in)) { - final List list = parser.stream().collect(Collectors.toList()); - assertFalse(list.isEmpty()); - assertArrayEquals(new String[] { "a", "b", "c" }, list.get(0).values()); - assertArrayEquals(new String[] { "1", "2", "3" }, list.get(1).values()); - assertArrayEquals(new String[] { "x", "y", "z" }, list.get(2).values()); - } - } - - @Test - public void testThrowExceptionWithLineAndPosition() throws IOException { - final String csvContent = "col1,col2,col3,col4,col5,col6,col7,col8,col9,col10\nrec1,rec2,rec3,rec4,rec5,rec6,rec7,rec8,\"\"rec9\"\",rec10"; - final StringReader stringReader = new StringReader(csvContent); - // @formatter:off - final CSVFormat csvFormat = CSVFormat.DEFAULT.builder() - .setHeader() - .setSkipHeaderRecord(true) - .get(); - // @formatter:on - try (CSVParser csvParser = csvFormat.parse(stringReader)) { - final UncheckedIOException exception = assertThrows(UncheckedIOException.class, csvParser::getRecords); - assertInstanceOf(CSVException.class, exception.getCause()); - assertTrue(exception.getMessage().contains("Invalid character between encapsulated token and delimiter at line: 2, position: 94"), - exception::getMessage); - } - } - - @Test - public void testTrailingDelimiter() throws Exception { - final Reader in = new StringReader("a,a,a,\n\"1\",\"2\",\"3\",\nx,y,z,"); - try (final CSVParser parser = CSVFormat.DEFAULT.withHeader("X", "Y", "Z").withSkipHeaderRecord().withTrailingDelimiter().parse(in)) { - final Iterator records = parser.iterator(); - final CSVRecord record = records.next(); - assertEquals("1", record.get("X")); - assertEquals("2", record.get("Y")); - assertEquals("3", record.get("Z")); - assertEquals(3, record.size()); - } - } - - @Test - public void testTrim() throws Exception { - final Reader in = new StringReader("a,a,a\n\" 1 \",\" 2 \",\" 3 \"\nx,y,z"); - try (final CSVParser parser = CSVFormat.DEFAULT.withHeader("X", "Y", "Z").withSkipHeaderRecord().withTrim().parse(in)) { - final Iterator records = parser.iterator(); - final CSVRecord record = records.next(); - assertEquals("1", record.get("X")); - assertEquals("2", record.get("Y")); - assertEquals("3", record.get("Z")); - assertEquals(3, record.size()); - } - } - - private void validateLineNumbers(final String lineSeparator) throws IOException { - try (final CSVParser parser = CSVParser.parse("a" + lineSeparator + "b" + lineSeparator + "c", CSVFormat.DEFAULT.withRecordSeparator(lineSeparator))) { - assertEquals(0, parser.getCurrentLineNumber()); - assertNotNull(parser.nextRecord()); - assertEquals(1, parser.getCurrentLineNumber()); - assertNotNull(parser.nextRecord()); - assertEquals(2, parser.getCurrentLineNumber()); - assertNotNull(parser.nextRecord()); - // Read EOF without EOL should 3 - assertEquals(3, parser.getCurrentLineNumber()); - assertNull(parser.nextRecord()); - // Read EOF without EOL should 3 - assertEquals(3, parser.getCurrentLineNumber()); - } - } - - private void validateRecordNumbers(final String lineSeparator) throws IOException { - try (final CSVParser parser = CSVParser.parse("a" + lineSeparator + "b" + lineSeparator + "c", CSVFormat.DEFAULT.withRecordSeparator(lineSeparator))) { - CSVRecord record; - assertEquals(0, parser.getRecordNumber()); - assertNotNull(record = parser.nextRecord()); - assertEquals(1, record.getRecordNumber()); - assertEquals(1, parser.getRecordNumber()); - assertNotNull(record = parser.nextRecord()); - assertEquals(2, record.getRecordNumber()); - assertEquals(2, parser.getRecordNumber()); - assertNotNull(record = parser.nextRecord()); - assertEquals(3, record.getRecordNumber()); - assertEquals(3, parser.getRecordNumber()); - assertNull(record = parser.nextRecord()); - assertEquals(3, parser.getRecordNumber()); - } - } - - private void validateRecordPosition(final String lineSeparator) throws IOException { - final String nl = lineSeparator; // used as linebreak in values for better distinction - final String code = "a,b,c" + lineSeparator + "1,2,3" + lineSeparator + - // to see if recordPosition correctly points to the enclosing quote - "'A" + nl + "A','B" + nl + "B',CC" + lineSeparator + - // unicode test... not very relevant while operating on strings instead of bytes, but for - // completeness... - "\u00c4,\u00d6,\u00dc" + lineSeparator + "EOF,EOF,EOF"; - final CSVFormat format = CSVFormat.newFormat(',').withQuote('\'').withRecordSeparator(lineSeparator); - final long positionRecord3; - try (CSVParser parser = CSVParser.parse(code, format)) { - CSVRecord record; - assertEquals(0, parser.getRecordNumber()); - // nextRecord - assertNotNull(record = parser.nextRecord()); - assertEquals(1, record.getRecordNumber()); - assertEquals(code.indexOf('a'), record.getCharacterPosition()); - // nextRecord - assertNotNull(record = parser.nextRecord()); - assertEquals(2, record.getRecordNumber()); - assertEquals(code.indexOf('1'), record.getCharacterPosition()); - // nextRecord - assertNotNull(record = parser.nextRecord()); - positionRecord3 = record.getCharacterPosition(); - assertEquals(3, record.getRecordNumber()); - assertEquals(code.indexOf("'A"), record.getCharacterPosition()); - assertEquals("A" + lineSeparator + "A", record.get(0)); - assertEquals("B" + lineSeparator + "B", record.get(1)); - assertEquals("CC", record.get(2)); - // nextRecord - assertNotNull(record = parser.nextRecord()); - assertEquals(4, record.getRecordNumber()); - assertEquals(code.indexOf('\u00c4'), record.getCharacterPosition()); - // nextRecord - assertNotNull(record = parser.nextRecord()); - assertEquals(5, record.getRecordNumber()); - assertEquals(code.indexOf("EOF"), record.getCharacterPosition()); - } - // now try to read starting at record 3 - try (CSVParser parser = CSVParser.builder() - .setReader(new StringReader(code.substring((int) positionRecord3))) - .setFormat(format) - .setCharacterOffset(positionRecord3) - .setRecordNumber(3) - .get()) { - CSVRecord record; - // nextRecord - assertNotNull(record = parser.nextRecord()); - assertEquals(3, record.getRecordNumber()); - assertEquals(code.indexOf("'A"), record.getCharacterPosition()); - assertEquals("A" + lineSeparator + "A", record.get(0)); - assertEquals("B" + lineSeparator + "B", record.get(1)); - assertEquals("CC", record.get(2)); - // nextRecord - assertNotNull(record = parser.nextRecord()); - assertEquals(4, record.getRecordNumber()); - assertEquals(code.indexOf('\u00c4'), record.getCharacterPosition()); - assertEquals("\u00c4", record.get(0)); - } // again with ctor - try (CSVParser parser = new CSVParser(new StringReader(code.substring((int) positionRecord3)), format, positionRecord3, 3)) { - CSVRecord record; - // nextRecord - assertNotNull(record = parser.nextRecord()); - assertEquals(3, record.getRecordNumber()); - assertEquals(code.indexOf("'A"), record.getCharacterPosition()); - assertEquals("A" + lineSeparator + "A", record.get(0)); - assertEquals("B" + lineSeparator + "B", record.get(1)); - assertEquals("CC", record.get(2)); - // nextRecord - assertNotNull(record = parser.nextRecord()); - assertEquals(4, record.getRecordNumber()); - assertEquals(code.indexOf('\u00c4'), record.getCharacterPosition()); - assertEquals("\u00c4", record.get(0)); - } - } -} +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.commons.csv; + +import static org.apache.commons.csv.Constants.CR; +import static org.apache.commons.csv.Constants.CRLF; +import static org.apache.commons.csv.Constants.LF; +import static org.apache.commons.csv.CsvAssertions.assertValuesEquals; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.io.PipedReader; +import java.io.PipedWriter; +import java.io.Reader; +import java.io.StringReader; +import java.io.StringWriter; +import java.io.UncheckedIOException; +import java.net.URL; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.NoSuchElementException; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import org.apache.commons.io.input.BOMInputStream; +import org.apache.commons.io.input.BrokenInputStream; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.EnumSource; +import org.junit.jupiter.params.provider.ValueSource; + +/** + * Tests {@link CSVParser}. + * + * The test are organized in three different sections: The 'setter/getter' section, the lexer section and finally the parser section. In case a test fails, you + * should follow a top-down approach for fixing a potential bug (its likely that the parser itself fails if the lexer has problems...). + */ +class CSVParserTest { + + private static final CSVFormat EXCEL_WITH_HEADER = CSVFormat.EXCEL.withHeader(); + + private static final Charset UTF_8 = StandardCharsets.UTF_8; + + private static final String UTF_8_NAME = UTF_8.name(); + + // @formatter:off + private static final String CSV_INPUT = "a,b,c,d\n" + + " a , b , 1 2 \n" + + "\"foo baar\", b,\n" + + // + " \"foo\n,,\n\"\",,\n\\\"\",d,e\n"; + " \"foo\n,,\n\"\",,\n\"\"\",d,e\n"; // changed to use standard CSV escaping + // @formatter:on + + private static final String CSV_INPUT_1 = "a,b,c,d"; + + private static final String CSV_INPUT_2 = "a,b,1 2"; + + private static final String[][] RESULT = { { "a", "b", "c", "d" }, { "a", "b", "1 2" }, { "foo baar", "b", "" }, { "foo\n,,\n\",,\n\"", "d", "e" } }; + + // CSV with no header comments + private static final String CSV_INPUT_NO_COMMENT = "A,B" + CRLF + "1,2" + CRLF; + + // CSV with a header comment + private static final String CSV_INPUT_HEADER_COMMENT = "# header comment" + CRLF + "A,B" + CRLF + "1,2" + CRLF; + + // CSV with a single line header and trailer comment + private static final String CSV_INPUT_HEADER_TRAILER_COMMENT = "# header comment" + CRLF + "A,B" + CRLF + "1,2" + CRLF + "# comment"; + + // CSV with a multi-line header and trailer comment + private static final String CSV_INPUT_MULTILINE_HEADER_TRAILER_COMMENT = "# multi-line" + CRLF + "# header comment" + CRLF + "A,B" + CRLF + "1,2" + CRLF + + "# multi-line" + CRLF + "# comment"; + + // Format with auto-detected header + private static final CSVFormat FORMAT_AUTO_HEADER = CSVFormat.Builder.create(CSVFormat.DEFAULT).setCommentMarker('#').setHeader().get(); + + // Format with explicit header + // @formatter:off + private static final CSVFormat FORMAT_EXPLICIT_HEADER = CSVFormat.Builder.create(CSVFormat.DEFAULT) + .setSkipHeaderRecord(true) + .setCommentMarker('#') + .setHeader("A", "B") + .get(); + // @formatter:on + + // Format with explicit header that does not skip the header line + // @formatter:off + CSVFormat FORMAT_EXPLICIT_HEADER_NOSKIP = CSVFormat.Builder.create(CSVFormat.DEFAULT) + .setCommentMarker('#') + .setHeader("A", "B") + .get(); + // @formatter:on + + @SuppressWarnings("resource") // caller releases + private BOMInputStream createBOMInputStream(final String resource) throws IOException { + return new BOMInputStream(ClassLoader.getSystemClassLoader().getResource(resource).openStream()); + } + + CSVRecord parse(final CSVParser parser, final int failParseRecordNo) throws IOException { + if (parser.getRecordNumber() + 1 == failParseRecordNo) { + assertThrows(IOException.class, () -> parser.nextRecord()); + return null; + } + return parser.nextRecord(); + } + + private void parseFully(final CSVParser parser) { + parser.forEach(Assertions::assertNotNull); + } + + @Test + void testBackslashEscaping() throws IOException { + // To avoid confusion over the need for escaping chars in java code, + // We will test with a forward slash as the escape char, and a single + // quote as the encapsulator. + + // @formatter:off + final String code = "one,two,three\n" + // 0 + "'',''\n" + // 1) empty encapsulators + "/',/'\n" + // 2) single encapsulators + "'/'','/''\n" + // 3) single encapsulators encapsulated via escape + "'''',''''\n" + // 4) single encapsulators encapsulated via doubling + "/,,/,\n" + // 5) separator escaped + "//,//\n" + // 6) escape escaped + "'//','//'\n" + // 7) escape escaped in encapsulation + " 8 , \"quoted \"\" /\" // string\" \n" + // don't eat spaces + "9, /\n \n" + // escaped newline + ""; + final String[][] res = {{"one", "two", "three"}, // 0 + {"", ""}, // 1 + {"'", "'"}, // 2 + {"'", "'"}, // 3 + {"'", "'"}, // 4 + {",", ","}, // 5 + {"/", "/"}, // 6 + {"/", "/"}, // 7 + {" 8 ", " \"quoted \"\" /\" / string\" "}, {"9", " \n "} }; + // @formatter:on + final CSVFormat format = CSVFormat.newFormat(',').withQuote('\'').withRecordSeparator(CRLF).withEscape('/').withIgnoreEmptyLines(); + try (CSVParser parser = CSVParser.parse(code, format)) { + final List records = parser.getRecords(); + assertFalse(records.isEmpty()); + Utils.compare("Records do not match expected result", res, records, -1); + } + } + + @Test + void testBackslashEscaping2() throws IOException { + // To avoid confusion over the need for escaping chars in java code, + // We will test with a forward slash as the escape char, and a single + // quote as the encapsulator. + // @formatter:off + final String code = " , , \n" + // 1) + " \t , , \n" + // 2) + " // , /, , /,\n" + // 3) + ""; + final String[][] res = {{" ", " ", " "}, // 1 + {" \t ", " ", " "}, // 2 + {" / ", " , ", " ,"}, // 3 + }; + // @formatter:on + final CSVFormat format = CSVFormat.newFormat(',').withRecordSeparator(CRLF).withEscape('/').withIgnoreEmptyLines(); + try (CSVParser parser = CSVParser.parse(code, format)) { + final List records = parser.getRecords(); + assertFalse(records.isEmpty()); + Utils.compare("", res, records, -1); + } + } + + @Test + @Disabled + void testBackslashEscapingOld() throws IOException { + // @formatter:off + final String code = "one,two,three\n" + + "on\\\"e,two\n" + + "on\"e,two\n" + + "one,\"tw\\\"o\"\n" + + "one,\"t\\,wo\"\n" + + "one,two,\"th,ree\"\n" + + "\"a\\\\\"\n" + + "a\\,b\n" + + "\"a\\\\,b\""; + // @formatter:on + final String[][] res = { { "one", "two", "three" }, { "on\\\"e", "two" }, { "on\"e", "two" }, { "one", "tw\"o" }, { "one", "t\\,wo" }, // backslash in + // quotes only + // escapes a + // delimiter + // (",") + { "one", "two", "th,ree" }, { "a\\\\" }, // backslash in quotes only escapes a delimiter (",") + { "a\\", "b" }, // a backslash must be returned + { "a\\\\,b" } // backslash in quotes only escapes a delimiter (",") + }; + try (CSVParser parser = CSVParser.parse(code, CSVFormat.DEFAULT)) { + final List records = parser.getRecords(); + assertEquals(res.length, records.size()); + assertFalse(records.isEmpty()); + for (int i = 0; i < res.length; i++) { + assertValuesEquals(res[i], records.get(i)); + } + } + } + + @Test + @Disabled("CSV-107") + void testBOM() throws IOException { + final URL url = ClassLoader.getSystemClassLoader().getResource("org/apache/commons/csv/CSVFileParser/bom.csv"); + try (CSVParser parser = CSVParser.parse(url, StandardCharsets.UTF_8, EXCEL_WITH_HEADER)) { + parser.forEach(record -> assertNotNull(record.get("Date"))); + } + } + + @Test + void testBOMInputStreamParserWithInputStream() throws IOException { + try (BOMInputStream inputStream = createBOMInputStream("org/apache/commons/csv/CSVFileParser/bom.csv"); + CSVParser parser = CSVParser.parse(inputStream, UTF_8, EXCEL_WITH_HEADER)) { + parser.forEach(record -> assertNotNull(record.get("Date"))); + } + } + + @Test + void testBOMInputStreamParserWithReader() throws IOException { + try (Reader reader = new InputStreamReader(createBOMInputStream("org/apache/commons/csv/CSVFileParser/bom.csv"), UTF_8_NAME); + CSVParser parser = CSVParser.builder() + .setReader(reader) + .setFormat(EXCEL_WITH_HEADER) + .get()) { + parser.forEach(record -> assertNotNull(record.get("Date"))); + } + } + + @Test + void testBOMInputStreamParseWithReader() throws IOException { + try (Reader reader = new InputStreamReader(createBOMInputStream("org/apache/commons/csv/CSVFileParser/bom.csv"), UTF_8_NAME); + CSVParser parser = CSVParser.builder() + .setReader(reader) + .setFormat(EXCEL_WITH_HEADER) + .get()) { + parser.forEach(record -> assertNotNull(record.get("Date"))); + } + } + + @Test + void testCarriageReturnEndings() throws IOException { + final String string = "foo\rbaar,\rhello,world\r,kanu"; + try (CSVParser parser = CSVParser.builder().setCharSequence(string).get()) { + final List records = parser.getRecords(); + assertEquals(4, records.size()); + } + } + + @Test + void testCarriageReturnLineFeedEndings() throws IOException { + final String string = "foo\r\nbaar,\r\nhello,world\r\n,kanu"; + try (CSVParser parser = CSVParser.builder().setCharSequence(string).get()) { + final List records = parser.getRecords(); + assertEquals(4, records.size()); + } + } + + @Test + void testClose() throws Exception { + final Reader in = new StringReader("# comment\na,b,c\n1,2,3\nx,y,z"); + final Iterator records; + try (CSVParser parser = CSVFormat.DEFAULT.withCommentMarker('#').withHeader().parse(in)) { + records = parser.iterator(); + assertTrue(records.hasNext()); + } + assertFalse(records.hasNext()); + assertThrows(NoSuchElementException.class, records::next); + } + + @Test + void testCSV141CSVFormat_DEFAULT() throws Exception { + testCSV141Failure(CSVFormat.DEFAULT, 3); + } + + @Test + void testCSV141CSVFormat_INFORMIX_UNLOAD() throws Exception { + testCSV141Failure(CSVFormat.INFORMIX_UNLOAD, 1); + } + + @Test + void testCSV141CSVFormat_INFORMIX_UNLOAD_CSV() throws Exception { + testCSV141Failure(CSVFormat.INFORMIX_UNLOAD_CSV, 3); + } + + @Test + void testCSV141CSVFormat_ORACLE() throws Exception { + testCSV141Failure(CSVFormat.ORACLE, 2); + } + + @Test + void testCSV141CSVFormat_POSTGRESQL_CSV() throws Exception { + testCSV141Failure(CSVFormat.POSTGRESQL_CSV, 3); + } + + @Test + void testCSV141Excel() throws Exception { + testCSV141Ok(CSVFormat.EXCEL); + } + + private void testCSV141Failure(final CSVFormat format, final int failParseRecordNo) throws IOException { + final Path path = Paths.get("src/test/resources/org/apache/commons/csv/CSV-141/csv-141.csv"); + try (CSVParser parser = CSVParser.parse(path, StandardCharsets.UTF_8, format)) { + // row 1 + CSVRecord record = parse(parser, failParseRecordNo); + if (record == null) { + return; // expected failure + } + assertEquals("1414770317901", record.get(0)); + assertEquals("android.widget.EditText", record.get(1)); + assertEquals("pass sem1 _84*|*", record.get(2)); + assertEquals("0", record.get(3)); + assertEquals("pass sem1 _8", record.get(4)); + assertEquals(5, record.size()); + // row 2 + record = parse(parser, failParseRecordNo); + if (record == null) { + return; // expected failure + } + assertEquals("1414770318470", record.get(0)); + assertEquals("android.widget.EditText", record.get(1)); + assertEquals("pass sem1 _84:|", record.get(2)); + assertEquals("0", record.get(3)); + assertEquals("pass sem1 _84:\\", record.get(4)); + assertEquals(5, record.size()); + // row 3: Fail for certain + assertThrows(IOException.class, () -> parser.nextRecord()); + } + } + + private void testCSV141Ok(final CSVFormat format) throws IOException { + final Path path = Paths.get("src/test/resources/org/apache/commons/csv/CSV-141/csv-141.csv"); + try (CSVParser parser = CSVParser.parse(path, StandardCharsets.UTF_8, format)) { + // row 1 + CSVRecord record = parser.nextRecord(); + assertEquals("1414770317901", record.get(0)); + assertEquals("android.widget.EditText", record.get(1)); + assertEquals("pass sem1 _84*|*", record.get(2)); + assertEquals("0", record.get(3)); + assertEquals("pass sem1 _8", record.get(4)); + assertEquals(5, record.size()); + // row 2 + record = parser.nextRecord(); + assertEquals("1414770318470", record.get(0)); + assertEquals("android.widget.EditText", record.get(1)); + assertEquals("pass sem1 _84:|", record.get(2)); + assertEquals("0", record.get(3)); + assertEquals("pass sem1 _84:\\", record.get(4)); + assertEquals(5, record.size()); + // row 3 + record = parser.nextRecord(); + assertEquals("1414770318327", record.get(0)); + assertEquals("android.widget.EditText", record.get(1)); + assertEquals("pass sem1\n1414770318628\"", record.get(2)); + assertEquals("android.widget.EditText", record.get(3)); + assertEquals("pass sem1 _84*|*", record.get(4)); + assertEquals("0", record.get(5)); + assertEquals("pass sem1\n", record.get(6)); + assertEquals(7, record.size()); + // EOF + record = parser.nextRecord(); + assertNull(record); + } + } + + @Test + void testCSV141RFC4180() throws Exception { + testCSV141Failure(CSVFormat.RFC4180, 3); + } + + @Test + void testCSV235() throws IOException { + final String dqString = "\"aaa\",\"b\"\"bb\",\"ccc\""; // "aaa","b""bb","ccc" + try (CSVParser parser = CSVFormat.RFC4180.parse(new StringReader(dqString))) { + final Iterator records = parser.iterator(); + final CSVRecord record = records.next(); + assertFalse(records.hasNext()); + assertEquals(3, record.size()); + assertEquals("aaa", record.get(0)); + assertEquals("b\"bb", record.get(1)); + assertEquals("ccc", record.get(2)); + } + } + + @Test + void testCSV57() throws Exception { + try (CSVParser parser = CSVParser.parse("", CSVFormat.DEFAULT)) { + final List list = parser.getRecords(); + assertNotNull(list); + assertEquals(0, list.size()); + } + } + + @Test + void testDefaultFormat() throws IOException { + // @formatter:off + final String code = "a,b#\n" + // 1) + "\"\n\",\" \",#\n" + // 2) + "#,\"\"\n" + // 3) + "# Final comment\n" // 4) + ; + // @formatter:on + final String[][] res = { { "a", "b#" }, { "\n", " ", "#" }, { "#", "" }, { "# Final comment" } }; + CSVFormat format = CSVFormat.DEFAULT; + assertFalse(format.isCommentMarkerSet()); + final String[][] resComments = { { "a", "b#" }, { "\n", " ", "#" } }; + try (CSVParser parser = CSVParser.parse(code, format)) { + final List records = parser.getRecords(); + assertFalse(records.isEmpty()); + Utils.compare("Failed to parse without comments", res, records, -1); + format = CSVFormat.DEFAULT.withCommentMarker('#'); + } + try (CSVParser parser = CSVParser.parse(code, format)) { + final List records = parser.getRecords(); + Utils.compare("Failed to parse with comments", resComments, records, -1); + } + } + + @Test + void testDuplicateHeadersAllowedByDefault() throws Exception { + try (CSVParser parser = CSVParser.parse("a,b,a\n1,2,3\nx,y,z", CSVFormat.DEFAULT.withHeader())) { + // noop + } + } + + @Test + void testDuplicateHeadersNotAllowed() { + assertThrows(IllegalArgumentException.class, + () -> CSVParser.parse("a,b,a\n1,2,3\nx,y,z", CSVFormat.DEFAULT.withHeader().withAllowDuplicateHeaderNames(false))); + } + + /** + * With {@code ignoreSurroundingSpaces} enabled and a multi-character delimiter whose first character is whitespace, + * the empty field at the delimiter boundary must survive. The delimiter look-ahead is consumed while skipping + * leading whitespace, so re-evaluating it would drop the empty field and merge the following field's value. + */ + @Test + void testEmptyFieldBeforeWhitespacePrefixedMultiCharacterDelimiter() throws IOException { + final CSVFormat format = CSVFormat.DEFAULT.builder().setDelimiter(" |").setIgnoreSurroundingSpaces(true).get(); + try (CSVParser parser = CSVParser.parse(" |a", format)) { + final List records = parser.getRecords(); + assertEquals(1, records.size()); + assertValuesEquals(new String[] { "", "a" }, records.get(0)); + } + try (CSVParser parser = CSVParser.parse("a | |b", format)) { + final List records = parser.getRecords(); + assertEquals(1, records.size()); + assertValuesEquals(new String[] { "a", "", "b" }, records.get(0)); + } + try (CSVParser parser = CSVParser.parse("a | |b |", format)) { + final List records = parser.getRecords(); + assertEquals(1, records.size()); + assertValuesEquals(new String[] { "a", "", "b", "" }, records.get(0)); + } + } + + @Test + void testEmptyFile() throws Exception { + try (CSVParser parser = CSVParser.parse(Paths.get("src/test/resources/org/apache/commons/csv/empty.txt"), StandardCharsets.UTF_8, + CSVFormat.DEFAULT)) { + assertNull(parser.nextRecord()); + } + } + + @Test + void testEmptyFileHeaderParsing() throws Exception { + try (CSVParser parser = CSVParser.parse("", CSVFormat.DEFAULT.withFirstRecordAsHeader())) { + assertNull(parser.nextRecord()); + assertTrue(parser.getHeaderNames().isEmpty()); + } + } + + @Test + void testEmptyLineBehaviorCSV() throws Exception { + final String[] codes = { "hello,\r\n\r\n\r\n", "hello,\n\n\n", "hello,\"\"\r\n\r\n\r\n", "hello,\"\"\n\n\n" }; + final String[][] res = { { "hello", "" } // CSV format ignores empty lines + }; + for (final String code : codes) { + try (CSVParser parser = CSVParser.parse(code, CSVFormat.DEFAULT)) { + final List records = parser.getRecords(); + assertEquals(res.length, records.size()); + assertFalse(records.isEmpty()); + for (int i = 0; i < res.length; i++) { + assertValuesEquals(res[i], records.get(i)); + } + } + } + } + + @Test + void testEmptyLineBehaviorExcel() throws Exception { + final String[] codes = { "hello,\r\n\r\n\r\n", "hello,\n\n\n", "hello,\"\"\r\n\r\n\r\n", "hello,\"\"\n\n\n" }; + final String[][] res = { { "hello", "" }, { "" }, // Excel format does not ignore empty lines + { "" } }; + for (final String code : codes) { + try (CSVParser parser = CSVParser.parse(code, CSVFormat.EXCEL)) { + final List records = parser.getRecords(); + assertEquals(res.length, records.size()); + assertFalse(records.isEmpty()); + for (int i = 0; i < res.length; i++) { + assertValuesEquals(res[i], records.get(i)); + } + } + } + } + + @Test + void testEmptyString() throws Exception { + try (CSVParser parser = CSVParser.parse("", CSVFormat.DEFAULT)) { + assertNull(parser.nextRecord()); + } + } + + @Test + void testEndOfFileBehaviorCSV() throws Exception { + final String[] codes = { "hello,\r\n\r\nworld,\r\n", "hello,\r\n\r\nworld,", "hello,\r\n\r\nworld,\"\"\r\n", "hello,\r\n\r\nworld,\"\"", + "hello,\r\n\r\nworld,\n", "hello,\r\n\r\nworld,", "hello,\r\n\r\nworld,\"\"\n", "hello,\r\n\r\nworld,\"\"" }; + final String[][] res = { { "hello", "" }, // CSV format ignores empty lines + { "world", "" } }; + for (final String code : codes) { + try (CSVParser parser = CSVParser.parse(code, CSVFormat.DEFAULT)) { + final List records = parser.getRecords(); + assertEquals(res.length, records.size()); + assertFalse(records.isEmpty()); + for (int i = 0; i < res.length; i++) { + assertValuesEquals(res[i], records.get(i)); + } + } + } + } + + @Test + void testEndOfFileBehaviorExcel() throws Exception { + final String[] codes = { "hello,\r\n\r\nworld,\r\n", "hello,\r\n\r\nworld,", "hello,\r\n\r\nworld,\"\"\r\n", "hello,\r\n\r\nworld,\"\"", + "hello,\r\n\r\nworld,\n", "hello,\r\n\r\nworld,", "hello,\r\n\r\nworld,\"\"\n", "hello,\r\n\r\nworld,\"\"" }; + final String[][] res = { { "hello", "" }, { "" }, // Excel format does not ignore empty lines + { "world", "" } }; + + for (final String code : codes) { + try (CSVParser parser = CSVParser.parse(code, CSVFormat.EXCEL)) { + final List records = parser.getRecords(); + assertEquals(res.length, records.size()); + assertFalse(records.isEmpty()); + for (int i = 0; i < res.length; i++) { + assertValuesEquals(res[i], records.get(i)); + } + } + } + } + + @Test + void testExcelFormat1() throws IOException { + final String code = "value1,value2,value3,value4\r\na,b,c,d\r\n x,,,\r\n\r\n\"\"\"hello\"\"\",\" \"\"world\"\"\",\"abc\ndef\",\r\n"; + final String[][] res = { { "value1", "value2", "value3", "value4" }, { "a", "b", "c", "d" }, { " x", "", "", "" }, { "" }, + { "\"hello\"", " \"world\"", "abc\ndef", "" } }; + try (CSVParser parser = CSVParser.parse(code, CSVFormat.EXCEL)) { + final List records = parser.getRecords(); + assertEquals(res.length, records.size()); + assertFalse(records.isEmpty()); + for (int i = 0; i < res.length; i++) { + assertValuesEquals(res[i], records.get(i)); + } + } + } + + @Test + void testExcelFormat2() throws Exception { + final String code = "foo,baar\r\n\r\nhello,\r\n\r\nworld,\r\n"; + final String[][] res = { { "foo", "baar" }, { "" }, { "hello", "" }, { "" }, { "world", "" } }; + try (CSVParser parser = CSVParser.parse(code, CSVFormat.EXCEL)) { + final List records = parser.getRecords(); + assertEquals(res.length, records.size()); + assertFalse(records.isEmpty()); + for (int i = 0; i < res.length; i++) { + assertValuesEquals(res[i], records.get(i)); + } + } + } + + /** + * Tests an exported Excel worksheet with a header row and rows that have more columns than the headers + */ + @Test + void testExcelHeaderCountLessThanData() throws Exception { + final String code = "A,B,C,,\r\na,b,c,d,e\r\n"; + try (CSVParser parser = CSVParser.parse(code, EXCEL_WITH_HEADER)) { + parser.getRecords().forEach(record -> { + assertEquals("a", record.get("A")); + assertEquals("b", record.get("B")); + assertEquals("c", record.get("C")); + }); + } + } + + @Test + void testFirstEndOfLineCr() throws IOException { + final String data = "foo\rbaar,\rhello,world\r,kanu"; + try (CSVParser parser = CSVParser.parse(data, CSVFormat.DEFAULT)) { + final List records = parser.getRecords(); + assertEquals(4, records.size()); + assertEquals("\r", parser.getFirstEndOfLine()); + } + } + + @Test + void testFirstEndOfLineCrLf() throws IOException { + final String data = "foo\r\nbaar,\r\nhello,world\r\n,kanu"; + try (CSVParser parser = CSVParser.parse(data, CSVFormat.DEFAULT)) { + final List records = parser.getRecords(); + assertEquals(4, records.size()); + assertEquals("\r\n", parser.getFirstEndOfLine()); + } + } + + @Test + void testFirstEndOfLineLf() throws IOException { + final String data = "foo\nbaar,\nhello,world\n,kanu"; + try (CSVParser parser = CSVParser.parse(data, CSVFormat.DEFAULT)) { + final List records = parser.getRecords(); + assertEquals(4, records.size()); + assertEquals("\n", parser.getFirstEndOfLine()); + } + } + + @Test + void testForEach() throws Exception { + try (Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); + CSVParser parser = CSVFormat.DEFAULT.parse(in)) { + final List records = new ArrayList<>(); + for (final CSVRecord record : parser) { + records.add(record); + } + assertEquals(3, records.size()); + assertValuesEquals(new String[] { "a", "b", "c" }, records.get(0)); + assertValuesEquals(new String[] { "1", "2", "3" }, records.get(1)); + assertValuesEquals(new String[] { "x", "y", "z" }, records.get(2)); + } + } + + @Test + void testGetBytePositionMultiCharacterDelimiter() throws IOException { + final String code = "aa[|]bb\ncc[|]dd\n"; + final CSVFormat format = CSVFormat.DEFAULT.builder().setDelimiter("[|]").get(); + try (CSVParser parser = CSVParser.builder() + .setReader(new StringReader(code)) + .setFormat(format) + .setCharset(StandardCharsets.UTF_8) + .setTrackBytes(true) + .get()) { + final Iterator it = parser.iterator(); + final CSVRecord first = it.next(); + final CSVRecord second = it.next(); + assertEquals(0, first.getBytePosition()); + assertEquals(8, second.getBytePosition()); + } + } + + /** + * Tests CSV-329. + */ + @Test + void testGetBytePositionMultiCharacterDelimiterWithSupplementaryCharacter() throws IOException { + final String delimiter = "x๐Ÿ˜€"; + final String code = "ax๐Ÿ˜€b\ncx๐Ÿ˜€d\n"; + final CSVFormat format = CSVFormat.DEFAULT.builder().setDelimiter(delimiter).get(); + try (CSVParser parser = CSVParser.builder() + .setReader(new StringReader(code)) + .setFormat(format) + .setCharset(UTF_8) + .setTrackBytes(true) + .get()) { + final CSVRecord first = parser.nextRecord(); + final CSVRecord second = parser.nextRecord(); + assertNotNull(first); + assertNotNull(second); + assertValuesEquals(new String[] { "a", "b" }, first); + assertValuesEquals(new String[] { "c", "d" }, second); + assertEquals(0, first.getBytePosition()); + assertEquals("ax๐Ÿ˜€b\n".getBytes(UTF_8).length, second.getBytePosition()); + } + } + + @Test + void testGetBytePositionWithCharacterOffsetAndMultiBytePrefix() throws Exception { + final String row0 = "รฉ,x\n"; + final Charset charset = UTF_8; + // row0 char count is 4 + assertEquals(4, row0.length()); + // row0 byte count is 5 + final int record1ByteOffset = row0.getBytes(charset).length; + assertEquals(5, record1ByteOffset); + final String row1 = "b,c\n"; + final String rows = row0 + row1; + final long record1CharOffset = row0.length(); + final long expectedByteOffset = row0.getBytes(charset).length; + try (CSVParser parser = CSVParser.builder() + .setReader(new StringReader(row1)) + .setFormat(CSVFormat.DEFAULT) + .setCharset(charset) + .setTrackBytes(true) + .setByteOffset(record1ByteOffset) + .setCharacterOffset(record1CharOffset) + .setRecordNumber(2) // not relevant but a better use case example. + .get()) { + final CSVRecord record = parser.nextRecord(); + assertNotNull(record); + assertEquals(4, record.getCharacterPosition()); + assertEquals(record1CharOffset, record.getCharacterPosition()); + assertEquals(expectedByteOffset, record.getBytePosition()); + } + } + + @Test + void testGetBytePositionWithSingleByteCharset() throws IOException { + // A single-byte charset cannot encode U+FFFF, the char value of the EOF sentinel. + // Byte counting must skip the EOF read so a valid file parses without throwing. + final String code = "a,b\nc,d\n"; + try (CSVParser parser = CSVParser.builder() + .setReader(new StringReader(code)) + .setFormat(CSVFormat.DEFAULT) + .setCharset(StandardCharsets.ISO_8859_1) + .setTrackBytes(true) + .get()) { + final CSVRecord first = parser.nextRecord(); + final CSVRecord second = parser.nextRecord(); + assertNotNull(first); + assertNotNull(second); + assertNull(parser.nextRecord()); + assertEquals(0, first.getBytePosition()); + assertEquals(4, second.getBytePosition()); + } + } + + @Test + void testGetHeaderComment_HeaderComment1() throws IOException { + try (CSVParser parser = CSVParser.parse(CSV_INPUT_HEADER_COMMENT, FORMAT_AUTO_HEADER)) { + parser.getRecords(); + // Expect a header comment + assertTrue(parser.hasHeaderComment()); + assertEquals("header comment", parser.getHeaderComment()); + } + } + + @Test + void testGetHeaderComment_HeaderComment2() throws IOException { + try (CSVParser parser = CSVParser.parse(CSV_INPUT_HEADER_COMMENT, FORMAT_EXPLICIT_HEADER)) { + parser.getRecords(); + // Expect a header comment + assertTrue(parser.hasHeaderComment()); + assertEquals("header comment", parser.getHeaderComment()); + } + } + + @Test + void testGetHeaderComment_HeaderComment3() throws IOException { + try (CSVParser parser = CSVParser.parse(CSV_INPUT_HEADER_COMMENT, FORMAT_EXPLICIT_HEADER_NOSKIP)) { + parser.getRecords(); + // Expect no header comment - the text "comment" is attached to the first record + assertFalse(parser.hasHeaderComment()); + assertNull(parser.getHeaderComment()); + } + } + + @Test + void testGetHeaderComment_HeaderTrailerComment() throws IOException { + try (CSVParser parser = CSVParser.parse(CSV_INPUT_MULTILINE_HEADER_TRAILER_COMMENT, FORMAT_AUTO_HEADER)) { + parser.getRecords(); + // Expect a header comment + assertTrue(parser.hasHeaderComment()); + assertEquals("multi-line" + LF + "header comment", parser.getHeaderComment()); + } + } + + @Test + void testGetHeaderComment_NoComment1() throws IOException { + try (CSVParser parser = CSVParser.parse(CSV_INPUT_NO_COMMENT, FORMAT_AUTO_HEADER)) { + parser.getRecords(); + // Expect no header comment + assertFalse(parser.hasHeaderComment()); + assertNull(parser.getHeaderComment()); + } + } + + @Test + void testGetHeaderComment_NoComment2() throws IOException { + try (CSVParser parser = CSVParser.parse(CSV_INPUT_NO_COMMENT, FORMAT_EXPLICIT_HEADER)) { + parser.getRecords(); + // Expect no header comment + assertFalse(parser.hasHeaderComment()); + assertNull(parser.getHeaderComment()); + } + } + + @Test + void testGetHeaderComment_NoComment3() throws IOException { + try (CSVParser parser = CSVParser.parse(CSV_INPUT_NO_COMMENT, FORMAT_EXPLICIT_HEADER_NOSKIP)) { + parser.getRecords(); + // Expect no header comment + assertFalse(parser.hasHeaderComment()); + assertNull(parser.getHeaderComment()); + } + } + + @Test + void testGetHeaderMap() throws Exception { + try (CSVParser parser = CSVParser.parse("a,b,c\n1,2,3\nx,y,z", CSVFormat.DEFAULT.withHeader("A", "B", "C"))) { + final Map headerMap = parser.getHeaderMap(); + final Iterator columnNames = headerMap.keySet().iterator(); + // Headers are iterated in column order. + assertEquals("A", columnNames.next()); + assertEquals("B", columnNames.next()); + assertEquals("C", columnNames.next()); + final Iterator records = parser.iterator(); + + // Parse to make sure getHeaderMap did not have a side-effect. + for (int i = 0; i < 3; i++) { + assertTrue(records.hasNext()); + final CSVRecord record = records.next(); + assertEquals(record.get(0), record.get("A")); + assertEquals(record.get(1), record.get("B")); + assertEquals(record.get(2), record.get("C")); + } + + assertFalse(records.hasNext()); + } + } + + @Test + void testGetHeaderNames() throws IOException { + try (CSVParser parser = CSVParser.parse("a,b,c\n1,2,3\nx,y,z", CSVFormat.DEFAULT.withHeader("A", "B", "C"))) { + final Map nameIndexMap = parser.getHeaderMap(); + final List headerNames = parser.getHeaderNames(); + assertNotNull(headerNames); + assertEquals(nameIndexMap.size(), headerNames.size()); + for (int i = 0; i < headerNames.size(); i++) { + final String name = headerNames.get(i); + assertEquals(i, nameIndexMap.get(name).intValue()); + } + } + } + + @Test + void testGetHeaderNamesReadOnly() throws IOException { + try (CSVParser parser = CSVParser.parse("a,b,c\n1,2,3\nx,y,z", CSVFormat.DEFAULT.withHeader("A", "B", "C"))) { + final List headerNames = parser.getHeaderNames(); + assertNotNull(headerNames); + assertThrows(UnsupportedOperationException.class, () -> headerNames.add("This is a read-only list.")); + } + } + + @Test + void testGetLine() throws IOException { + try (CSVParser parser = CSVParser.parse(CSV_INPUT, CSVFormat.DEFAULT.withIgnoreSurroundingSpaces())) { + for (final String[] re : RESULT) { + assertValuesEquals(re, parser.nextRecord()); + } + + assertNull(parser.nextRecord()); + } + } + + @Test + void testGetLineNumberWithCR() throws Exception { + validateLineNumbers(String.valueOf(CR)); + } + + @Test + void testGetLineNumberWithCRLF() throws Exception { + validateLineNumbers(CRLF); + } + + @Test + void testGetLineNumberWithLF() throws Exception { + validateLineNumbers(String.valueOf(LF)); + } + + @Test + void testGetOneLine() throws IOException { + try (CSVParser parser = CSVParser.parse(CSV_INPUT_1, CSVFormat.DEFAULT)) { + final CSVRecord record = parser.getRecords().get(0); + assertValuesEquals(RESULT[0], record); + } + } + + /** + * Tests reusing a parser to process new string records one at a time as they are being discovered. See [CSV-110]. + * + * @throws IOException when an I/O error occurs. + */ + @Test + void testGetOneLineOneParser() throws IOException { + final CSVFormat format = CSVFormat.DEFAULT; + try (PipedWriter writer = new PipedWriter(); + PipedReader origin = new PipedReader(writer); + CSVParser parser = CSVParser.builder() + .setReader(origin) + .setFormat(format) + .get()) { + writer.append(CSV_INPUT_1); + writer.append(format.getRecordSeparator()); + final CSVRecord record1 = parser.nextRecord(); + assertValuesEquals(RESULT[0], record1); + writer.append(CSV_INPUT_2); + writer.append(format.getRecordSeparator()); + final CSVRecord record2 = parser.nextRecord(); + assertValuesEquals(RESULT[1], record2); + } + } + + @Test + void testGetRecordFourBytesRead() throws Exception { + final String code = "id,a,b,c\n" + + "1,๐Ÿ˜Š,๐Ÿค”,๐Ÿ˜‚\n" + + "2,๐Ÿ˜Š,๐Ÿค”,๐Ÿ˜‚\n" + + "3,๐Ÿ˜Š,๐Ÿค”,๐Ÿ˜‚\n"; + final CSVFormat format = CSVFormat.Builder.create() + .setDelimiter(',') + .setQuote('\'') + .get(); + try (CSVParser parser = CSVParser.builder().setReader(new StringReader(code)).setFormat(format).setCharset(UTF_8).setTrackBytes(true).get()) { + CSVRecord record = new CSVRecord(parser, null, null, 1L, 0L, 0L); + + assertEquals(0, parser.getRecordNumber()); + assertNotNull(record = parser.nextRecord()); + assertEquals(1, record.getRecordNumber()); + assertEquals(code.indexOf('i'), record.getCharacterPosition()); + assertEquals(record.getBytePosition(), record.getCharacterPosition()); + + assertNotNull(record = parser.nextRecord()); + assertEquals(2, record.getRecordNumber()); + assertEquals(code.indexOf('1'), record.getCharacterPosition()); + assertEquals(record.getBytePosition(), record.getCharacterPosition()); + assertNotNull(record = parser.nextRecord()); + assertEquals(3, record.getRecordNumber()); + assertEquals(code.indexOf('2'), record.getCharacterPosition()); + assertEquals(record.getBytePosition(), 26); + assertNotNull(record = parser.nextRecord()); + assertEquals(4, record.getRecordNumber()); + assertEquals(code.indexOf('3'), record.getCharacterPosition()); + assertEquals(record.getBytePosition(), 43); + } + } + + @Test + void testGetRecordNumberWithCR() throws Exception { + validateRecordNumbers(String.valueOf(CR)); + } + + @Test + void testGetRecordNumberWithCRLF() throws Exception { + validateRecordNumbers(CRLF); + } + + @Test + void testGetRecordNumberWithLF() throws Exception { + validateRecordNumbers(String.valueOf(LF)); + } + + @Test + void testGetRecordPositionWithCRLF() throws Exception { + validateRecordPosition(CRLF); + } + + @Test + void testGetRecordPositionWithLF() throws Exception { + validateRecordPosition(String.valueOf(LF)); + } + + @Test + void testGetRecords() throws IOException { + try (CSVParser parser = CSVParser.parse(CSV_INPUT, CSVFormat.DEFAULT.withIgnoreSurroundingSpaces())) { + final List records = parser.getRecords(); + assertEquals(RESULT.length, records.size()); + assertFalse(records.isEmpty()); + for (int i = 0; i < RESULT.length; i++) { + assertValuesEquals(RESULT[i], records.get(i)); + } + } + } + + @Test + void testGetRecordsFromBrokenInputStream() throws IOException { + @SuppressWarnings("resource") // We also get an exception on close, which is OK but can't assert in a try. + final CSVParser parser = CSVParser.parse(new BrokenInputStream(), UTF_8, CSVFormat.DEFAULT); + assertThrows(UncheckedIOException.class, parser::getRecords); + + } + + @ParameterizedTest + @ValueSource(longs = { -1, 0, 1, 2, 3, 4, Long.MAX_VALUE }) + void testGetRecordsMaxRows(final long maxRows) throws IOException { + try (CSVParser parser = CSVParser.parse(CSV_INPUT, CSVFormat.DEFAULT.builder().setIgnoreSurroundingSpaces(true).setMaxRows(maxRows).get())) { + final List records = parser.getRecords(); + final long expectedLength = maxRows <= 0 || maxRows > RESULT.length ? RESULT.length : maxRows; + assertEquals(expectedLength, records.size()); + assertFalse(records.isEmpty()); + for (int i = 0; i < expectedLength; i++) { + assertValuesEquals(RESULT[i], records.get(i)); + } + } + } + + /** + * Tests CSV-327. + */ + @Test + void testGetRecordsMaxRowsWithRecordNumberOffset() throws IOException { + try (CSVParser parser = CSVParser.builder() + .setReader(new StringReader("a,b\nc,d\n")) + .setFormat(CSVFormat.DEFAULT.builder().setMaxRows(1).get()) + .setRecordNumber(2) + .get()) { + final List records = parser.getRecords(); + assertEquals(1, records.size()); + assertEquals(2, records.get(0).getRecordNumber()); + assertValuesEquals(new String[] { "a", "b" }, records.get(0)); + } + } + + @Test + void testGetRecordThreeBytesRead() throws Exception { + final String code = "id,date,val5,val4\n" + + "11111111111111,'4017-09-01',ใใกใ‚“ใจ็ฏ€ๅˆ†่ฟ‘ใใซใฏๅ’ฒใ„ใฆใ‚‹๏ฝž,v4\n" + + "22222222222222,'4017-01-01',ใŠใฏใ‚ˆใ†็งใฎๅ‹ไบบ๏ฝž,v4\n" + + "33333333333333,'4017-01-01',ใใ‚‹่‡ช็„ถใฎๅŠ›ใฃใฆใ™ใ”ใ„ใช๏ฝž,v4\n"; + final CSVFormat format = CSVFormat.Builder.create() + .setDelimiter(',') + .setQuote('\'') + .get(); + try (CSVParser parser = CSVParser.builder().setReader(new StringReader(code)).setFormat(format).setCharset(UTF_8).setTrackBytes(true).get()) { + CSVRecord record = new CSVRecord(parser, null, null, 1L, 0L, 0L); + + assertEquals(0, parser.getRecordNumber()); + assertNotNull(record = parser.nextRecord()); + assertEquals(1, record.getRecordNumber()); + assertEquals(code.indexOf('i'), record.getCharacterPosition()); + assertEquals(record.getBytePosition(), record.getCharacterPosition()); + + assertNotNull(record = parser.nextRecord()); + assertEquals(2, record.getRecordNumber()); + assertEquals(code.indexOf('1'), record.getCharacterPosition()); + assertEquals(record.getBytePosition(), record.getCharacterPosition()); + + assertNotNull(record = parser.nextRecord()); + assertEquals(3, record.getRecordNumber()); + assertEquals(code.indexOf('2'), record.getCharacterPosition()); + assertEquals(record.getBytePosition(), 95); + + assertNotNull(record = parser.nextRecord()); + assertEquals(4, record.getRecordNumber()); + assertEquals(code.indexOf('3'), record.getCharacterPosition()); + assertEquals(record.getBytePosition(), 154); + } + } + + @Test + void testGetRecordWithMultiLineValues() throws Exception { + try (CSVParser parser = CSVParser.parse("\"a\r\n1\",\"a\r\n2\"" + CRLF + "\"b\r\n1\",\"b\r\n2\"" + CRLF + "\"c\r\n1\",\"c\r\n2\"", + CSVFormat.DEFAULT.withRecordSeparator(CRLF))) { + CSVRecord record; + assertEquals(0, parser.getRecordNumber()); + assertEquals(0, parser.getCurrentLineNumber()); + assertNotNull(record = parser.nextRecord()); + assertEquals(3, parser.getCurrentLineNumber()); + assertEquals(1, record.getRecordNumber()); + assertEquals(1, parser.getRecordNumber()); + assertNotNull(record = parser.nextRecord()); + assertEquals(6, parser.getCurrentLineNumber()); + assertEquals(2, record.getRecordNumber()); + assertEquals(2, parser.getRecordNumber()); + assertNotNull(record = parser.nextRecord()); + assertEquals(9, parser.getCurrentLineNumber()); + assertEquals(3, record.getRecordNumber()); + assertEquals(3, parser.getRecordNumber()); + assertNull(record = parser.nextRecord()); + assertEquals(9, parser.getCurrentLineNumber()); + assertEquals(3, parser.getRecordNumber()); + } + } + + @Test + void testGetTrailerComment_HeaderComment1() throws IOException { + try (CSVParser parser = CSVParser.parse(CSV_INPUT_HEADER_COMMENT, FORMAT_AUTO_HEADER)) { + parser.getRecords(); + assertFalse(parser.hasTrailerComment()); + assertNull(parser.getTrailerComment()); + } + } + + @Test + void testGetTrailerComment_HeaderComment2() throws IOException { + try (CSVParser parser = CSVParser.parse(CSV_INPUT_HEADER_COMMENT, FORMAT_EXPLICIT_HEADER)) { + parser.getRecords(); + assertFalse(parser.hasTrailerComment()); + assertNull(parser.getTrailerComment()); + } + } + + @Test + void testGetTrailerComment_HeaderComment3() throws IOException { + try (CSVParser parser = CSVParser.parse(CSV_INPUT_HEADER_COMMENT, FORMAT_EXPLICIT_HEADER_NOSKIP)) { + parser.getRecords(); + assertFalse(parser.hasTrailerComment()); + assertNull(parser.getTrailerComment()); + } + } + + @Test + void testGetTrailerComment_HeaderTrailerComment1() throws IOException { + try (CSVParser parser = CSVParser.parse(CSV_INPUT_HEADER_TRAILER_COMMENT, FORMAT_AUTO_HEADER)) { + parser.getRecords(); + assertTrue(parser.hasTrailerComment()); + assertEquals("comment", parser.getTrailerComment()); + } + } + + @Test + void testGetTrailerComment_HeaderTrailerComment2() throws IOException { + try (CSVParser parser = CSVParser.parse(CSV_INPUT_HEADER_TRAILER_COMMENT, FORMAT_EXPLICIT_HEADER)) { + parser.getRecords(); + assertTrue(parser.hasTrailerComment()); + assertEquals("comment", parser.getTrailerComment()); + } + } + + @Test + void testGetTrailerComment_HeaderTrailerComment3() throws IOException { + try (CSVParser parser = CSVParser.parse(CSV_INPUT_HEADER_TRAILER_COMMENT, FORMAT_EXPLICIT_HEADER_NOSKIP)) { + parser.getRecords(); + assertTrue(parser.hasTrailerComment()); + assertEquals("comment", parser.getTrailerComment()); + } + } + + @Test + void testGetTrailerComment_MultilineComment() throws IOException { + try (CSVParser parser = CSVParser.parse(CSV_INPUT_MULTILINE_HEADER_TRAILER_COMMENT, FORMAT_AUTO_HEADER)) { + parser.getRecords(); + assertTrue(parser.hasTrailerComment()); + assertEquals("multi-line" + LF + "comment", parser.getTrailerComment()); + } + } + + @Test + void testHeader() throws Exception { + final Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); + + try (CSVParser parser = CSVFormat.DEFAULT.withHeader().parse(in)) { + final Iterator records = parser.iterator(); + + for (int i = 0; i < 2; i++) { + assertTrue(records.hasNext()); + final CSVRecord record = records.next(); + assertEquals(record.get(0), record.get("a")); + assertEquals(record.get(1), record.get("b")); + assertEquals(record.get(2), record.get("c")); + } + + assertFalse(records.hasNext()); + } + } + + @Test + void testHeaderComment() throws Exception { + final Reader in = new StringReader("# comment\na,b,c\n1,2,3\nx,y,z"); + try (CSVParser parser = CSVFormat.DEFAULT.withCommentMarker('#').withHeader().parse(in)) { + final Iterator records = parser.iterator(); + for (int i = 0; i < 2; i++) { + assertTrue(records.hasNext()); + final CSVRecord record = records.next(); + assertEquals(record.get(0), record.get("a")); + assertEquals(record.get(1), record.get("b")); + assertEquals(record.get(2), record.get("c")); + } + assertFalse(records.hasNext()); + } + } + + @Test + void testHeaderMissing() throws Exception { + final Reader in = new StringReader("a,,c\n1,2,3\nx,y,z"); + try (CSVParser parser = CSVFormat.DEFAULT.withHeader().withAllowMissingColumnNames().parse(in)) { + final Iterator records = parser.iterator(); + for (int i = 0; i < 2; i++) { + assertTrue(records.hasNext()); + final CSVRecord record = records.next(); + assertEquals(record.get(0), record.get("a")); + assertEquals(record.get(2), record.get("c")); + } + assertFalse(records.hasNext()); + } + } + + @Test + void testHeaderMissingWithNull() throws Exception { + final Reader in = new StringReader("a,,c,,e\n1,2,3,4,5\nv,w,x,y,z"); + try (CSVParser parser = CSVFormat.DEFAULT.withHeader().withNullString("").withAllowMissingColumnNames().parse(in)) { + parser.iterator(); + } + } + + @Test + void testHeadersMissing() throws Exception { + try (Reader in = new StringReader("a,,c,,e\n1,2,3,4,5\nv,w,x,y,z"); + CSVParser parser = CSVFormat.DEFAULT.withHeader().withAllowMissingColumnNames().parse(in)) { + parser.iterator(); + } + } + + @Test + void testHeadersMissingException() { + final Reader in = new StringReader("a,,c,,e\n1,2,3,4,5\nv,w,x,y,z"); + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withHeader().parse(in).iterator()); + } + + @Test + void testHeadersMissingOneColumnException() { + final Reader in = new StringReader("a,,c,d,e\n1,2,3,4,5\nv,w,x,y,z"); + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withHeader().parse(in).iterator()); + } + + @Test + void testHeadersWithNullColumnName() throws IOException { + final Reader in = new StringReader("header1,null,header3\n1,2,3\n4,5,6"); + try (CSVParser parser = CSVFormat.DEFAULT.withHeader().withNullString("null").withAllowMissingColumnNames().parse(in)) { + final Iterator records = parser.iterator(); + final CSVRecord record = records.next(); + // Expect the null header to be missing + @SuppressWarnings("resource") + final CSVParser recordParser = record.getParser(); + assertEquals(Arrays.asList("header1", "header3"), recordParser.getHeaderNames()); + assertEquals(2, recordParser.getHeaderMap().size()); + } + } + + @Test + void testIgnoreCaseHeaderMapping() throws Exception { + final Reader reader = new StringReader("1,2,3"); + try (CSVParser parser = CSVFormat.DEFAULT.withHeader("One", "TWO", "three").withIgnoreHeaderCase().parse(reader)) { + final Iterator records = parser.iterator(); + final CSVRecord record = records.next(); + assertEquals("1", record.get("one")); + assertEquals("2", record.get("two")); + assertEquals("3", record.get("THREE")); + } + } + + @Test + void testIgnoreEmptyLines() throws IOException { + final String code = "\nfoo,baar\n\r\n,\n\n,world\r\n\n"; + // String code = "world\r\n\n"; + // String code = "foo;baar\r\n\r\nhello;\r\n\r\nworld;\r\n"; + try (CSVParser parser = CSVParser.parse(code, CSVFormat.DEFAULT)) { + final List records = parser.getRecords(); + assertEquals(3, records.size()); + } + } + + @Test + void testInvalidFormat() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withDelimiter(CR)); + } + + @Test + void testIterator() throws Exception { + final Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); + try (CSVParser parser = CSVFormat.DEFAULT.parse(in)) { + final Iterator iterator = parser.iterator(); + assertTrue(iterator.hasNext()); + assertThrows(UnsupportedOperationException.class, iterator::remove); + assertValuesEquals(new String[] { "a", "b", "c" }, iterator.next()); + assertValuesEquals(new String[] { "1", "2", "3" }, iterator.next()); + assertTrue(iterator.hasNext()); + assertTrue(iterator.hasNext()); + assertTrue(iterator.hasNext()); + assertValuesEquals(new String[] { "x", "y", "z" }, iterator.next()); + assertFalse(iterator.hasNext()); + assertThrows(NoSuchElementException.class, iterator::next); + } + } + + @ParameterizedTest + @ValueSource(longs = { -1, 0, 1, 2, 3, 4, 5, Long.MAX_VALUE }) + void testIteratorMaxRows(final long maxRows) throws Exception { + final Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); + try (CSVParser parser = CSVFormat.DEFAULT.builder().setMaxRows(maxRows).get().parse(in)) { + final Iterator iterator = parser.iterator(); + assertTrue(iterator.hasNext()); + assertThrows(UnsupportedOperationException.class, iterator::remove); + assertValuesEquals(new String[] { "a", "b", "c" }, iterator.next()); + final boolean noLimit = maxRows <= 0; + final int fixtureLen = 3; + final long expectedLen = noLimit ? fixtureLen : Math.min(fixtureLen, maxRows); + if (expectedLen > 1) { + assertTrue(iterator.hasNext()); + assertValuesEquals(new String[] { "1", "2", "3" }, iterator.next()); + } + assertEquals(expectedLen > 2, iterator.hasNext()); + // again + assertEquals(expectedLen > 2, iterator.hasNext()); + if (expectedLen == fixtureLen) { + assertTrue(iterator.hasNext()); + assertValuesEquals(new String[] { "x", "y", "z" }, iterator.next()); + } + assertFalse(iterator.hasNext()); + assertThrows(NoSuchElementException.class, iterator::next); + } + } + + @Test + void testIteratorSequenceBreaking() throws IOException { + final String fiveRows = "1\n2\n3\n4\n5\n"; + // Iterator hasNext() shouldn't break sequence + try (CSVParser parser = CSVFormat.DEFAULT.parse(new StringReader(fiveRows))) { + final Iterator iter = parser.iterator(); + int recordNumber = 0; + while (iter.hasNext()) { + final CSVRecord record = iter.next(); + recordNumber++; + assertEquals(String.valueOf(recordNumber), record.get(0)); + if (recordNumber >= 2) { + break; + } + } + iter.hasNext(); + while (iter.hasNext()) { + final CSVRecord record = iter.next(); + recordNumber++; + assertEquals(String.valueOf(recordNumber), record.get(0)); + } + } + // Consecutive enhanced for loops shouldn't break sequence + try (CSVParser parser = CSVFormat.DEFAULT.parse(new StringReader(fiveRows))) { + int recordNumber = 0; + for (final CSVRecord record : parser) { + recordNumber++; + assertEquals(String.valueOf(recordNumber), record.get(0)); + if (recordNumber >= 2) { + break; + } + } + for (final CSVRecord record : parser) { + recordNumber++; + assertEquals(String.valueOf(recordNumber), record.get(0)); + } + } + // Consecutive enhanced for loops with hasNext() peeking shouldn't break sequence + try (CSVParser parser = CSVFormat.DEFAULT.parse(new StringReader(fiveRows))) { + int recordNumber = 0; + for (final CSVRecord record : parser) { + recordNumber++; + assertEquals(String.valueOf(recordNumber), record.get(0)); + if (recordNumber >= 2) { + break; + } + } + parser.iterator().hasNext(); + for (final CSVRecord record : parser) { + recordNumber++; + assertEquals(String.valueOf(recordNumber), record.get(0)); + } + } + } + + @Test + void testLineFeedEndings() throws IOException { + final String code = "foo\nbaar,\nhello,world\n,kanu"; + try (CSVParser parser = CSVParser.parse(code, CSVFormat.DEFAULT)) { + final List records = parser.getRecords(); + assertEquals(4, records.size()); + } + } + + @Test + void testMappedButNotSetAsOutlook2007ContactExport() throws Exception { + final Reader in = new StringReader("a,b,c\n1,2\nx,y,z"); + try (CSVParser parser = CSVFormat.DEFAULT.withHeader("A", "B", "C").withSkipHeaderRecord().parse(in)) { + final Iterator records = parser.iterator(); + CSVRecord record; + // 1st record + record = records.next(); + assertTrue(record.isMapped("A")); + assertTrue(record.isMapped("B")); + assertTrue(record.isMapped("C")); + assertTrue(record.isSet("A")); + assertTrue(record.isSet("B")); + assertFalse(record.isSet("C")); + assertEquals("1", record.get("A")); + assertEquals("2", record.get("B")); + assertFalse(record.isConsistent()); + // 2nd record + record = records.next(); + assertTrue(record.isMapped("A")); + assertTrue(record.isMapped("B")); + assertTrue(record.isMapped("C")); + assertTrue(record.isSet("A")); + assertTrue(record.isSet("B")); + assertTrue(record.isSet("C")); + assertEquals("x", record.get("A")); + assertEquals("y", record.get("B")); + assertEquals("z", record.get("C")); + assertTrue(record.isConsistent()); + // end + assertFalse(records.hasNext()); + } + } + + @Test + @Disabled + void testMongoDbCsv() throws Exception { + try (CSVParser parser = CSVParser.parse("\"a a\",b,c" + LF + "d,e,f", CSVFormat.MONGODB_CSV)) { + final Iterator itr1 = parser.iterator(); + final Iterator itr2 = parser.iterator(); + + final CSVRecord first = itr1.next(); + assertEquals("a a", first.get(0)); + assertEquals("b", first.get(1)); + assertEquals("c", first.get(2)); + + final CSVRecord second = itr2.next(); + assertEquals("d", second.get(0)); + assertEquals("e", second.get(1)); + assertEquals("f", second.get(2)); + } + } + + @Test + // TODO this may lead to strange behavior, throw an exception if iterator() has already been called? + void testMultipleIterators() throws Exception { + try (CSVParser parser = CSVParser.parse("a,b,c" + CRLF + "d,e,f", CSVFormat.DEFAULT)) { + final Iterator itr1 = parser.iterator(); + + final CSVRecord first = itr1.next(); + assertEquals("a", first.get(0)); + assertEquals("b", first.get(1)); + assertEquals("c", first.get(2)); + + final CSVRecord second = itr1.next(); + assertEquals("d", second.get(0)); + assertEquals("e", second.get(1)); + assertEquals("f", second.get(2)); + } + } + + @Test + void testNewCSVParserNullReaderFormat() { + assertThrows(NullPointerException.class, () -> new CSVParser(null, CSVFormat.DEFAULT)); + } + + @Test + void testNewCSVParserReaderNullFormat() { + assertThrows(NullPointerException.class, () -> new CSVParser(new StringReader(""), null)); + } + + @Test + void testNoHeaderMap() throws Exception { + try (CSVParser parser = CSVParser.parse("a,b,c\n1,2,3\nx,y,z", CSVFormat.DEFAULT)) { + assertNull(parser.getHeaderMap()); + } + } + + @Test + void testNotValueCSV() throws IOException { + final String source = "#"; + final CSVFormat csvFormat = CSVFormat.DEFAULT.withCommentMarker('#'); + try (CSVParser csvParser = csvFormat.parse(new StringReader(source))) { + final CSVRecord csvRecord = csvParser.nextRecord(); + assertNull(csvRecord); + } + } + + @Test + void testParse() throws Exception { + final URL url = ClassLoader.getSystemClassLoader().getResource("org/apache/commons/csv/CSVFileParser/test.csv"); + final CSVFormat format = CSVFormat.DEFAULT.builder().setHeader("A", "B", "C", "D").get(); + final Charset charset = StandardCharsets.UTF_8; + // Reader + try (CSVParser parser = CSVParser.parse(new InputStreamReader(url.openStream(), charset), format)) { + parseFully(parser); + } + try (CSVParser parser = CSVParser.builder().setReader(new InputStreamReader(url.openStream(), charset)).setFormat(format).get()) { + parseFully(parser); + } + // String + final Path path = Paths.get(url.toURI()); + final String string = new String(Files.readAllBytes(path), charset); + try (CSVParser parser = CSVParser.parse(string, format)) { + parseFully(parser); + } + try (CSVParser parser = CSVParser.builder().setCharSequence(string).setFormat(format).get()) { + parseFully(parser); + } + // File + final File file = new File(url.toURI()); + try (CSVParser parser = CSVParser.parse(file, charset, format)) { + parseFully(parser); + } + try (CSVParser parser = CSVParser.builder().setFile(file).setCharset(charset).setFormat(format).get()) { + parseFully(parser); + } + // InputStream + try (CSVParser parser = CSVParser.parse(url.openStream(), charset, format)) { + parseFully(parser); + } + try (CSVParser parser = CSVParser.builder().setInputStream(url.openStream()).setCharset(charset).setFormat(format).get()) { + parseFully(parser); + } + // Path + try (CSVParser parser = CSVParser.parse(path, charset, format)) { + parseFully(parser); + } + try (CSVParser parser = CSVParser.builder().setPath(path).setCharset(charset).setFormat(format).get()) { + parseFully(parser); + } + // URL + try (CSVParser parser = CSVParser.parse(url, charset, format)) { + parseFully(parser); + } + try (CSVParser parser = CSVParser.builder().setURI(url.toURI()).setCharset(charset).setFormat(format).get()) { + parseFully(parser); + } + // InputStreamReader + try (CSVParser parser = new CSVParser(new InputStreamReader(url.openStream(), charset), format)) { + parseFully(parser); + } + try (CSVParser parser = CSVParser.builder().setReader(new InputStreamReader(url.openStream(), charset)).setFormat(format).get()) { + parseFully(parser); + } + // InputStreamReader with longs + try (CSVParser parser = new CSVParser(new InputStreamReader(url.openStream(), charset), format, /* characterOffset= */0, /* recordNumber= */1)) { + parseFully(parser); + } + try (CSVParser parser = CSVParser.builder().setReader(new InputStreamReader(url.openStream(), charset)).setFormat(format).setCharacterOffset(0) + .setRecordNumber(0).get()) { + parseFully(parser); + } + } + + @Test + void testParseFileCharsetNullFormat() throws IOException { + final File file = new File("src/test/resources/org/apache/commons/csv/CSVFileParser/test.csv"); + try (CSVParser parser = CSVParser.parse(file, Charset.defaultCharset(), null)) { + // null maps to DEFAULT. + parseFully(parser); + } + } + + @Test + void testParseInputStreamCharsetNullFormat() throws IOException { + try (InputStream in = Files.newInputStream(Paths.get("src/test/resources/org/apache/commons/csv/CSVFileParser/test.csv")); + CSVParser parser = CSVParser.parse(in, Charset.defaultCharset(), null)) { + // null maps to DEFAULT. + parseFully(parser); + } + } + + @Test + void testParseNullFileFormat() { + assertThrows(NullPointerException.class, () -> CSVParser.parse((File) null, Charset.defaultCharset(), CSVFormat.DEFAULT)); + } + + @Test + void testParseNullPathFormat() { + assertThrows(NullPointerException.class, () -> CSVParser.parse((Path) null, Charset.defaultCharset(), CSVFormat.DEFAULT)); + } + + @Test + void testParseNullStringFormat() { + assertThrows(NullPointerException.class, () -> CSVParser.parse((String) null, CSVFormat.DEFAULT)); + } + + @Test + void testParseNullUrlCharsetFormat() { + assertThrows(NullPointerException.class, () -> CSVParser.parse((URL) null, Charset.defaultCharset(), CSVFormat.DEFAULT)); + } + + @Test + void testParsePathCharsetNullFormat() throws IOException { + final Path path = Paths.get("src/test/resources/org/apache/commons/csv/CSVFileParser/test.csv"); + try (CSVParser parser = CSVParser.parse(path, Charset.defaultCharset(), null)) { + // null maps to DEFAULT. + parseFully(parser); + } + } + + @Test + void testParserUrlNullCharsetFormat() throws IOException { + final URL url = ClassLoader.getSystemClassLoader().getResource("org/apache/commons/csv/CSVFileParser/test.csv"); + try (CSVParser parser = CSVParser.parse(url, null, CSVFormat.DEFAULT)) { + // null maps to DEFAULT. + parseFully(parser); + } + } + + @Test + void testParseStringNullFormat() throws IOException { + try (CSVParser parser = CSVParser.parse("1,2,3", null)) { + // null maps to DEFAULT. + final List records = parser.getRecords(); + assertEquals(1, records.size()); + final CSVRecord record = records.get(0); + assertEquals(3, record.size()); + assertEquals("1", record.get(0)); + assertEquals("2", record.get(1)); + assertEquals("3", record.get(2)); + } + } + + @Test + void testParseUrlCharsetNullFormat() throws IOException { + final URL url = ClassLoader.getSystemClassLoader().getResource("org/apache/commons/csv/CSVFileParser/test.csv"); + try (CSVParser parser = CSVParser.parse(url, Charset.defaultCharset(), null)) { + // null maps to DEFAULT. + parseFully(parser); + } + } + + @Test + void testParseWithDelimiterStringWithEscape() throws IOException { + final String source = "a![!|!]b![|]c[|]xyz\r\nabc[abc][|]xyz"; + final CSVFormat csvFormat = CSVFormat.DEFAULT.builder().setDelimiter("[|]").setEscape('!').get(); + try (CSVParser csvParser = csvFormat.parse(new StringReader(source))) { + CSVRecord csvRecord = csvParser.nextRecord(); + assertEquals("a[|]b![|]c", csvRecord.get(0)); + assertEquals("xyz", csvRecord.get(1)); + csvRecord = csvParser.nextRecord(); + assertEquals("abc[abc]", csvRecord.get(0)); + assertEquals("xyz", csvRecord.get(1)); + } + } + + @Test + void testParseWithDelimiterStringWithQuote() throws IOException { + final String source = "'a[|]b[|]c'[|]xyz\r\nabc[abc][|]xyz"; + final CSVFormat csvFormat = CSVFormat.DEFAULT.builder().setDelimiter("[|]").setQuote('\'').get(); + try (CSVParser csvParser = csvFormat.parse(new StringReader(source))) { + CSVRecord csvRecord = csvParser.nextRecord(); + assertEquals("a[|]b[|]c", csvRecord.get(0)); + assertEquals("xyz", csvRecord.get(1)); + csvRecord = csvParser.nextRecord(); + assertEquals("abc[abc]", csvRecord.get(0)); + assertEquals("xyz", csvRecord.get(1)); + } + } + + @Test + void testParseWithDelimiterWithEscape() throws IOException { + final String source = "a!,b!,c,xyz"; + final CSVFormat csvFormat = CSVFormat.DEFAULT.withEscape('!'); + try (CSVParser csvParser = csvFormat.parse(new StringReader(source))) { + final CSVRecord csvRecord = csvParser.nextRecord(); + assertEquals("a,b,c", csvRecord.get(0)); + assertEquals("xyz", csvRecord.get(1)); + } + } + + @Test + void testParseWithDelimiterWithQuote() throws IOException { + final String source = "'a,b,c',xyz"; + final CSVFormat csvFormat = CSVFormat.DEFAULT.withQuote('\''); + try (CSVParser csvParser = csvFormat.parse(new StringReader(source))) { + final CSVRecord csvRecord = csvParser.nextRecord(); + assertEquals("a,b,c", csvRecord.get(0)); + assertEquals("xyz", csvRecord.get(1)); + } + } + + @Test + void testParseWithQuoteThrowsException() { + final CSVFormat csvFormat = CSVFormat.DEFAULT.withQuote('\''); + assertThrows(IOException.class, () -> csvFormat.parse(new StringReader("'a,b,c','")).nextRecord()); + assertThrows(IOException.class, () -> csvFormat.parse(new StringReader("'a,b,c'abc,xyz")).nextRecord()); + assertThrows(IOException.class, () -> csvFormat.parse(new StringReader("'abc'a,b,c',xyz")).nextRecord()); + } + + @Test + void testParseWithQuoteWithEscape() throws IOException { + final String source = "'a?,b?,c?d',xyz"; + final CSVFormat csvFormat = CSVFormat.DEFAULT.withQuote('\'').withEscape('?'); + try (CSVParser csvParser = csvFormat.parse(new StringReader(source))) { + final CSVRecord csvRecord = csvParser.nextRecord(); + assertEquals("a,b,c?d", csvRecord.get(0)); + assertEquals("xyz", csvRecord.get(1)); + } + } + + @ParameterizedTest + @EnumSource(CSVFormat.Predefined.class) + void testParsingPrintedEmptyFirstColumn(final CSVFormat.Predefined format) throws Exception { + final String[][] lines = { { "a", "b" }, { "", "x" } }; + final StringWriter buf = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(buf, format.getFormat())) { + printer.printRecords(Stream.of(lines)); + } + try (CSVParser csvRecords = CSVParser.builder() + .setReader(new StringReader(buf.toString())) + .setFormat(format.getFormat()) + .get()) { + for (final String[] line : lines) { + assertValuesEquals(line, csvRecords.nextRecord()); + } + assertNull(csvRecords.nextRecord()); + } + } + + /** + * A truncated escaped multi-character delimiter at EOF must stay literal data and not be completed from a stale + * escape delimiter look-ahead. + */ + @Test + void testPartialEscapedMultiCharacterDelimiterAtEOF() throws IOException { + final CSVFormat format = CSVFormat.DEFAULT.builder().setDelimiter("[|]").setEscape('!').get(); + try (CSVParser parser = format.parse(new StringReader("x![!|!]y![!|"))) { + final CSVRecord record = parser.nextRecord(); + assertEquals("x[|]y![!|", record.get(0)); + assertEquals(1, record.size()); + } + } + + /** + * Tests CSV-324. + */ + @Test + void testPartialMultiCharacterDelimiterAtEOF() throws IOException { + final CSVFormat format = CSVFormat.DEFAULT.builder().setDelimiter("[|]").get(); + try (CSVParser parser = format.parse(new StringReader("a[|]b[|"))) { + final CSVRecord record = parser.nextRecord(); + assertEquals("a", record.get(0)); + assertEquals("b[|", record.get(1)); + assertEquals(2, record.size()); + } + } + + /** + * A truncated multi-character delimiter at EOF must not be completed from the look-ahead buffer left dirty by an + * earlier non-matching peek in the same token. + */ + @Test + void testPartialMultiCharacterDelimiterAtEOFAfterMismatch() throws IOException { + final CSVFormat format = CSVFormat.DEFAULT.builder().setDelimiter("[|]").get(); + // The "[a]" peek leaves ']' in the look-ahead buffer; the trailing "[|" must not match "[|]". + final String recordString = "x[a][|"; + try (CSVParser parser = format.parse(new StringReader(recordString))) { + final CSVRecord record = parser.nextRecord(); + assertEquals(recordString, record.get(0)); + assertEquals(1, record.size()); + } + } + + @Test + void testProvidedHeader() throws Exception { + final Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); + try (CSVParser parser = CSVFormat.DEFAULT.withHeader("A", "B", "C").parse(in)) { + final Iterator records = parser.iterator(); + for (int i = 0; i < 3; i++) { + assertTrue(records.hasNext()); + final CSVRecord record = records.next(); + assertTrue(record.isMapped("A")); + assertTrue(record.isMapped("B")); + assertTrue(record.isMapped("C")); + assertFalse(record.isMapped("NOT MAPPED")); + assertEquals(record.get(0), record.get("A")); + assertEquals(record.get(1), record.get("B")); + assertEquals(record.get(2), record.get("C")); + } + assertFalse(records.hasNext()); + } + } + + @Test + void testProvidedHeaderAuto() throws Exception { + final Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); + try (CSVParser parser = CSVFormat.DEFAULT.withHeader().parse(in)) { + final Iterator records = parser.iterator(); + for (int i = 0; i < 2; i++) { + assertTrue(records.hasNext()); + final CSVRecord record = records.next(); + assertTrue(record.isMapped("a")); + assertTrue(record.isMapped("b")); + assertTrue(record.isMapped("c")); + assertFalse(record.isMapped("NOT MAPPED")); + assertEquals(record.get(0), record.get("a")); + assertEquals(record.get(1), record.get("b")); + assertEquals(record.get(2), record.get("c")); + } + assertFalse(records.hasNext()); + } + } + + @Test + void testRepeatedHeadersAreReturnedInCSVRecordHeaderNames() throws IOException { + final Reader in = new StringReader("header1,header2,header1\n1,2,3\n4,5,6"); + try (CSVParser parser = CSVFormat.DEFAULT.withFirstRecordAsHeader().withTrim().parse(in)) { + final Iterator records = parser.iterator(); + final CSVRecord record = records.next(); + @SuppressWarnings("resource") + final CSVParser recordParser = record.getParser(); + assertEquals(Arrays.asList("header1", "header2", "header1"), recordParser.getHeaderNames()); + } + } + + @Test + void testRoundtrip() throws Exception { + final StringWriter out = new StringWriter(); + final String data = "a,b,c\r\n1,2,3\r\nx,y,z\r\n"; + try (CSVPrinter printer = new CSVPrinter(out, CSVFormat.DEFAULT); + CSVParser parse = CSVParser.parse(data, CSVFormat.DEFAULT)) { + for (final CSVRecord record : parse) { + printer.printRecord(record); + } + assertEquals(data, out.toString()); + } + } + + @Test + void testSkipAutoHeader() throws Exception { + final Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); + try (CSVParser parser = CSVFormat.DEFAULT.withHeader().parse(in)) { + final Iterator records = parser.iterator(); + final CSVRecord record = records.next(); + assertEquals("1", record.get("a")); + assertEquals("2", record.get("b")); + assertEquals("3", record.get("c")); + } + } + + @Test + void testSkipHeaderOverrideDuplicateHeaders() throws Exception { + final Reader in = new StringReader("a,a,a\n1,2,3\nx,y,z"); + try (CSVParser parser = CSVFormat.DEFAULT.withHeader("X", "Y", "Z").withSkipHeaderRecord().parse(in)) { + final Iterator records = parser.iterator(); + final CSVRecord record = records.next(); + assertEquals("1", record.get("X")); + assertEquals("2", record.get("Y")); + assertEquals("3", record.get("Z")); + } + } + + @Test + void testSkipSetAltHeaders() throws Exception { + final Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); + try (CSVParser parser = CSVFormat.DEFAULT.withHeader("X", "Y", "Z").withSkipHeaderRecord().parse(in)) { + final Iterator records = parser.iterator(); + final CSVRecord record = records.next(); + assertEquals("1", record.get("X")); + assertEquals("2", record.get("Y")); + assertEquals("3", record.get("Z")); + } + } + + @Test + void testSkipSetHeader() throws Exception { + final Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); + try (CSVParser parser = CSVFormat.DEFAULT.withHeader("a", "b", "c").withSkipHeaderRecord().parse(in)) { + final Iterator records = parser.iterator(); + final CSVRecord record = records.next(); + assertEquals("1", record.get("a")); + assertEquals("2", record.get("b")); + assertEquals("3", record.get("c")); + } + } + + @Test + @Disabled + void testStartWithEmptyLinesThenHeaders() throws Exception { + final String[] codes = { "\r\n\r\n\r\nhello,\r\n\r\n\r\n", "hello,\n\n\n", "hello,\"\"\r\n\r\n\r\n", "hello,\"\"\n\n\n" }; + final String[][] res = { { "hello", "" }, { "" }, // Excel format does not ignore empty lines + { "" } }; + for (final String code : codes) { + try (CSVParser parser = CSVParser.parse(code, CSVFormat.EXCEL)) { + final List records = parser.getRecords(); + assertEquals(res.length, records.size()); + assertFalse(records.isEmpty()); + for (int i = 0; i < res.length; i++) { + assertValuesEquals(res[i], records.get(i)); + } + } + } + } + + @Test + void testStream() throws Exception { + final Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); + try (CSVParser parser = CSVFormat.DEFAULT.parse(in)) { + final List list = parser.stream().collect(Collectors.toList()); + assertFalse(list.isEmpty()); + assertValuesEquals(new String[] { "a", "b", "c" }, list.get(0)); + assertValuesEquals(new String[] { "1", "2", "3" }, list.get(1)); + assertValuesEquals(new String[] { "x", "y", "z" }, list.get(2)); + } + } + + @ParameterizedTest + @ValueSource(longs = { -1, 0, 1, 2, 3, 4, Long.MAX_VALUE }) + void testStreamMaxRows(final long maxRows) throws Exception { + final Reader in = new StringReader("a,b,c\n1,2,3\nx,y,z"); + try (CSVParser parser = CSVFormat.DEFAULT.builder().setMaxRows(maxRows).get().parse(in)) { + final List list = parser.stream().collect(Collectors.toList()); + assertFalse(list.isEmpty()); + assertValuesEquals(new String[] { "a", "b", "c" }, list.get(0)); + if (maxRows <= 0 || maxRows > 1) { + assertValuesEquals(new String[] { "1", "2", "3" }, list.get(1)); + } + if (maxRows <= 0 || maxRows > 2) { + assertValuesEquals(new String[] { "x", "y", "z" }, list.get(2)); + } + } + } + + @Test + void testThrowExceptionWithLineAndPosition() throws IOException { + final String csvContent = "col1,col2,col3,col4,col5,col6,col7,col8,col9,col10\nrec1,rec2,rec3,rec4,rec5,rec6,rec7,rec8,\"\"rec9\"\",rec10"; + final StringReader stringReader = new StringReader(csvContent); + // @formatter:off + final CSVFormat csvFormat = CSVFormat.DEFAULT.builder() + .setHeader() + .setSkipHeaderRecord(true) + .get(); + // @formatter:on + try (CSVParser csvParser = csvFormat.parse(stringReader)) { + final UncheckedIOException exception = assertThrows(UncheckedIOException.class, csvParser::getRecords); + assertInstanceOf(CSVException.class, exception.getCause()); + assertTrue(exception.getMessage().contains("Invalid character between encapsulated token and delimiter at line: 2, position: 94"), + exception::getMessage); + } + } + + @Test + void testTrailingDelimiter() throws Exception { + final Reader in = new StringReader("a,a,a,\n\"1\",\"2\",\"3\",\nx,y,z,"); + try (CSVParser parser = CSVFormat.DEFAULT.withHeader("X", "Y", "Z").withSkipHeaderRecord().withTrailingDelimiter().parse(in)) { + final Iterator records = parser.iterator(); + final CSVRecord record = records.next(); + assertEquals("1", record.get("X")); + assertEquals("2", record.get("Y")); + assertEquals("3", record.get("Z")); + assertEquals(3, record.size()); + } + } + + @Test + void testTrailingDelimiterKeepsQuotedEmptyLastField() throws Exception { + final CSVFormat format = CSVFormat.DEFAULT.builder().setTrailingDelimiter(true).get(); + try (CSVParser parser = CSVParser.parse("a,b,\"\"", format)) { + final CSVRecord record = parser.iterator().next(); + assertEquals(3, record.size()); + assertEquals("a", record.get(0)); + assertEquals("b", record.get(1)); + assertEquals("", record.get(2)); + } + // An unquoted trailing delimiter still drops the empty field. + try (CSVParser parser = CSVParser.parse("a,b,", format)) { + final CSVRecord record = parser.iterator().next(); + assertEquals(2, record.size()); + } + } + + @Test + void testTrim() throws Exception { + final Reader in = new StringReader("a,a,a\n\" 1 \",\" 2 \",\" 3 \"\nx,y,z"); + try (CSVParser parser = CSVFormat.DEFAULT.withHeader("X", "Y", "Z").withSkipHeaderRecord().withTrim().parse(in)) { + final Iterator records = parser.iterator(); + final CSVRecord record = records.next(); + assertEquals("1", record.get("X")); + assertEquals("2", record.get("Y")); + assertEquals("3", record.get("Z")); + assertEquals(3, record.size()); + } + } + + private void validateLineNumbers(final String lineSeparator) throws IOException { + try (CSVParser parser = CSVParser.parse("a" + lineSeparator + "b" + lineSeparator + "c", CSVFormat.DEFAULT.withRecordSeparator(lineSeparator))) { + assertEquals(0, parser.getCurrentLineNumber()); + assertNotNull(parser.nextRecord()); + assertEquals(1, parser.getCurrentLineNumber()); + assertNotNull(parser.nextRecord()); + assertEquals(2, parser.getCurrentLineNumber()); + assertNotNull(parser.nextRecord()); + // Read EOF without EOL should 3 + assertEquals(3, parser.getCurrentLineNumber()); + assertNull(parser.nextRecord()); + // Read EOF without EOL should 3 + assertEquals(3, parser.getCurrentLineNumber()); + } + } + + private void validateRecordNumbers(final String lineSeparator) throws IOException { + try (CSVParser parser = CSVParser.parse("a" + lineSeparator + "b" + lineSeparator + "c", CSVFormat.DEFAULT.withRecordSeparator(lineSeparator))) { + CSVRecord record; + assertEquals(0, parser.getRecordNumber()); + assertNotNull(record = parser.nextRecord()); + assertEquals(1, record.getRecordNumber()); + assertEquals(1, parser.getRecordNumber()); + assertNotNull(record = parser.nextRecord()); + assertEquals(2, record.getRecordNumber()); + assertEquals(2, parser.getRecordNumber()); + assertNotNull(record = parser.nextRecord()); + assertEquals(3, record.getRecordNumber()); + assertEquals(3, parser.getRecordNumber()); + assertNull(record = parser.nextRecord()); + assertEquals(3, parser.getRecordNumber()); + } + } + + private void validateRecordPosition(final String lineSeparator) throws IOException { + final String nl = lineSeparator; // used as linebreak in values for better distinction + final String code = "a,b,c" + lineSeparator + "1,2,3" + lineSeparator + + // to see if recordPosition correctly points to the enclosing quote + "'A" + nl + "A','B" + nl + "B',CC" + lineSeparator + + // unicode test... not very relevant while operating on strings instead of bytes, but for + // completeness... + "\u00c4,\u00d6,\u00dc" + lineSeparator + "EOF,EOF,EOF"; + final CSVFormat format = CSVFormat.newFormat(',').withQuote('\'').withRecordSeparator(lineSeparator); + final long positionRecord3; + try (CSVParser parser = CSVParser.parse(code, format)) { + CSVRecord record; + assertEquals(0, parser.getRecordNumber()); + // nextRecord + assertNotNull(record = parser.nextRecord()); + assertEquals(1, record.getRecordNumber()); + assertEquals(code.indexOf('a'), record.getCharacterPosition()); + // nextRecord + assertNotNull(record = parser.nextRecord()); + assertEquals(2, record.getRecordNumber()); + assertEquals(code.indexOf('1'), record.getCharacterPosition()); + // nextRecord + assertNotNull(record = parser.nextRecord()); + positionRecord3 = record.getCharacterPosition(); + assertEquals(3, record.getRecordNumber()); + assertEquals(code.indexOf("'A"), record.getCharacterPosition()); + assertEquals("A" + lineSeparator + "A", record.get(0)); + assertEquals("B" + lineSeparator + "B", record.get(1)); + assertEquals("CC", record.get(2)); + // nextRecord + assertNotNull(record = parser.nextRecord()); + assertEquals(4, record.getRecordNumber()); + assertEquals(code.indexOf('\u00c4'), record.getCharacterPosition()); + // nextRecord + assertNotNull(record = parser.nextRecord()); + assertEquals(5, record.getRecordNumber()); + assertEquals(code.indexOf("EOF"), record.getCharacterPosition()); + } + // now try to read starting at record 3 + try (CSVParser parser = CSVParser.builder() + .setReader(new StringReader(code.substring((int) positionRecord3))) + .setFormat(format) + .setCharacterOffset(positionRecord3) + .setRecordNumber(3) + .get()) { + CSVRecord record; + // nextRecord + assertNotNull(record = parser.nextRecord()); + assertEquals(3, record.getRecordNumber()); + assertEquals(code.indexOf("'A"), record.getCharacterPosition()); + assertEquals("A" + lineSeparator + "A", record.get(0)); + assertEquals("B" + lineSeparator + "B", record.get(1)); + assertEquals("CC", record.get(2)); + // nextRecord + assertNotNull(record = parser.nextRecord()); + assertEquals(4, record.getRecordNumber()); + assertEquals(code.indexOf('\u00c4'), record.getCharacterPosition()); + assertEquals("\u00c4", record.get(0)); + } // again with ctor + try (CSVParser parser = new CSVParser(new StringReader(code.substring((int) positionRecord3)), format, positionRecord3, 3)) { + CSVRecord record; + // nextRecord + assertNotNull(record = parser.nextRecord()); + assertEquals(3, record.getRecordNumber()); + assertEquals(code.indexOf("'A"), record.getCharacterPosition()); + assertEquals("A" + lineSeparator + "A", record.get(0)); + assertEquals("B" + lineSeparator + "B", record.get(1)); + assertEquals("CC", record.get(2)); + // nextRecord + assertNotNull(record = parser.nextRecord()); + assertEquals(4, record.getRecordNumber()); + assertEquals(code.indexOf('\u00c4'), record.getCharacterPosition()); + assertEquals("\u00c4", record.get(0)); + } + } +} diff --git a/src/test/java/org/apache/commons/csv/CSVPrinterTest.java b/src/test/java/org/apache/commons/csv/CSVPrinterTest.java index 99e82fa646..9ae80c1e51 100644 --- a/src/test/java/org/apache/commons/csv/CSVPrinterTest.java +++ b/src/test/java/org/apache/commons/csv/CSVPrinterTest.java @@ -1,1913 +1,2062 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.apache.commons.csv; - -import static org.apache.commons.csv.Constants.BACKSLASH; -import static org.apache.commons.csv.Constants.CR; -import static org.junit.jupiter.api.Assertions.assertArrayEquals; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertFalse; -import static org.junit.jupiter.api.Assertions.assertNotEquals; -import static org.junit.jupiter.api.Assertions.assertNull; -import static org.junit.jupiter.api.Assertions.assertThrows; -import static org.mockito.Mockito.mock; -import static org.mockito.Mockito.never; -import static org.mockito.Mockito.times; -import static org.mockito.Mockito.verify; - -import java.io.CharArrayWriter; -import java.io.File; -import java.io.FileReader; -import java.io.IOException; -import java.io.PrintStream; -import java.io.Reader; -import java.io.StringReader; -import java.io.StringWriter; -import java.io.Writer; -import java.nio.charset.Charset; -import java.nio.charset.StandardCharsets; -import java.nio.file.Files; -import java.nio.file.Path; -import java.sql.BatchUpdateException; -import java.sql.Connection; -import java.sql.DriverManager; -import java.sql.ResultSet; -import java.sql.SQLException; -import java.sql.Statement; -import java.util.Arrays; -import java.util.Date; -import java.util.HashSet; -import java.util.Iterator; -import java.util.LinkedList; -import java.util.List; -import java.util.Objects; -import java.util.Random; -import java.util.Vector; -import java.util.stream.Stream; - -import org.apache.commons.io.FileUtils; -import org.apache.commons.io.IOUtils; -import org.apache.commons.io.output.NullOutputStream; -import org.apache.commons.lang3.StringUtils; -import org.h2.tools.SimpleResultSet; -import org.junit.jupiter.api.Disabled; -import org.junit.jupiter.api.Test; - -/** - * Tests {@link CSVPrinter}. - */ -public class CSVPrinterTest { - - private static final int TABLE_RECORD_COUNT = 2; - private static final char DQUOTE_CHAR = '"'; - private static final char EURO_CH = '\u20AC'; - private static final int ITERATIONS_FOR_RANDOM_TEST = 50000; - private static final char QUOTE_CH = '\''; - - private static String printable(final String s) { - final StringBuilder sb = new StringBuilder(); - for (int i = 0; i < s.length(); i++) { - final char ch = s.charAt(i); - if (ch <= ' ' || ch >= 128) { - sb.append("(").append((int) ch).append(")"); - } else { - sb.append(ch); - } - } - return sb.toString(); - } - - private String longText2; - - private final String recordSeparator = CSVFormat.DEFAULT.getRecordSeparator(); - - private void assertInitialState(final CSVPrinter printer) { - assertEquals(0, printer.getRecordCount()); - } - - private File createTempFile() throws IOException { - return createTempPath().toFile(); - } - - private Path createTempPath() throws IOException { - return Files.createTempFile(getClass().getName(), ".csv"); - } - - private void doOneRandom(final CSVFormat format) throws Exception { - final Random r = new Random(); - - final int nLines = r.nextInt(4) + 1; - final int nCol = r.nextInt(3) + 1; - // nLines=1;nCol=2; - final String[][] lines = generateLines(nLines, nCol); - - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, format)) { - - for (int i = 0; i < nLines; i++) { - // for (int j=0; j parseResult = parser.getRecords(); - - final String[][] expected = lines.clone(); - for (int i = 0; i < expected.length; i++) { - expected[i] = expectNulls(expected[i], format); - } - Utils.compare("Printer output :" + printable(result), expected, parseResult); - } - } - - private void doRandom(final CSVFormat format, final int iter) throws Exception { - for (int i = 0; i < iter; i++) { - doOneRandom(format); - } - } - - /** - * Converts an input CSV array into expected output values WRT NULLs. NULL strings are converted to null values because the parser will convert these - * strings to null. - */ - private T[] expectNulls(final T[] original, final CSVFormat csvFormat) { - final T[] fixed = original.clone(); - for (int i = 0; i < fixed.length; i++) { - if (Objects.equals(csvFormat.getNullString(), fixed[i])) { - fixed[i] = null; - } - } - return fixed; - } - - private String[][] generateLines(final int nLines, final int nCol) { - final String[][] lines = new String[nLines][]; - for (int i = 0; i < nLines; i++) { - final String[] line = new String[nCol]; - lines[i] = line; - for (int j = 0; j < nCol; j++) { - line[j] = randStr(); - } - } - return lines; - } - - private Connection getH2Connection() throws SQLException, ClassNotFoundException { - Class.forName("org.h2.Driver"); - return DriverManager.getConnection("jdbc:h2:mem:my_test;", "sa", ""); - } - - private CSVPrinter printWithHeaderComments(final StringWriter sw, final Date now, final CSVFormat baseFormat) throws IOException { - // Use withHeaderComments first to test CSV-145 - // @formatter:off - final CSVFormat format = baseFormat.builder() - .setHeaderComments("Generated by Apache Commons CSV 1.1", now) - .setCommentMarker('#') - .setHeader("Col1", "Col2") - .get(); - // @formatter:on - final CSVPrinter printer = format.print(sw); - printer.printRecord("A", "B"); - printer.printRecord("C", "D"); - printer.close(); - return printer; - } - - private String randStr() { - final Random r = new Random(); - final int sz = r.nextInt(20); - // sz = r.nextInt(3); - final char[] buf = new char[sz]; - for (int i = 0; i < sz; i++) { - // stick in special chars with greater frequency - final char ch; - final int what = r.nextInt(20); - switch (what) { - case 0: - ch = '\r'; - break; - case 1: - ch = '\n'; - break; - case 2: - ch = '\t'; - break; - case 3: - ch = '\f'; - break; - case 4: - ch = ' '; - break; - case 5: - ch = ','; - break; - case 6: - ch = DQUOTE_CHAR; - break; - case 7: - ch = '\''; - break; - case 8: - ch = BACKSLASH; - break; - default: - ch = (char) r.nextInt(300); - break; - // default: ch = 'a'; break; - } - buf[i] = ch; - } - return new String(buf); - } - - private void setUpTable(final Connection connection) throws SQLException { - try (final Statement statement = connection.createStatement()) { - statement.execute("CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255), TEXT CLOB, BIN_DATA BLOB)"); - statement.execute("insert into TEST values(1, 'r1', 'long text 1', 'binary data 1')"); - longText2 = StringUtils.repeat('a', IOUtils.DEFAULT_BUFFER_SIZE - 4); - longText2 += "\"\r\n\"b\""; - longText2 += StringUtils.repeat('c', IOUtils.DEFAULT_BUFFER_SIZE - 1); - statement.execute("insert into TEST values(2, 'r2', '" + longText2 + "', 'binary data 2')"); - longText2 = longText2.replace("\"", "\"\""); - } - } - - @Test - public void testCloseBackwardCompatibility() throws IOException { - try (final Writer writer = mock(Writer.class)) { - final CSVFormat csvFormat = CSVFormat.DEFAULT; - try (CSVPrinter printer = new CSVPrinter(writer, csvFormat)) { - assertInitialState(printer); - } - verify(writer, never()).flush(); - verify(writer, times(1)).close(); - } - } - - @Test - public void testCloseWithCsvFormatAutoFlushOff() throws IOException { - try (final Writer writer = mock(Writer.class)) { - final CSVFormat csvFormat = CSVFormat.DEFAULT.withAutoFlush(false); - try (CSVPrinter printer = new CSVPrinter(writer, csvFormat)) { - assertInitialState(printer); - } - verify(writer, never()).flush(); - verify(writer, times(1)).close(); - } - } - - @Test - public void testCloseWithCsvFormatAutoFlushOn() throws IOException { - // System.out.println("start method"); - try (final Writer writer = mock(Writer.class)) { - final CSVFormat csvFormat = CSVFormat.DEFAULT.withAutoFlush(true); - try (CSVPrinter printer = new CSVPrinter(writer, csvFormat)) { - assertInitialState(printer); - } - verify(writer, times(1)).flush(); - verify(writer, times(1)).close(); - } - } - - @Test - public void testCloseWithFlushOff() throws IOException { - try (final Writer writer = mock(Writer.class)) { - final CSVFormat csvFormat = CSVFormat.DEFAULT; - @SuppressWarnings("resource") - final CSVPrinter printer = new CSVPrinter(writer, csvFormat); - assertInitialState(printer); - printer.close(false); - assertEquals(0, printer.getRecordCount()); - verify(writer, never()).flush(); - verify(writer, times(1)).close(); - } - } - - @Test - public void testCloseWithFlushOn() throws IOException { - try (final Writer writer = mock(Writer.class)) { - @SuppressWarnings("resource") - final CSVPrinter printer = new CSVPrinter(writer, CSVFormat.DEFAULT); - assertInitialState(printer); - printer.close(true); - assertEquals(0, printer.getRecordCount()); - verify(writer, times(1)).flush(); - } - } - - @Test - public void testCRComment() throws IOException { - final StringWriter sw = new StringWriter(); - final Object value = "abc"; - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withCommentMarker('#'))) { - assertInitialState(printer); - printer.print(value); - assertEquals(0, printer.getRecordCount()); - printer.printComment("This is a comment\r\non multiple lines\rthis is next comment\r"); - assertEquals("abc" + recordSeparator + "# This is a comment" + recordSeparator + "# on multiple lines" + recordSeparator + - "# this is next comment" + recordSeparator + "# " + recordSeparator, sw.toString()); - assertEquals(0, printer.getRecordCount()); - } - } - - @Test - public void testCSV135() throws IOException { - final List list = new LinkedList<>(); - list.add("\"\""); // "" - list.add("\\\\"); // \\ - list.add("\\\"\\"); // \"\ - // - // "",\\,\"\ (unchanged) - tryFormat(list, null, null, "\"\",\\\\,\\\"\\"); - // - // """""",\\,"\""\" (quoted, and embedded DQ doubled) - tryFormat(list, '"', null, "\"\"\"\"\"\",\\\\,\"\\\"\"\\\""); - // - // "",\\\\,\\"\\ (escapes escaped, not quoted) - tryFormat(list, null, '\\', "\"\",\\\\\\\\,\\\\\"\\\\"); - // - // "\"\"","\\\\","\\\"\\" (quoted, and embedded DQ & escape escaped) - tryFormat(list, '"', '\\', "\"\\\"\\\"\",\"\\\\\\\\\",\"\\\\\\\"\\\\\""); - // - // """""",\\,"\""\" (quoted, embedded DQ escaped) - tryFormat(list, '"', '"', "\"\"\"\"\"\",\\\\,\"\\\"\"\\\""); - } - - @Test - public void testCSV259() throws IOException { - final StringWriter sw = new StringWriter(); - try (final Reader reader = new FileReader("src/test/resources/org/apache/commons/csv/CSV-259/sample.txt"); - final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withEscape('!').withQuote(null))) { - assertInitialState(printer); - printer.print(reader); - assertEquals("x!,y!,z", sw.toString()); - } - } - - @Test - public void testDelimeterQuoted() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote('\''))) { - assertInitialState(printer); - printer.print("a,b,c"); - printer.print("xyz"); - assertEquals("'a,b,c',xyz", sw.toString()); - } - } - - @Test - public void testDelimeterQuoteNone() throws IOException { - final StringWriter sw = new StringWriter(); - final CSVFormat format = CSVFormat.DEFAULT.withEscape('!').withQuoteMode(QuoteMode.NONE); - try (final CSVPrinter printer = new CSVPrinter(sw, format)) { - assertInitialState(printer); - printer.print("a,b,c"); - printer.print("xyz"); - assertEquals("a!,b!,c,xyz", sw.toString()); - } - } - - @Test - public void testDelimeterStringQuoted() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.builder().setDelimiter("[|]").setQuote('\'').get())) { - assertInitialState(printer); - printer.print("a[|]b[|]c"); - printer.print("xyz"); - assertEquals("'a[|]b[|]c'[|]xyz", sw.toString()); - } - } - - @Test - public void testDelimeterStringQuoteNone() throws IOException { - final StringWriter sw = new StringWriter(); - final CSVFormat format = CSVFormat.DEFAULT.builder().setDelimiter("[|]").setEscape('!').setQuoteMode(QuoteMode.NONE).get(); - try (final CSVPrinter printer = new CSVPrinter(sw, format)) { - assertInitialState(printer); - printer.print("a[|]b[|]c"); - printer.print("xyz"); - printer.print("a[xy]bc[]"); - assertEquals("a![!|!]b![!|!]c[|]xyz[|]a[xy]bc[]", sw.toString()); - } - } - - @Test - public void testDelimiterEscaped() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withEscape('!').withQuote(null))) { - assertInitialState(printer); - printer.print("a,b,c"); - printer.print("xyz"); - assertEquals("a!,b!,c,xyz", sw.toString()); - } - } - - @Test - public void testDelimiterPlain() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null))) { - assertInitialState(printer); - printer.print("a,b,c"); - printer.print("xyz"); - assertEquals("a,b,c,xyz", sw.toString()); - } - } - - @Test - public void testDelimiterStringEscaped() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.builder().setDelimiter("|||").setEscape('!').setQuote(null).get())) { - assertInitialState(printer); - printer.print("a|||b|||c"); - printer.print("xyz"); - assertEquals("a!|!|!|b!|!|!|c|||xyz", sw.toString()); - } - } - - @Test - public void testDisabledComment() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT)) { - assertInitialState(printer); - printer.printComment("This is a comment"); - assertEquals("", sw.toString()); - assertEquals(0, printer.getRecordCount()); - } - } - - @Test - public void testDontQuoteEuroFirstChar() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.RFC4180)) { - assertInitialState(printer); - printer.printRecord(EURO_CH, "Deux"); - assertEquals(EURO_CH + ",Deux" + recordSeparator, sw.toString()); - } - } - - @Test - public void testEolEscaped() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null).withEscape('!'))) { - assertInitialState(printer); - printer.print("a\rb\nc"); - printer.print("x\fy\bz"); - assertEquals("a!rb!nc,x\fy\bz", sw.toString()); - } - } - - @Test - public void testEolPlain() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null))) { - assertInitialState(printer); - printer.print("a\rb\nc"); - printer.print("x\fy\bz"); - assertEquals("a\rb\nc,x\fy\bz", sw.toString()); - } - } - - @Test - public void testEolQuoted() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote('\''))) { - assertInitialState(printer); - printer.print("a\rb\nc"); - printer.print("x\by\fz"); - assertEquals("'a\rb\nc',x\by\fz", sw.toString()); - } - } - - @Test - public void testEscapeBackslash1() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(QUOTE_CH))) { - assertInitialState(printer); - printer.print("\\"); - } - assertEquals("\\", sw.toString()); - } - - @Test - public void testEscapeBackslash2() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(QUOTE_CH))) { - assertInitialState(printer); - printer.print("\\\r"); - } - assertEquals("'\\\r'", sw.toString()); - } - - @Test - public void testEscapeBackslash3() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(QUOTE_CH))) { - assertInitialState(printer); - printer.print("X\\\r"); - } - assertEquals("'X\\\r'", sw.toString()); - } - - @Test - public void testEscapeBackslash4() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(QUOTE_CH))) { - assertInitialState(printer); - printer.print("\\\\"); - } - assertEquals("\\\\", sw.toString()); - } - - @Test - public void testEscapeBackslash5() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(QUOTE_CH))) { - assertInitialState(printer); - printer.print("\\\\"); - } - assertEquals("\\\\", sw.toString()); - } - - @Test - public void testEscapeNull1() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withEscape(null))) { - assertInitialState(printer); - printer.print("\\"); - } - assertEquals("\\", sw.toString()); - } - - @Test - public void testEscapeNull2() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withEscape(null))) { - assertInitialState(printer); - printer.print("\\\r"); - } - assertEquals("\"\\\r\"", sw.toString()); - } - - @Test - public void testEscapeNull3() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withEscape(null))) { - assertInitialState(printer); - printer.print("X\\\r"); - } - assertEquals("\"X\\\r\"", sw.toString()); - } - - @Test - public void testEscapeNull4() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withEscape(null))) { - assertInitialState(printer); - printer.print("\\\\"); - } - assertEquals("\\\\", sw.toString()); - } - - @Test - public void testEscapeNull5() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withEscape(null))) { - assertInitialState(printer); - printer.print("\\\\"); - } - assertEquals("\\\\", sw.toString()); - } - - @Test - public void testExcelPrintAllArrayOfArrays() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { - assertInitialState(printer); - printer.printRecords((Object[]) new String[][] { { "r1c1", "r1c2" }, { "r2c1", "r2c2" } }); - assertEquals("r1c1,r1c2" + recordSeparator + "r2c1,r2c2" + recordSeparator, sw.toString()); - } - } - - @Test - public void testExcelPrintAllArrayOfArraysWithFirstEmptyValue2() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { - assertInitialState(printer); - printer.printRecords((Object[]) new String[][] { { "" } }); - assertEquals("\"\"" + recordSeparator, sw.toString()); - } - } - - @Test - public void testExcelPrintAllArrayOfArraysWithFirstSpaceValue1() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { - assertInitialState(printer); - printer.printRecords((Object[]) new String[][] { { " ", "r1c2" } }); - assertEquals("\" \",r1c2" + recordSeparator, sw.toString()); - } - } - - @Test - public void testExcelPrintAllArrayOfArraysWithFirstTabValue1() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { - assertInitialState(printer); - printer.printRecords((Object[]) new String[][] { { "\t", "r1c2" } }); - assertEquals("\"\t\",r1c2" + recordSeparator, sw.toString()); - } - } - - @Test - public void testExcelPrintAllArrayOfLists() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { - assertInitialState(printer); - printer.printRecords((Object[]) new List[] { Arrays.asList("r1c1", "r1c2"), Arrays.asList("r2c1", "r2c2") }); - assertEquals("r1c1,r1c2" + recordSeparator + "r2c1,r2c2" + recordSeparator, sw.toString()); - } - } - - @Test - public void testExcelPrintAllArrayOfListsWithFirstEmptyValue2() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { - assertInitialState(printer); - printer.printRecords((Object[]) new List[] { Arrays.asList("") }); - assertEquals("\"\"" + recordSeparator, sw.toString()); - } - } - - @Test - public void testExcelPrintAllIterableOfArrays() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { - assertInitialState(printer); - printer.printRecords(Arrays.asList(new String[][] { { "r1c1", "r1c2" }, { "r2c1", "r2c2" } })); - assertEquals("r1c1,r1c2" + recordSeparator + "r2c1,r2c2" + recordSeparator, sw.toString()); - } - } - - @Test - public void testExcelPrintAllIterableOfArraysWithFirstEmptyValue2() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { - assertInitialState(printer); - printer.printRecords(Arrays.asList(new String[][] { { "" } })); - assertEquals("\"\"" + recordSeparator, sw.toString()); - } - } - - @Test - public void testExcelPrintAllIterableOfLists() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { - assertInitialState(printer); - printer.printRecords(Arrays.asList(Arrays.asList("r1c1", "r1c2"), Arrays.asList("r2c1", "r2c2"))); - assertEquals("r1c1,r1c2" + recordSeparator + "r2c1,r2c2" + recordSeparator, sw.toString()); - } - } - - @Test - public void testExcelPrintAllStreamOfArrays() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { - assertInitialState(printer); - printer.printRecords(Stream.of(new String[][] { { "r1c1", "r1c2" }, { "r2c1", "r2c2" } })); - assertEquals("r1c1,r1c2" + recordSeparator + "r2c1,r2c2" + recordSeparator, sw.toString()); - } - } - - @Test - public void testExcelPrinter1() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { - assertInitialState(printer); - printer.printRecord("a", "b"); - assertEquals("a,b" + recordSeparator, sw.toString()); - } - } - - @Test - public void testExcelPrinter2() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { - assertInitialState(printer); - printer.printRecord("a,b", "b"); - assertEquals("\"a,b\",b" + recordSeparator, sw.toString()); - } - } - - @Test - public void testHeader() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null).withHeader("C1", "C2", "C3"))) { - assertEquals(1, printer.getRecordCount()); - printer.printRecord("a", "b", "c"); - printer.printRecord("x", "y", "z"); - assertEquals("C1,C2,C3\r\na,b,c\r\nx,y,z\r\n", sw.toString()); - } - } - - @Test - public void testHeaderCommentExcel() throws IOException { - final StringWriter sw = new StringWriter(); - final Date now = new Date(); - final CSVFormat format = CSVFormat.EXCEL; - try (final CSVPrinter csvPrinter = printWithHeaderComments(sw, now, format)) { - assertEquals("# Generated by Apache Commons CSV 1.1\r\n# " + now + "\r\nCol1,Col2\r\nA,B\r\nC,D\r\n", sw.toString()); - } - } - - @Test - public void testHeaderCommentTdf() throws IOException { - final StringWriter sw = new StringWriter(); - final Date now = new Date(); - final CSVFormat format = CSVFormat.TDF; - try (final CSVPrinter csvPrinter = printWithHeaderComments(sw, now, format)) { - assertEquals("# Generated by Apache Commons CSV 1.1\r\n# " + now + "\r\nCol1\tCol2\r\nA\tB\r\nC\tD\r\n", sw.toString()); - } - } - - @Test - public void testHeaderNotSet() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null))) { - assertInitialState(printer); - printer.printRecord("a", "b", "c"); - printer.printRecord("x", "y", "z"); - assertEquals("a,b,c\r\nx,y,z\r\n", sw.toString()); - } - } - - @Test - public void testInvalidFormat() { - assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withDelimiter(CR)); - } - - @Test - public void testJdbcPrinter() throws IOException, ClassNotFoundException, SQLException { - final StringWriter sw = new StringWriter(); - final CSVFormat csvFormat = CSVFormat.DEFAULT; - try (final Connection connection = getH2Connection()) { - setUpTable(connection); - try (final Statement stmt = connection.createStatement(); - final CSVPrinter printer = new CSVPrinter(sw, csvFormat); - final ResultSet resultSet = stmt.executeQuery("select ID, NAME, TEXT, BIN_DATA from TEST");) { - assertInitialState(printer); - printer.printRecords(resultSet); - assertEquals(TABLE_RECORD_COUNT, printer.getRecordCount()); - } - } - final String csv = sw.toString(); - assertEquals("1,r1,\"long text 1\",\"YmluYXJ5IGRhdGEgMQ==\r\n\"" + recordSeparator + "2,r2,\"" + longText2 + "\",\"YmluYXJ5IGRhdGEgMg==\r\n\"" + - recordSeparator, csv); - // Round trip the data - try (StringReader reader = new StringReader(csv); - final CSVParser csvParser = csvFormat.parse(reader)) { - // Row 1 - CSVRecord record = csvParser.nextRecord(); - assertEquals("1", record.get(0)); - assertEquals("r1", record.get(1)); - assertEquals("long text 1", record.get(2)); - assertEquals("YmluYXJ5IGRhdGEgMQ==\r\n", record.get(3)); - // Row 2 - record = csvParser.nextRecord(); - assertEquals("2", record.get(0)); - assertEquals("r2", record.get(1)); - assertEquals("YmluYXJ5IGRhdGEgMg==\r\n", record.get(3)); - } - } - - @Test - public void testJdbcPrinterWithFirstEmptyValue2() throws IOException, ClassNotFoundException, SQLException { - final StringWriter sw = new StringWriter(); - try (final Connection connection = getH2Connection()) { - try (final Statement stmt = connection.createStatement(); - final ResultSet resultSet = stmt.executeQuery("select '' AS EMPTYVALUE from DUAL"); - final CSVPrinter printer = CSVFormat.DEFAULT.withHeader(resultSet).print(sw)) { - printer.printRecords(resultSet); - } - } - assertEquals("EMPTYVALUE" + recordSeparator + "\"\"" + recordSeparator, sw.toString()); - } - - @Test - public void testJdbcPrinterWithResultSet() throws IOException, ClassNotFoundException, SQLException { - final StringWriter sw = new StringWriter(); - try (final Connection connection = getH2Connection()) { - setUpTable(connection); - try (final Statement stmt = connection.createStatement(); - final ResultSet resultSet = stmt.executeQuery("select ID, NAME, TEXT from TEST"); - final CSVPrinter printer = CSVFormat.DEFAULT.withHeader(resultSet).print(sw)) { - printer.printRecords(resultSet); - } - } - assertEquals("ID,NAME,TEXT" + recordSeparator + "1,r1,\"long text 1\"" + recordSeparator + "2,r2,\"" + longText2 + "\"" + recordSeparator, - sw.toString()); - } - - @Test - public void testJdbcPrinterWithResultSetHeader() throws IOException, ClassNotFoundException, SQLException { - final StringWriter sw = new StringWriter(); - try (final Connection connection = getH2Connection()) { - setUpTable(connection); - try (final Statement stmt = connection.createStatement(); - final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT);) { - try (final ResultSet resultSet = stmt.executeQuery("select ID, NAME from TEST")) { - printer.printRecords(resultSet, true); - assertEquals(TABLE_RECORD_COUNT, printer.getRecordCount()); - assertEquals("ID,NAME" + recordSeparator + "1,r1" + recordSeparator + "2,r2" + recordSeparator, sw.toString()); - } - try (final ResultSet resultSet = stmt.executeQuery("select ID, NAME from TEST")) { - printer.printRecords(resultSet, false); - assertEquals(TABLE_RECORD_COUNT * 2, printer.getRecordCount()); - assertNotEquals("ID,NAME" + recordSeparator + "1,r1" + recordSeparator + "2,r2" + recordSeparator, sw.toString()); - } - } - } - } - - @Test - public void testJdbcPrinterWithResultSetMetaData() throws IOException, ClassNotFoundException, SQLException { - final StringWriter sw = new StringWriter(); - try (final Connection connection = getH2Connection()) { - setUpTable(connection); - try (final Statement stmt = connection.createStatement(); - final ResultSet resultSet = stmt.executeQuery("select ID, NAME, TEXT from TEST"); - final CSVPrinter printer = CSVFormat.DEFAULT.withHeader(resultSet.getMetaData()).print(sw)) { - // The header is the first record. - assertEquals(1, printer.getRecordCount()); - printer.printRecords(resultSet); - assertEquals(3, printer.getRecordCount()); - assertEquals("ID,NAME,TEXT" + recordSeparator + "1,r1,\"long text 1\"" + recordSeparator + "2,r2,\"" + longText2 + "\"" + recordSeparator, - sw.toString()); - } - } - } - - @Test - public void testJira135_part1() throws IOException { - final CSVFormat format = CSVFormat.DEFAULT.withRecordSeparator('\n').withQuote(DQUOTE_CHAR).withEscape(BACKSLASH); - final StringWriter sw = new StringWriter(); - final List list = new LinkedList<>(); - try (final CSVPrinter printer = new CSVPrinter(sw, format)) { - list.add("\""); - printer.printRecord(list); - } - final String expected = "\"\\\"\"" + format.getRecordSeparator(); - assertEquals(expected, sw.toString()); - final String[] record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(list.toArray(), format), record0); - } - - @Test - @Disabled - public void testJira135_part2() throws IOException { - final CSVFormat format = CSVFormat.DEFAULT.withRecordSeparator('\n').withQuote(DQUOTE_CHAR).withEscape(BACKSLASH); - final StringWriter sw = new StringWriter(); - final List list = new LinkedList<>(); - try (final CSVPrinter printer = new CSVPrinter(sw, format)) { - list.add("\n"); - printer.printRecord(list); - } - final String expected = "\"\\n\"" + format.getRecordSeparator(); - assertEquals(expected, sw.toString()); - final String[] record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(list.toArray(), format), record0); - } - - @Test - public void testJira135_part3() throws IOException { - final CSVFormat format = CSVFormat.DEFAULT.withRecordSeparator('\n').withQuote(DQUOTE_CHAR).withEscape(BACKSLASH); - final StringWriter sw = new StringWriter(); - final List list = new LinkedList<>(); - try (final CSVPrinter printer = new CSVPrinter(sw, format)) { - list.add("\\"); - printer.printRecord(list); - } - final String expected = "\"\\\\\"" + format.getRecordSeparator(); - assertEquals(expected, sw.toString()); - final String[] record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(list.toArray(), format), record0); - } - - @Test - @Disabled - public void testJira135All() throws IOException { - final CSVFormat format = CSVFormat.DEFAULT.withRecordSeparator('\n').withQuote(DQUOTE_CHAR).withEscape(BACKSLASH); - final StringWriter sw = new StringWriter(); - final List list = new LinkedList<>(); - try (final CSVPrinter printer = new CSVPrinter(sw, format)) { - list.add("\""); - list.add("\n"); - list.add("\\"); - printer.printRecord(list); - } - final String expected = "\"\\\"\",\"\\n\",\"\\\"" + format.getRecordSeparator(); - assertEquals(expected, sw.toString()); - final String[] record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(list.toArray(), format), record0); - } - - @Test - public void testMongoDbCsvBasic() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.MONGODB_CSV)) { - printer.printRecord("a", "b"); - assertEquals("a,b" + recordSeparator, sw.toString()); - assertEquals(1, printer.getRecordCount()); - } - } - - @Test - public void testMongoDbCsvCommaInValue() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.MONGODB_CSV)) { - printer.printRecord("a,b", "c"); - assertEquals("\"a,b\",c" + recordSeparator, sw.toString()); - assertEquals(1, printer.getRecordCount()); - } - } - - @Test - public void testMongoDbCsvDoubleQuoteInValue() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.MONGODB_CSV)) { - printer.printRecord("a \"c\" b", "d"); - assertEquals("\"a \"\"c\"\" b\",d" + recordSeparator, sw.toString()); - assertEquals(1, printer.getRecordCount()); - } - } - - @Test - public void testMongoDbCsvTabInValue() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.MONGODB_CSV)) { - printer.printRecord("a\tb", "c"); - assertEquals("a\tb,c" + recordSeparator, sw.toString()); - assertEquals(1, printer.getRecordCount()); - } - } - - @Test - public void testMongoDbTsvBasic() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.MONGODB_TSV)) { - printer.printRecord("a", "b"); - assertEquals("a\tb" + recordSeparator, sw.toString()); - assertEquals(1, printer.getRecordCount()); - } - } - - @Test - public void testMongoDbTsvCommaInValue() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.MONGODB_TSV)) { - printer.printRecord("a,b", "c"); - assertEquals("a,b\tc" + recordSeparator, sw.toString()); - assertEquals(1, printer.getRecordCount()); - } - } - - @Test - public void testMongoDbTsvTabInValue() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.MONGODB_TSV)) { - printer.printRecord("a\tb", "c"); - assertEquals("\"a\tb\"\tc" + recordSeparator, sw.toString()); - } - } - - @Test - public void testMultiLineComment() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withCommentMarker('#'))) { - printer.printComment("This is a comment\non multiple lines"); - assertEquals("# This is a comment" + recordSeparator + "# on multiple lines" + recordSeparator, sw.toString()); - assertEquals(0, printer.getRecordCount()); - } - } - - @Test - public void testMySqlNullOutput() throws IOException { - Object[] s = new String[] { "NULL", null }; - CSVFormat format = CSVFormat.MYSQL.withQuote(DQUOTE_CHAR).withNullString("NULL").withQuoteMode(QuoteMode.NON_NUMERIC); - StringWriter writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - String expected = "\"NULL\"\tNULL\n"; - assertEquals(expected, writer.toString()); - String[] record0 = toFirstRecordValues(expected, format); - assertArrayEquals(s, record0); - - s = new String[] { "\\N", null }; - format = CSVFormat.MYSQL.withNullString("\\N"); - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\\\\N\t\\N\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "\\N", "A" }; - format = CSVFormat.MYSQL.withNullString("\\N"); - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\\\\N\tA\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "\n", "A" }; - format = CSVFormat.MYSQL.withNullString("\\N"); - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\\n\tA\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "", null }; - format = CSVFormat.MYSQL.withNullString("NULL"); - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\tNULL\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "", null }; - format = CSVFormat.MYSQL; - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\t\\N\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "\\N", "", "\u000e,\\\r" }; - format = CSVFormat.MYSQL; - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\\\\N\t\t\u000e,\\\\\\r\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "NULL", "\\\r" }; - format = CSVFormat.MYSQL; - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "NULL\t\\\\\\r\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "\\\r" }; - format = CSVFormat.MYSQL; - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\\\\\\r\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - } - - @Test - public void testMySqlNullStringDefault() { - assertEquals("\\N", CSVFormat.MYSQL.getNullString()); - } - - @Test - public void testNewCsvPrinterAppendableNullFormat() { - assertThrows(NullPointerException.class, () -> new CSVPrinter(new StringWriter(), null)); - } - - @Test - public void testNewCsvPrinterNullAppendableFormat() { - assertThrows(NullPointerException.class, () -> new CSVPrinter(null, CSVFormat.DEFAULT)); - } - - @Test - public void testNotFlushable() throws IOException { - final Appendable out = new StringBuilder(); - try (final CSVPrinter printer = new CSVPrinter(out, CSVFormat.DEFAULT)) { - printer.printRecord("a", "b", "c"); - assertEquals("a,b,c" + recordSeparator, out.toString()); - printer.flush(); - } - } - - @Test - public void testParseCustomNullValues() throws IOException { - final StringWriter sw = new StringWriter(); - final CSVFormat format = CSVFormat.DEFAULT.withNullString("NULL"); - try (final CSVPrinter printer = new CSVPrinter(sw, format)) { - printer.printRecord("a", null, "b"); - } - final String csvString = sw.toString(); - assertEquals("a,NULL,b" + recordSeparator, csvString); - try (final CSVParser iterable = format.parse(new StringReader(csvString))) { - final Iterator iterator = iterable.iterator(); - final CSVRecord record = iterator.next(); - assertEquals("a", record.get(0)); - assertNull(record.get(1)); - assertEquals("b", record.get(2)); - assertFalse(iterator.hasNext()); - } - } - - @Test - public void testPlainEscaped() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null).withEscape('!'))) { - printer.print("abc"); - printer.print("xyz"); - assertEquals("abc,xyz", sw.toString()); - } - } - - @Test - public void testPlainPlain() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null))) { - printer.print("abc"); - printer.print("xyz"); - assertEquals("abc,xyz", sw.toString()); - } - } - - @Test - public void testPlainQuoted() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote('\''))) { - printer.print("abc"); - assertEquals("abc", sw.toString()); - } - } - - @Test - @Disabled - public void testPostgreSqlCsvNullOutput() throws IOException { - Object[] s = new String[] { "NULL", null }; - CSVFormat format = CSVFormat.POSTGRESQL_CSV.withQuote(DQUOTE_CHAR).withNullString("NULL").withQuoteMode(QuoteMode.ALL_NON_NULL); - StringWriter writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - String expected = "\"NULL\",NULL\n"; - assertEquals(expected, writer.toString()); - String[] record0 = toFirstRecordValues(expected, format); - assertArrayEquals(new Object[2], record0); - - s = new String[] { "\\N", null }; - format = CSVFormat.POSTGRESQL_CSV.withNullString("\\N"); - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\\\\N\t\\N\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "\\N", "A" }; - format = CSVFormat.POSTGRESQL_CSV.withNullString("\\N"); - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\\\\N\tA\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "\n", "A" }; - format = CSVFormat.POSTGRESQL_CSV.withNullString("\\N"); - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\\n\tA\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "", null }; - format = CSVFormat.POSTGRESQL_CSV.withNullString("NULL"); - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\tNULL\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "", null }; - format = CSVFormat.POSTGRESQL_CSV; - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\t\\N\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "\\N", "", "\u000e,\\\r" }; - format = CSVFormat.POSTGRESQL_CSV; - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\\\\N\t\t\u000e,\\\\\\r\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "NULL", "\\\r" }; - format = CSVFormat.POSTGRESQL_CSV; - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "NULL\t\\\\\\r\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "\\\r" }; - format = CSVFormat.POSTGRESQL_CSV; - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\\\\\\r\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - } - - @Test - @Disabled - public void testPostgreSqlCsvTextOutput() throws IOException { - Object[] s = new String[] { "NULL", null }; - CSVFormat format = CSVFormat.POSTGRESQL_TEXT.withQuote(DQUOTE_CHAR).withNullString("NULL").withQuoteMode(QuoteMode.ALL_NON_NULL); - StringWriter writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - String expected = "\"NULL\"\tNULL\n"; - assertEquals(expected, writer.toString()); - String[] record0 = toFirstRecordValues(expected, format); - assertArrayEquals(new Object[2], record0); - - s = new String[] { "\\N", null }; - format = CSVFormat.POSTGRESQL_TEXT.withNullString("\\N"); - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\\\\N\t\\N\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "\\N", "A" }; - format = CSVFormat.POSTGRESQL_TEXT.withNullString("\\N"); - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\\\\N\tA\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "\n", "A" }; - format = CSVFormat.POSTGRESQL_TEXT.withNullString("\\N"); - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\\n\tA\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "", null }; - format = CSVFormat.POSTGRESQL_TEXT.withNullString("NULL"); - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\tNULL\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "", null }; - format = CSVFormat.POSTGRESQL_TEXT; - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\t\\N\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "\\N", "", "\u000e,\\\r" }; - format = CSVFormat.POSTGRESQL_TEXT; - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\\\\N\t\t\u000e,\\\\\\r\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "NULL", "\\\r" }; - format = CSVFormat.POSTGRESQL_TEXT; - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "NULL\t\\\\\\r\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - - s = new String[] { "\\\r" }; - format = CSVFormat.POSTGRESQL_TEXT; - writer = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(writer, format)) { - printer.printRecord(s); - } - expected = "\\\\\\r\n"; - assertEquals(expected, writer.toString()); - record0 = toFirstRecordValues(expected, format); - assertArrayEquals(expectNulls(s, format), record0); - } - - @Test - public void testPostgreSqlNullStringDefaultCsv() { - assertEquals("", CSVFormat.POSTGRESQL_CSV.getNullString()); - } - - @Test - public void testPostgreSqlNullStringDefaultText() { - assertEquals("\\N", CSVFormat.POSTGRESQL_TEXT.getNullString()); - } - - @Test - public void testPrint() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = CSVFormat.DEFAULT.print(sw)) { - assertInitialState(printer); - printer.printRecord("a", "b\\c"); - assertEquals("a,b\\c" + recordSeparator, sw.toString()); - } - } - - @Test - public void testPrintCSVParser() throws IOException { - // @formatter:off - final String code = "a1,b1\n" + // 1) - "a2,b2\n" + // 2) - "a3,b3\n" + // 3) - "a4,b4\n"; // 4) - // @formatter:on - final String[][] res = { { "a1", "b1" }, { "a2", "b2" }, { "a3", "b3" }, { "a4", "b4" } }; - final CSVFormat format = CSVFormat.DEFAULT; - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = format.print(sw); - final CSVParser parser = CSVParser.parse(code, format)) { - assertInitialState(printer); - printer.printRecords(parser); - } - try (final CSVParser parser = CSVParser.parse(sw.toString(), format)) { - final List records = parser.getRecords(); - assertFalse(records.isEmpty()); - Utils.compare("Fail", res, records); - } - } - - @Test - public void testPrintCSVRecord() throws IOException { - // @formatter:off - final String code = "a1,b1\n" + // 1) - "a2,b2\n" + // 2) - "a3,b3\n" + // 3) - "a4,b4\n"; // 4) - // @formatter:on - final String[][] res = { { "a1", "b1" }, { "a2", "b2" }, { "a3", "b3" }, { "a4", "b4" } }; - final CSVFormat format = CSVFormat.DEFAULT; - final StringWriter sw = new StringWriter(); - int row = 0; - try (final CSVPrinter printer = format.print(sw); - final CSVParser parser = CSVParser.parse(code, format)) { - assertInitialState(printer); - for (final CSVRecord record : parser) { - printer.printRecord(record); - assertEquals(++row, printer.getRecordCount()); - } - assertEquals(row, printer.getRecordCount()); - } - try (final CSVParser parser = CSVParser.parse(sw.toString(), format)) { - final List records = parser.getRecords(); - assertFalse(records.isEmpty()); - Utils.compare("Fail", res, records); - } - } - - @Test - public void testPrintCSVRecords() throws IOException { - // @formatter:off - final String code = "a1,b1\n" + // 1) - "a2,b2\n" + // 2) - "a3,b3\n" + // 3) - "a4,b4\n"; // 4) - // @formatter:on - final String[][] res = { { "a1", "b1" }, { "a2", "b2" }, { "a3", "b3" }, { "a4", "b4" } }; - final CSVFormat format = CSVFormat.DEFAULT; - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = format.print(sw); - final CSVParser parser = CSVParser.parse(code, format)) { - assertInitialState(printer); - printer.printRecords(parser.getRecords()); - } - try (final CSVParser parser = CSVParser.parse(sw.toString(), format)) { - final List records = parser.getRecords(); - assertFalse(records.isEmpty()); - Utils.compare("Fail", res, records); - } - } - - @Test - public void testPrintCustomNullValues() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withNullString("NULL"))) { - assertInitialState(printer); - printer.printRecord("a", null, "b"); - assertEquals("a,NULL,b" + recordSeparator, sw.toString()); - } - } - - @Test - public void testPrinter1() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT)) { - assertInitialState(printer); - printer.printRecord("a", "b"); - assertEquals(1, printer.getRecordCount()); - assertEquals("a,b" + recordSeparator, sw.toString()); - } - } - - @Test - public void testPrinter2() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT)) { - assertInitialState(printer); - printer.printRecord("a,b", "b"); - assertEquals("\"a,b\",b" + recordSeparator, sw.toString()); - } - } - - @Test - public void testPrinter3() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT)) { - assertInitialState(printer); - printer.printRecord("a, b", "b "); - assertEquals("\"a, b\",\"b \"" + recordSeparator, sw.toString()); - } - } - - @Test - public void testPrinter4() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT)) { - assertInitialState(printer); - printer.printRecord("a", "b\"c"); - assertEquals("a,\"b\"\"c\"" + recordSeparator, sw.toString()); - } - } - - @Test - public void testPrinter5() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT)) { - assertInitialState(printer); - printer.printRecord("a", "b\nc"); - assertEquals("a,\"b\nc\"" + recordSeparator, sw.toString()); - } - } - - @Test - public void testPrinter6() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT)) { - assertInitialState(printer); - printer.printRecord("a", "b\r\nc"); - assertEquals("a,\"b\r\nc\"" + recordSeparator, sw.toString()); - } - } - - @Test - public void testPrinter7() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT)) { - assertInitialState(printer); - printer.printRecord("a", "b\\c"); - assertEquals("a,b\\c" + recordSeparator, sw.toString()); - } - } - - @Test - public void testPrintNullValues() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT)) { - assertInitialState(printer); - printer.printRecord("a", null, "b"); - assertEquals("a,,b" + recordSeparator, sw.toString()); - } - } - - @Test - public void testPrintOnePositiveInteger() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuoteMode(QuoteMode.MINIMAL))) { - assertInitialState(printer); - printer.print(Integer.MAX_VALUE); - assertEquals(String.valueOf(Integer.MAX_VALUE), sw.toString()); - } - } - - /** - * Test to target the use of {@link IOUtils#copy(java.io.Reader, Appendable)} which directly buffers the value from the Reader to the Appendable. - * - *

- * Requires the format to have no quote or escape character, value to be a {@link Reader Reader} and the output MUST NOT be a {@link Writer Writer} - * but some other Appendable. - *

- * - * @throws IOException Not expected to happen - */ - @Test - public void testPrintReaderWithoutQuoteToAppendable() throws IOException { - final StringBuilder sb = new StringBuilder(); - final String content = "testValue"; - try (final CSVPrinter printer = new CSVPrinter(sb, CSVFormat.DEFAULT.withQuote(null))) { - assertInitialState(printer); - final StringReader value = new StringReader(content); - printer.print(value); - } - assertEquals(content, sb.toString()); - } - - /** - * Test to target the use of {@link IOUtils#copyLarge(java.io.Reader, Writer)} which directly buffers the value from the Reader to the Writer. - * - *

- * Requires the format to have no quote or escape character, value to be a {@link Reader Reader} and the output MUST be a {@link Writer Writer}. - *

- * - * @throws IOException Not expected to happen - */ - @Test - public void testPrintReaderWithoutQuoteToWriter() throws IOException { - final StringWriter sw = new StringWriter(); - final String content = "testValue"; - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null))) { - final StringReader value = new StringReader(content); - printer.print(value); - } - assertEquals(content, sw.toString()); - } - - @Test - public void testPrintRecordStream() throws IOException { - // @formatter:off - final String code = "a1,b1\n" + // 1) - "a2,b2\n" + // 2) - "a3,b3\n" + // 3) - "a4,b4\n"; // 4) - // @formatter:on - final String[][] res = { { "a1", "b1" }, { "a2", "b2" }, { "a3", "b3" }, { "a4", "b4" } }; - final CSVFormat format = CSVFormat.DEFAULT; - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = format.print(sw); - final CSVParser parser = CSVParser.parse(code, format)) { - long count = 0; - for (final CSVRecord record : parser) { - printer.printRecord(record.stream()); - assertEquals(++count, printer.getRecordCount()); - } - } - try (final CSVParser parser = CSVParser.parse(sw.toString(), format)) { - final List records = parser.getRecords(); - assertFalse(records.isEmpty()); - Utils.compare("Fail", res, records); - } - } - - @Test - public void testPrintRecordsWithCSVRecord() throws IOException { - final String[] values = { "A", "B", "C" }; - final String rowData = StringUtils.join(values, ','); - final CharArrayWriter charArrayWriter = new CharArrayWriter(0); - try (final CSVParser parser = CSVFormat.DEFAULT.parse(new StringReader(rowData)); - final CSVPrinter printer = CSVFormat.INFORMIX_UNLOAD.print(charArrayWriter)) { - long count = 0; - for (final CSVRecord record : parser) { - printer.printRecord(record); - assertEquals(++count, printer.getRecordCount()); - } - } - assertEquals(6, charArrayWriter.size()); - assertEquals("A|B|C" + CSVFormat.INFORMIX_UNLOAD.getRecordSeparator(), charArrayWriter.toString()); - } - - @Test - public void testPrintRecordsWithEmptyVector() throws IOException { - final PrintStream out = System.out; - try { - System.setOut(new PrintStream(NullOutputStream.INSTANCE)); - try (CSVPrinter printer = CSVFormat.POSTGRESQL_TEXT.printer()) { - final Vector vector = new Vector<>(); - final int expectedCapacity = 23; - vector.setSize(expectedCapacity); - printer.printRecords(vector); - assertEquals(expectedCapacity, vector.capacity()); - assertEquals(expectedCapacity, printer.getRecordCount()); - } - } finally { - System.setOut(out); - } - } - - @Test - public void testPrintRecordsWithObjectArray() throws IOException { - final CharArrayWriter charArrayWriter = new CharArrayWriter(0); - final Object[] objectArray = new Object[6]; - try (CSVPrinter printer = CSVFormat.INFORMIX_UNLOAD.print(charArrayWriter)) { - final HashSet hashSet = new HashSet<>(); - objectArray[3] = hashSet; - printer.printRecords(objectArray); - assertEquals(objectArray.length, printer.getRecordCount()); - } - assertEquals(6, charArrayWriter.size()); - assertEquals("\n\n\n\n\n\n", charArrayWriter.toString()); - } - - @Test - public void testPrintRecordsWithResultSetOneRow() throws IOException, SQLException { - try (CSVPrinter printer = CSVFormat.MYSQL.printer()) { - try (ResultSet resultSet = new SimpleResultSet()) { - assertInitialState(printer); - printer.printRecords(resultSet); - assertInitialState(printer); - assertEquals(0, resultSet.getRow()); - } - } - } - - @Test - public void testPrintToFileWithCharsetUtf16Be() throws IOException { - final File file = createTempFile(); - try (final CSVPrinter printer = CSVFormat.DEFAULT.print(file, StandardCharsets.UTF_16BE)) { - printer.printRecord("a", "b\\c"); - } - assertEquals("a,b\\c" + recordSeparator, FileUtils.readFileToString(file, StandardCharsets.UTF_16BE)); - } - - @Test - public void testPrintToFileWithDefaultCharset() throws IOException { - final File file = createTempFile(); - try (final CSVPrinter printer = CSVFormat.DEFAULT.print(file, Charset.defaultCharset())) { - printer.printRecord("a", "b\\c"); - } - assertEquals("a,b\\c" + recordSeparator, FileUtils.readFileToString(file, Charset.defaultCharset())); - } - - @Test - public void testPrintToPathWithDefaultCharset() throws IOException { - final Path file = createTempPath(); - try (final CSVPrinter printer = CSVFormat.DEFAULT.print(file, Charset.defaultCharset())) { - printer.printRecord("a", "b\\c"); - } - assertEquals("a,b\\c" + recordSeparator, new String(Files.readAllBytes(file), Charset.defaultCharset())); - } - - @Test - public void testQuoteAll() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuoteMode(QuoteMode.ALL))) { - printer.printRecord("a", "b\nc", "d"); - assertEquals("\"a\",\"b\nc\",\"d\"" + recordSeparator, sw.toString()); - } - } - - @Test - public void testQuoteCommaFirstChar() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.RFC4180)) { - printer.printRecord(","); - assertEquals("\",\"" + recordSeparator, sw.toString()); - } - } - - @Test - public void testQuoteNonNumeric() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuoteMode(QuoteMode.NON_NUMERIC))) { - printer.printRecord("a", "b\nc", Integer.valueOf(1)); - assertEquals("\"a\",\"b\nc\",1" + recordSeparator, sw.toString()); - } - } - - @Test - public void testRandomDefault() throws Exception { - doRandom(CSVFormat.DEFAULT, ITERATIONS_FOR_RANDOM_TEST); - } - - @Test - public void testRandomExcel() throws Exception { - doRandom(CSVFormat.EXCEL, ITERATIONS_FOR_RANDOM_TEST); - } - - @Test - @Disabled - public void testRandomMongoDbCsv() throws Exception { - doRandom(CSVFormat.MONGODB_CSV, ITERATIONS_FOR_RANDOM_TEST); - } - - @Test - public void testRandomMySql() throws Exception { - doRandom(CSVFormat.MYSQL, ITERATIONS_FOR_RANDOM_TEST); - } - - @Test - @Disabled - public void testRandomOracle() throws Exception { - doRandom(CSVFormat.ORACLE, ITERATIONS_FOR_RANDOM_TEST); - } - - @Test - @Disabled - public void testRandomPostgreSqlCsv() throws Exception { - doRandom(CSVFormat.POSTGRESQL_CSV, ITERATIONS_FOR_RANDOM_TEST); - } - - @Test - public void testRandomPostgreSqlText() throws Exception { - doRandom(CSVFormat.POSTGRESQL_TEXT, ITERATIONS_FOR_RANDOM_TEST); - } - - @Test - public void testRandomRfc4180() throws Exception { - doRandom(CSVFormat.RFC4180, ITERATIONS_FOR_RANDOM_TEST); - } - - @Test - public void testRandomTdf() throws Exception { - doRandom(CSVFormat.TDF, ITERATIONS_FOR_RANDOM_TEST); - } - - @Test - public void testSingleLineComment() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withCommentMarker('#'))) { - printer.printComment("This is a comment"); - assertEquals("# This is a comment" + recordSeparator, sw.toString()); - assertEquals(0, printer.getRecordCount()); - } - } - - @Test - public void testSingleQuoteQuoted() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote('\''))) { - printer.print("a'b'c"); - printer.print("xyz"); - assertEquals("'a''b''c',xyz", sw.toString()); - } - } - - @Test - public void testSkipHeaderRecordFalse() throws IOException { - // functionally identical to testHeader, used to test CSV-153 - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null).withHeader("C1", "C2", "C3").withSkipHeaderRecord(false))) { - printer.printRecord("a", "b", "c"); - printer.printRecord("x", "y", "z"); - assertEquals("C1,C2,C3\r\na,b,c\r\nx,y,z\r\n", sw.toString()); - } - } - - @Test - public void testSkipHeaderRecordTrue() throws IOException { - // functionally identical to testHeaderNotSet, used to test CSV-153 - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null).withHeader("C1", "C2", "C3").withSkipHeaderRecord(true))) { - printer.printRecord("a", "b", "c"); - printer.printRecord("x", "y", "z"); - assertEquals("a,b,c\r\nx,y,z\r\n", sw.toString()); - } - } - - @Test - public void testTrailingDelimiterOnTwoColumns() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withTrailingDelimiter())) { - printer.printRecord("A", "B"); - assertEquals("A,B,\r\n", sw.toString()); - } - } - - @Test - public void testTrimOffOneColumn() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withTrim(false))) { - printer.print(" A "); - assertEquals("\" A \"", sw.toString()); - } - } - - @Test - public void testTrimOnOneColumn() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withTrim())) { - printer.print(" A "); - assertEquals("A", sw.toString()); - } - } - - @Test - public void testTrimOnTwoColumns() throws IOException { - final StringWriter sw = new StringWriter(); - try (final CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withTrim())) { - printer.print(" A "); - printer.print(" B "); - assertEquals("A,B", sw.toString()); - } - } - - private String[] toFirstRecordValues(final String expected, final CSVFormat format) throws IOException { - try (final CSVParser parser = CSVParser.parse(expected, format)) { - return parser.getRecords().get(0).values(); - } - } - - private void tryFormat(final List list, final Character quote, final Character escape, final String expected) throws IOException { - final CSVFormat format = CSVFormat.DEFAULT.withQuote(quote).withEscape(escape).withRecordSeparator(null); - final Appendable out = new StringBuilder(); - try (final CSVPrinter printer = new CSVPrinter(out, format)) { - printer.printRecord(list); - } - assertEquals(expected, out.toString()); - } - -} +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.commons.csv; + +import static org.apache.commons.csv.Constants.BACKSLASH; +import static org.apache.commons.csv.Constants.CR; +import static org.junit.jupiter.api.Assertions.assertArrayEquals; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotEquals; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.times; +import static org.mockito.Mockito.verify; + +import java.io.CharArrayWriter; +import java.io.File; +import java.io.FileReader; +import java.io.IOException; +import java.io.PrintStream; +import java.io.Reader; +import java.io.StringReader; +import java.io.StringWriter; +import java.io.Writer; +import java.nio.charset.Charset; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.sql.BatchUpdateException; +import java.sql.Connection; +import java.sql.DriverManager; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.sql.Statement; +import java.util.Arrays; +import java.util.Date; +import java.util.HashSet; +import java.util.Iterator; +import java.util.LinkedList; +import java.util.List; +import java.util.Objects; +import java.util.Random; +import java.util.Vector; +import java.util.stream.Stream; + +import org.apache.commons.io.FileUtils; +import org.apache.commons.io.IOUtils; +import org.apache.commons.io.output.NullOutputStream; +import org.apache.commons.lang3.StringUtils; +import org.h2.tools.SimpleResultSet; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.ValueSource; + +/** + * Tests {@link CSVPrinter}. + */ +class CSVPrinterTest { + + private static final int TABLE_RECORD_COUNT = 2; + private static final int TABLE_AND_HEADER_RECORD_COUNT = TABLE_RECORD_COUNT + 1; + private static final char DQUOTE_CHAR = '"'; + private static final char EURO_CH = '\u20AC'; + private static final int ITERATIONS_FOR_RANDOM_TEST = 50_000; + private static final char QUOTE_CH = '\''; + private static final String RECORD_SEPARATOR = CSVFormat.DEFAULT.getRecordSeparator(); + + private static String printable(final String s) { + final StringBuilder sb = new StringBuilder(); + for (int i = 0; i < s.length(); i++) { + final char ch = s.charAt(i); + if (ch <= ' ' || ch >= 128) { + sb.append("(").append((int) ch).append(")"); + } else { + sb.append(ch); + } + } + return sb.toString(); + } + + private String longText2; + + private void assertInitialState(final CSVPrinter printer) { + assertEquals(0, printer.getRecordCount()); + } + + private void assertRowCount(final CSVFormat format, final String resultString, final int rowCount) throws IOException { + try (CSVParser parser = format.parse(new StringReader(resultString))) { + assertEquals(rowCount, parser.getRecords().size()); + } + } + + private File createTempFile() throws IOException { + return createTempPath().toFile(); + } + + private Path createTempPath() throws IOException { + return Files.createTempFile(getClass().getName(), ".csv"); + } + + private void doOneRandom(final CSVFormat format) throws Exception { + final Random r = new Random(); + + final int nLines = r.nextInt(4) + 1; + final int nCol = r.nextInt(3) + 1; + // nLines=1;nCol=2; + final String[][] lines = generateLines(nLines, nCol); + + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, format)) { + + for (int i = 0; i < nLines; i++) { + // for (int j=0; j parseResult = parser.getRecords(); + + final String[][] expected = lines.clone(); + for (int i = 0; i < expected.length; i++) { + expected[i] = expectNulls(expected[i], format); + } + Utils.compare("Printer output :" + printable(result), expected, parseResult, -1); + } + } + + private void doRandom(final CSVFormat format, final int iter) throws Exception { + for (int i = 0; i < iter; i++) { + doOneRandom(format); + } + } + + /** + * Converts an input CSV array into expected output values, including NULLs. NULL strings are converted to null values because the parser will convert + * these strings to null. + */ + private T[] expectNulls(final T[] original, final CSVFormat csvFormat) { + final T[] fixed = original.clone(); + for (int i = 0; i < fixed.length; i++) { + if (Objects.equals(csvFormat.getNullString(), fixed[i])) { + fixed[i] = null; + } + } + return fixed; + } + + private String[][] generateLines(final int nLines, final int nCol) { + final String[][] lines = new String[nLines][]; + for (int i = 0; i < nLines; i++) { + final String[] line = new String[nCol]; + lines[i] = line; + for (int j = 0; j < nCol; j++) { + line[j] = randStr(); + } + } + return lines; + } + + private Connection getH2Connection() throws SQLException, ClassNotFoundException { + Class.forName("org.h2.Driver"); + return DriverManager.getConnection("jdbc:h2:mem:my_test;", "sa", ""); + } + + private CSVPrinter printWithHeaderComments(final StringWriter sw, final Date now, final CSVFormat baseFormat) throws IOException { + // Use withHeaderComments first to test CSV-145 + // @formatter:off + final CSVFormat format = baseFormat.builder() + .setHeaderComments((String[]) null) // don't blow up + .setHeaderComments((Object[]) null) // don't blow up + .setHeaderComments("Generated by Apache Commons CSV 1.1", now) + .setCommentMarker('#') + .setHeader("Col1", "Col2") + .get(); + // @formatter:on + final CSVPrinter printer = format.print(sw); + printer.printRecord("A", "B"); + printer.printRecord("C", "D"); + printer.close(); + return printer; + } + + private String randStr() { + final Random r = new Random(); + final int sz = r.nextInt(20); + // sz = r.nextInt(3); + final char[] buf = new char[sz]; + for (int i = 0; i < sz; i++) { + // stick in special chars with greater frequency + final char ch; + final int what = r.nextInt(20); + switch (what) { + case 0: + ch = '\r'; + break; + case 1: + ch = '\n'; + break; + case 2: + ch = '\t'; + break; + case 3: + ch = '\f'; + break; + case 4: + ch = ' '; + break; + case 5: + ch = ','; + break; + case 6: + ch = DQUOTE_CHAR; + break; + case 7: + ch = '\''; + break; + case 8: + ch = BACKSLASH; + break; + default: + ch = (char) r.nextInt(300); + break; + // default: ch = 'a'; break; + } + buf[i] = ch; + } + return new String(buf); + } + + private void setUpTable(final Connection connection) throws SQLException { + try (Statement statement = connection.createStatement()) { + statement.execute("CREATE TABLE TEST(ID INT PRIMARY KEY, NAME VARCHAR(255), TEXT CLOB, BIN_DATA BLOB)"); + statement.execute("insert into TEST values(1, 'r1', 'long text 1', 'binary data 1')"); + longText2 = StringUtils.repeat('a', IOUtils.DEFAULT_BUFFER_SIZE - 4); + longText2 += "\"\r\n\"b\""; + longText2 += StringUtils.repeat('c', IOUtils.DEFAULT_BUFFER_SIZE - 1); + statement.execute("insert into TEST values(2, 'r2', '" + longText2 + "', 'binary data 2')"); + longText2 = longText2.replace("\"", "\"\""); + } + } + + @Test + void testCloseBackwardCompatibility() throws IOException { + try (Writer writer = mock(Writer.class)) { + final CSVFormat csvFormat = CSVFormat.DEFAULT; + try (CSVPrinter printer = new CSVPrinter(writer, csvFormat)) { + assertInitialState(printer); + } + verify(writer, never()).flush(); + verify(writer, times(1)).close(); + } + } + + @Test + void testCloseWithCsvFormatAutoFlushOff() throws IOException { + try (Writer writer = mock(Writer.class)) { + final CSVFormat csvFormat = CSVFormat.DEFAULT.withAutoFlush(false); + try (CSVPrinter printer = new CSVPrinter(writer, csvFormat)) { + assertInitialState(printer); + } + verify(writer, never()).flush(); + verify(writer, times(1)).close(); + } + } + + @Test + void testCloseWithCsvFormatAutoFlushOn() throws IOException { + // System.out.println("start method"); + try (Writer writer = mock(Writer.class)) { + final CSVFormat csvFormat = CSVFormat.DEFAULT.withAutoFlush(true); + try (CSVPrinter printer = new CSVPrinter(writer, csvFormat)) { + assertInitialState(printer); + } + verify(writer, times(1)).flush(); + verify(writer, times(1)).close(); + } + } + + @Test + void testCloseWithFlushOff() throws IOException { + try (Writer writer = mock(Writer.class)) { + final CSVFormat csvFormat = CSVFormat.DEFAULT; + @SuppressWarnings("resource") + final CSVPrinter printer = new CSVPrinter(writer, csvFormat); + assertInitialState(printer); + printer.close(false); + assertEquals(0, printer.getRecordCount()); + verify(writer, never()).flush(); + verify(writer, times(1)).close(); + } + } + + @Test + void testCloseWithFlushOn() throws IOException { + try (Writer writer = mock(Writer.class)) { + @SuppressWarnings("resource") + final CSVPrinter printer = new CSVPrinter(writer, CSVFormat.DEFAULT); + assertInitialState(printer); + printer.close(true); + assertEquals(0, printer.getRecordCount()); + verify(writer, times(1)).flush(); + } + } + + @Test + void testCRComment() throws IOException { + final StringWriter sw = new StringWriter(); + final Object value = "abc"; + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withCommentMarker('#'))) { + assertInitialState(printer); + printer.print(value); + assertEquals(0, printer.getRecordCount()); + printer.printComment("This is a comment\r\non multiple lines\rthis is next comment\r"); + assertEquals("abc" + RECORD_SEPARATOR + "# This is a comment" + RECORD_SEPARATOR + "# on multiple lines" + RECORD_SEPARATOR + + "# this is next comment" + RECORD_SEPARATOR + "# " + RECORD_SEPARATOR, sw.toString()); + assertEquals(0, printer.getRecordCount()); + } + } + + @Test + void testCSV135() throws IOException { + final List list = new LinkedList<>(); + list.add("\"\""); // "" + list.add("\\\\"); // \\ + list.add("\\\"\\"); // \"\ + // + // "",\\,\"\ (unchanged) + tryFormat(list, null, null, "\"\",\\\\,\\\"\\"); + // + // """""",\\,"\""\" (quoted, and embedded DQ doubled) + tryFormat(list, '"', null, "\"\"\"\"\"\",\\\\,\"\\\"\"\\\""); + // + // "",\\\\,\\"\\ (escapes escaped, not quoted) + tryFormat(list, null, '\\', "\"\",\\\\\\\\,\\\\\"\\\\"); + // + // "\"\"","\\\\","\\\"\\" (quoted, and embedded DQ & escape escaped) + tryFormat(list, '"', '\\', "\"\\\"\\\"\",\"\\\\\\\\\",\"\\\\\\\"\\\\\""); + // + // """""",\\,"\""\" (quoted, embedded DQ escaped) + tryFormat(list, '"', '"', "\"\"\"\"\"\",\\\\,\"\\\"\"\\\""); + } + + @Test + void testCSV259() throws IOException { + final StringWriter sw = new StringWriter(); + try (Reader reader = new FileReader("src/test/resources/org/apache/commons/csv/CSV-259/sample.txt"); + CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withEscape('!').withQuote(null))) { + assertInitialState(printer); + printer.print(reader); + assertEquals("x!,y!,z", sw.toString()); + } + } + + @Test + void testDelimeterQuoted() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote('\''))) { + assertInitialState(printer); + printer.print("a,b,c"); + printer.print("xyz"); + assertEquals("'a,b,c',xyz", sw.toString()); + } + } + + @Test + void testDelimeterQuoteNone() throws IOException { + final StringWriter sw = new StringWriter(); + final CSVFormat format = CSVFormat.DEFAULT.withEscape('!').withQuoteMode(QuoteMode.NONE); + try (CSVPrinter printer = new CSVPrinter(sw, format)) { + assertInitialState(printer); + printer.print("a,b,c"); + printer.print("xyz"); + assertEquals("a!,b!,c,xyz", sw.toString()); + } + } + + @Test + void testDelimeterStringQuoted() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.builder().setDelimiter("[|]").setQuote('\'').get())) { + assertInitialState(printer); + printer.print("a[|]b[|]c"); + printer.print("xyz"); + assertEquals("'a[|]b[|]c'[|]xyz", sw.toString()); + } + } + + @Test + void testDelimeterStringQuoteNone() throws IOException { + final StringWriter sw = new StringWriter(); + final CSVFormat format = CSVFormat.DEFAULT.builder().setDelimiter("[|]").setEscape('!').setQuoteMode(QuoteMode.NONE).get(); + try (CSVPrinter printer = new CSVPrinter(sw, format)) { + assertInitialState(printer); + printer.print("a[|]b[|]c"); + printer.print("xyz"); + printer.print("a[xy]bc[]"); + assertEquals("a![!|!]b![!|!]c[|]xyz[|]a[xy]bc[]", sw.toString()); + } + } + + @Test + void testDelimiterEscaped() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withEscape('!').withQuote(null))) { + assertInitialState(printer); + printer.print("a,b,c"); + printer.print("xyz"); + assertEquals("a!,b!,c,xyz", sw.toString()); + } + } + + @Test + void testDelimiterPlain() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null))) { + assertInitialState(printer); + printer.print("a,b,c"); + printer.print("xyz"); + assertEquals("a,b,c,xyz", sw.toString()); + } + } + + @Test + void testDelimiterStringEscaped() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.builder().setDelimiter("|||").setEscape('!').setQuote(null).get())) { + assertInitialState(printer); + printer.print("a|||b|||c"); + printer.print("xyz"); + assertEquals("a!|!|!|b!|!|!|c|||xyz", sw.toString()); + } + } + + @Test + void testDisabledComment() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT)) { + assertInitialState(printer); + printer.printComment("This is a comment"); + assertEquals("", sw.toString()); + assertEquals(0, printer.getRecordCount()); + } + } + + @Test + void testDontQuoteEuroFirstChar() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.RFC4180)) { + assertInitialState(printer); + printer.printRecord(EURO_CH, "Deux"); + assertEquals(EURO_CH + ",Deux" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testEolEscaped() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null).withEscape('!'))) { + assertInitialState(printer); + printer.print("a\rb\nc"); + printer.print("x\fy\bz"); + assertEquals("a!rb!nc,x\fy\bz", sw.toString()); + } + } + + @Test + void testEolPlain() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null))) { + assertInitialState(printer); + printer.print("a\rb\nc"); + printer.print("x\fy\bz"); + assertEquals("a\rb\nc,x\fy\bz", sw.toString()); + } + } + + @Test + void testEolQuoted() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote('\''))) { + assertInitialState(printer); + printer.print("a\rb\nc"); + printer.print("x\by\fz"); + assertEquals("'a\rb\nc',x\by\fz", sw.toString()); + } + } + + @SuppressWarnings("unlikely-arg-type") + @Test + void testEquals() throws IOException { + // Don't use assertNotEquals here + assertFalse(CSVFormat.DEFAULT.equals(null)); + // Don't use assertNotEquals here + assertFalse(CSVFormat.DEFAULT.equals("")); + } + + @Test + void testEscapeBackslash1() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(QUOTE_CH))) { + assertInitialState(printer); + printer.print("\\"); + } + assertEquals("\\", sw.toString()); + } + + @Test + void testEscapeBackslash2() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(QUOTE_CH))) { + assertInitialState(printer); + printer.print("\\\r"); + } + assertEquals("'\\\r'", sw.toString()); + } + + @Test + void testEscapeBackslash3() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(QUOTE_CH))) { + assertInitialState(printer); + printer.print("X\\\r"); + } + assertEquals("'X\\\r'", sw.toString()); + } + + @Test + void testEscapeBackslash4() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(QUOTE_CH))) { + assertInitialState(printer); + printer.print("\\\\"); + } + assertEquals("\\\\", sw.toString()); + } + + @Test + void testEscapeBackslash5() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(QUOTE_CH))) { + assertInitialState(printer); + printer.print("\\\\"); + } + assertEquals("\\\\", sw.toString()); + } + + @Test + void testEscapeCommentMarkerFirstChar() throws IOException { + // No quoting available in escape mode, so a leading comment marker must be escaped or the + // record reads back as a comment and is dropped. Mirrors the quoting fix for QuoteMode.MINIMAL. + final CSVFormat format = CSVFormat.DEFAULT.builder().setQuote(null).setEscape('\\').setCommentMarker(';').get(); + final StringWriter sw = new StringWriter(); + final String col1 = ";comment-like"; + try (CSVPrinter printer = new CSVPrinter(sw, format)) { + printer.printRecord(col1, "b"); + printer.printRecord(new StringReader(col1), new StringReader("b")); + // The marker past the first character does not start a comment and is left alone. + printer.printRecord("a;b", ";c"); + } + final String string = sw.toString(); + assertEquals("\\;comment-like,b" + RECORD_SEPARATOR + + "\\;comment-like,b" + RECORD_SEPARATOR + + "a;b,\\;c" + RECORD_SEPARATOR, string); + // The emitted records must read back as the original values, none parsed as a comment. + try (CSVParser parser = CSVParser.parse(string, format)) { + final List records = parser.getRecords(); + assertEquals(3, records.size()); + assertEquals(col1, records.get(0).get(0)); + assertEquals("b", records.get(0).get(1)); + assertEquals(col1, records.get(1).get(0)); + assertEquals("b", records.get(1).get(1)); + assertEquals("a;b", records.get(2).get(0)); + assertEquals(";c", records.get(2).get(1)); + } + } + + @Test + void testEscapeCommentMarkerFirstCharWithQuoteModeNone() throws IOException { + final CSVFormat format = CSVFormat.DEFAULT.builder().setEscape('\\').setQuoteMode(QuoteMode.NONE).setCommentMarker(';').get(); + final StringWriter sw = new StringWriter(); + final String col1 = ";bar"; + try (CSVPrinter printer = new CSVPrinter(sw, format)) { + printer.printRecord(col1, "b"); + printer.printRecord(new StringReader(col1), new StringReader("b")); + } + final String string = sw.toString(); + assertEquals("\\;bar,b" + RECORD_SEPARATOR + "\\;bar,b" + RECORD_SEPARATOR, string); + try (CSVParser parser = CSVParser.parse(string, format)) { + final List records = parser.getRecords(); + assertEquals(2, records.size()); + for (final CSVRecord record : records) { + assertEquals(col1, record.get(0)); + assertEquals("b", record.get(1)); + } + } + } + + @Test + void testEscapeNull1() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withEscape(null))) { + assertInitialState(printer); + printer.print("\\"); + } + assertEquals("\\", sw.toString()); + } + + @Test + void testEscapeNull2() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withEscape(null))) { + assertInitialState(printer); + printer.print("\\\r"); + } + assertEquals("\"\\\r\"", sw.toString()); + } + + @Test + void testEscapeNull3() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withEscape(null))) { + assertInitialState(printer); + printer.print("X\\\r"); + } + assertEquals("\"X\\\r\"", sw.toString()); + } + + @Test + void testEscapeNull4() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withEscape(null))) { + assertInitialState(printer); + printer.print("\\\\"); + } + assertEquals("\\\\", sw.toString()); + } + + @Test + void testEscapeNull5() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withEscape(null))) { + assertInitialState(printer); + printer.print("\\\\"); + } + assertEquals("\\\\", sw.toString()); + } + + @Test + void testExcelPrintAllArrayOfArrays() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { + assertInitialState(printer); + printer.printRecords((Object[]) new String[][] { { "r1c1", "r1c2" }, { "r2c1", "r2c2" } }); + assertEquals("r1c1,r1c2" + RECORD_SEPARATOR + "r2c1,r2c2" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testExcelPrintAllArrayOfArraysWithFirstEmptyValue2() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { + assertInitialState(printer); + printer.printRecords((Object[]) new String[][] { { "" } }); + assertEquals("\"\"" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testExcelPrintAllArrayOfArraysWithFirstSpaceValue1() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { + assertInitialState(printer); + printer.printRecords((Object[]) new String[][] { { " ", "r1c2" } }); + assertEquals("\" \",r1c2" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testExcelPrintAllArrayOfArraysWithFirstTabValue1() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { + assertInitialState(printer); + printer.printRecords((Object[]) new String[][] { { "\t", "r1c2" } }); + assertEquals("\"\t\",r1c2" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testExcelPrintAllArrayOfLists() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { + assertInitialState(printer); + printer.printRecords((Object[]) new List[] { Arrays.asList("r1c1", "r1c2"), Arrays.asList("r2c1", "r2c2") }); + assertEquals("r1c1,r1c2" + RECORD_SEPARATOR + "r2c1,r2c2" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testExcelPrintAllArrayOfListsWithFirstEmptyValue2() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { + assertInitialState(printer); + printer.printRecords((Object[]) new List[] { Arrays.asList("") }); + assertEquals("\"\"" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testExcelPrintAllIterableOfArrays() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { + assertInitialState(printer); + printer.printRecords(Arrays.asList(new String[][] { { "r1c1", "r1c2" }, { "r2c1", "r2c2" } })); + assertEquals("r1c1,r1c2" + RECORD_SEPARATOR + "r2c1,r2c2" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testExcelPrintAllIterableOfArraysWithFirstEmptyValue2() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { + assertInitialState(printer); + printer.printRecords(Arrays.asList(new String[][] { { "" } })); + assertEquals("\"\"" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testExcelPrintAllIterableOfLists() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { + assertInitialState(printer); + printer.printRecords(Arrays.asList(Arrays.asList("r1c1", "r1c2"), Arrays.asList("r2c1", "r2c2"))); + assertEquals("r1c1,r1c2" + RECORD_SEPARATOR + "r2c1,r2c2" + RECORD_SEPARATOR, sw.toString()); + } + } + + @ParameterizedTest + @ValueSource(longs = { -1, 0, 1, 2, Long.MAX_VALUE }) + void testExcelPrintAllStreamOfArrays(final long maxRows) throws IOException { + final StringWriter sw = new StringWriter(); + final CSVFormat format = CSVFormat.EXCEL.builder().setMaxRows(maxRows).get(); + try (CSVPrinter printer = new CSVPrinter(sw, format)) { + assertInitialState(printer); + printer.printRecords(Stream.of(new String[][] { { "r1c1", "r1c2" }, { "r2c1", "r2c2" } })); + String expected = "r1c1,r1c2" + RECORD_SEPARATOR; + if (maxRows != 1) { + expected += "r2c1,r2c2" + RECORD_SEPARATOR; + } + assertEquals(expected, sw.toString()); + } + } + + @Test + void testExcelPrinter1() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { + assertInitialState(printer); + printer.printRecord("a", "b"); + assertEquals("a,b" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testExcelPrinter2() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.EXCEL)) { + assertInitialState(printer); + printer.printRecord("a,b", "b"); + assertEquals("\"a,b\",b" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testHeader() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null).withHeader("C1", "C2", "C3"))) { + assertEquals(1, printer.getRecordCount()); + printer.printRecord("a", "b", "c"); + printer.printRecord("x", "y", "z"); + assertEquals("C1,C2,C3\r\na,b,c\r\nx,y,z\r\n", sw.toString()); + } + } + + @Test + void testHeaderCommentExcel() throws IOException { + final StringWriter sw = new StringWriter(); + final Date now = new Date(); + final CSVFormat format = CSVFormat.EXCEL; + try (CSVPrinter csvPrinter = printWithHeaderComments(sw, now, format)) { + assertEquals("# Generated by Apache Commons CSV 1.1\r\n# " + now + "\r\nCol1,Col2\r\nA,B\r\nC,D\r\n", sw.toString()); + } + } + + @Test + void testHeaderCommentTdf() throws IOException { + final StringWriter sw = new StringWriter(); + final Date now = new Date(); + final CSVFormat format = CSVFormat.TDF; + try (CSVPrinter csvPrinter = printWithHeaderComments(sw, now, format)) { + assertEquals("# Generated by Apache Commons CSV 1.1\r\n# " + now + "\r\nCol1\tCol2\r\nA\tB\r\nC\tD\r\n", sw.toString()); + } + } + + @Test + void testHeaderNotSet() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null))) { + assertInitialState(printer); + printer.printRecord("a", "b", "c"); + printer.printRecord("x", "y", "z"); + assertEquals("a,b,c\r\nx,y,z\r\n", sw.toString()); + } + } + + @Test + void testInvalidFormat() { + assertThrows(IllegalArgumentException.class, () -> CSVFormat.DEFAULT.withDelimiter(CR)); + } + + @Test + void testJdbcPrinter() throws IOException, ClassNotFoundException, SQLException { + final StringWriter sw = new StringWriter(); + final CSVFormat csvFormat = CSVFormat.DEFAULT; + try (Connection connection = getH2Connection()) { + setUpTable(connection); + try (Statement stmt = connection.createStatement(); + CSVPrinter printer = new CSVPrinter(sw, csvFormat); + ResultSet resultSet = stmt.executeQuery("select ID, NAME, TEXT, BIN_DATA from TEST")) { + assertInitialState(printer); + printer.printRecords(resultSet); + assertEquals(TABLE_RECORD_COUNT, printer.getRecordCount()); + } + } + final String csv = sw.toString(); + assertEquals("1,r1,\"long text 1\",\"YmluYXJ5IGRhdGEgMQ==\"" + RECORD_SEPARATOR + "2,r2,\"" + longText2 + "\",\"YmluYXJ5IGRhdGEgMg==\"" + + RECORD_SEPARATOR, csv); + // Round trip the data + try (StringReader reader = new StringReader(csv); + CSVParser csvParser = csvFormat.parse(reader)) { + // Row 1 + CSVRecord record = csvParser.nextRecord(); + assertEquals("1", record.get(0)); + assertEquals("r1", record.get(1)); + assertEquals("long text 1", record.get(2)); + assertEquals("YmluYXJ5IGRhdGEgMQ==", record.get(3)); + // Row 2 + record = csvParser.nextRecord(); + assertEquals("2", record.get(0)); + assertEquals("r2", record.get(1)); + assertEquals("YmluYXJ5IGRhdGEgMg==", record.get(3)); + } + } + + @Test + void testJdbcPrinterWithFirstEmptyValue2() throws IOException, ClassNotFoundException, SQLException { + final StringWriter sw = new StringWriter(); + try (Connection connection = getH2Connection()) { + try (Statement stmt = connection.createStatement(); + ResultSet resultSet = stmt.executeQuery("select '' AS EMPTYVALUE from DUAL"); + CSVPrinter printer = CSVFormat.DEFAULT.withHeader(resultSet).print(sw)) { + printer.printRecords(resultSet); + } + } + assertEquals("EMPTYVALUE" + RECORD_SEPARATOR + "\"\"" + RECORD_SEPARATOR, sw.toString()); + } + + @ParameterizedTest + @ValueSource(longs = { -1, 0, 1, 2, 3, 4, Long.MAX_VALUE }) + void testJdbcPrinterWithResultSet(final long maxRows) throws IOException, ClassNotFoundException, SQLException { + final StringWriter sw = new StringWriter(); + final CSVFormat format = CSVFormat.DEFAULT.builder().setMaxRows(maxRows).get(); + try (Connection connection = getH2Connection()) { + setUpTable(connection); + try (Statement stmt = connection.createStatement(); + ResultSet resultSet = stmt.executeQuery("select ID, NAME, TEXT from TEST"); + CSVPrinter printer = format.withHeader(resultSet).print(sw)) { + printer.printRecords(resultSet); + } + } + final String resultString = sw.toString(); + final String header = "ID,NAME,TEXT"; + final String headerRow1 = header + RECORD_SEPARATOR + "1,r1,\"long text 1\"" + RECORD_SEPARATOR; + final String allRows = headerRow1 + "2,r2,\"" + longText2 + "\"" + RECORD_SEPARATOR; + final int expectedRowsWithHeader; + if (maxRows == 1) { + assertEquals(headerRow1, resultString); + expectedRowsWithHeader = 2; + } else { + assertEquals(allRows, resultString); + expectedRowsWithHeader = TABLE_AND_HEADER_RECORD_COUNT; + } + assertRowCount(CSVFormat.DEFAULT, resultString, expectedRowsWithHeader); + } + + @ParameterizedTest + @ValueSource(longs = { -1, 0, 3, 4, Long.MAX_VALUE }) + void testJdbcPrinterWithResultSetHeader(final long maxRows) throws IOException, ClassNotFoundException, SQLException { + final StringWriter sw = new StringWriter(); + try (Connection connection = getH2Connection()) { + setUpTable(connection); + final CSVFormat format = CSVFormat.DEFAULT.builder().setMaxRows(maxRows).get(); + try (Statement stmt = connection.createStatement(); + CSVPrinter printer = new CSVPrinter(sw, format)) { + try (ResultSet resultSet = stmt.executeQuery("select ID, NAME from TEST")) { + printer.printRecords(resultSet, true); + assertEquals(TABLE_RECORD_COUNT, printer.getRecordCount()); + assertEquals("ID,NAME" + RECORD_SEPARATOR + "1,r1" + RECORD_SEPARATOR + "2,r2" + RECORD_SEPARATOR, sw.toString()); + } + assertRowCount(format, sw.toString(), TABLE_AND_HEADER_RECORD_COUNT); + try (ResultSet resultSet = stmt.executeQuery("select ID, NAME from TEST")) { + printer.printRecords(resultSet, false); + assertEquals(TABLE_RECORD_COUNT * 2, printer.getRecordCount()); + assertNotEquals("ID,NAME" + RECORD_SEPARATOR + "1,r1" + RECORD_SEPARATOR + "2,r2" + RECORD_SEPARATOR, sw.toString()); + } + assertRowCount(CSVFormat.DEFAULT, sw.toString(), TABLE_AND_HEADER_RECORD_COUNT + TABLE_RECORD_COUNT); + } + } + } + + @ParameterizedTest + @ValueSource(longs = { -1, 0, 3, 4, Long.MAX_VALUE }) + void testJdbcPrinterWithResultSetMetaData(final long maxRows) throws IOException, ClassNotFoundException, SQLException { + final StringWriter sw = new StringWriter(); + try (Connection connection = getH2Connection()) { + setUpTable(connection); + final CSVFormat format = CSVFormat.DEFAULT.builder().setMaxRows(maxRows).get(); + try (Statement stmt = connection.createStatement(); + ResultSet resultSet = stmt.executeQuery("select ID, NAME, TEXT from TEST"); + CSVPrinter printer = format.withHeader(resultSet.getMetaData()).print(sw)) { + // The header is the first record. + assertEquals(1, printer.getRecordCount()); + printer.printRecords(resultSet); + assertEquals(3, printer.getRecordCount()); + assertEquals("ID,NAME,TEXT" + RECORD_SEPARATOR + "1,r1,\"long text 1\"" + RECORD_SEPARATOR + "2,r2,\"" + longText2 + "\"" + RECORD_SEPARATOR, + sw.toString()); + } + assertRowCount(format, sw.toString(), TABLE_AND_HEADER_RECORD_COUNT); + } + } + + @Test + void testJira135_part1() throws IOException { + final CSVFormat format = CSVFormat.DEFAULT.withRecordSeparator('\n').withQuote(DQUOTE_CHAR).withEscape(BACKSLASH); + final StringWriter sw = new StringWriter(); + final List list = new LinkedList<>(); + try (CSVPrinter printer = new CSVPrinter(sw, format)) { + list.add("\""); + printer.printRecord(list); + } + final String expected = "\"\\\"\"" + format.getRecordSeparator(); + assertEquals(expected, sw.toString()); + final String[] record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(list.toArray(), format), record0); + } + + @Test + @Disabled + void testJira135_part2() throws IOException { + final CSVFormat format = CSVFormat.DEFAULT.withRecordSeparator('\n').withQuote(DQUOTE_CHAR).withEscape(BACKSLASH); + final StringWriter sw = new StringWriter(); + final List list = new LinkedList<>(); + try (CSVPrinter printer = new CSVPrinter(sw, format)) { + list.add("\n"); + printer.printRecord(list); + } + final String expected = "\"\\n\"" + format.getRecordSeparator(); + assertEquals(expected, sw.toString()); + final String[] record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(list.toArray(), format), record0); + } + + @Test + void testJira135_part3() throws IOException { + final CSVFormat format = CSVFormat.DEFAULT.withRecordSeparator('\n').withQuote(DQUOTE_CHAR).withEscape(BACKSLASH); + final StringWriter sw = new StringWriter(); + final List list = new LinkedList<>(); + try (CSVPrinter printer = new CSVPrinter(sw, format)) { + list.add("\\"); + printer.printRecord(list); + } + final String expected = "\"\\\\\"" + format.getRecordSeparator(); + assertEquals(expected, sw.toString()); + final String[] record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(list.toArray(), format), record0); + } + + @Test + @Disabled + void testJira135All() throws IOException { + final CSVFormat format = CSVFormat.DEFAULT.withRecordSeparator('\n').withQuote(DQUOTE_CHAR).withEscape(BACKSLASH); + final StringWriter sw = new StringWriter(); + final List list = new LinkedList<>(); + try (CSVPrinter printer = new CSVPrinter(sw, format)) { + list.add("\""); + list.add("\n"); + list.add("\\"); + printer.printRecord(list); + } + final String expected = "\"\\\"\",\"\\n\",\"\\\"" + format.getRecordSeparator(); + assertEquals(expected, sw.toString()); + final String[] record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(list.toArray(), format), record0); + } + + @Test + void testMongoDbCsvBasic() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.MONGODB_CSV)) { + printer.printRecord("a", "b"); + assertEquals("a,b" + RECORD_SEPARATOR, sw.toString()); + assertEquals(1, printer.getRecordCount()); + } + } + + @Test + void testMongoDbCsvCommaInValue() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.MONGODB_CSV)) { + printer.printRecord("a,b", "c"); + assertEquals("\"a,b\",c" + RECORD_SEPARATOR, sw.toString()); + assertEquals(1, printer.getRecordCount()); + } + } + + @Test + void testMongoDbCsvDoubleQuoteInValue() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.MONGODB_CSV)) { + printer.printRecord("a \"c\" b", "d"); + assertEquals("\"a \"\"c\"\" b\",d" + RECORD_SEPARATOR, sw.toString()); + assertEquals(1, printer.getRecordCount()); + } + } + + @Test + void testMongoDbCsvTabInValue() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.MONGODB_CSV)) { + printer.printRecord("a\tb", "c"); + assertEquals("a\tb,c" + RECORD_SEPARATOR, sw.toString()); + assertEquals(1, printer.getRecordCount()); + } + } + + @Test + void testMongoDbTsvBasic() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.MONGODB_TSV)) { + printer.printRecord("a", "b"); + assertEquals("a\tb" + RECORD_SEPARATOR, sw.toString()); + assertEquals(1, printer.getRecordCount()); + } + } + + @Test + void testMongoDbTsvCommaInValue() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.MONGODB_TSV)) { + printer.printRecord("a,b", "c"); + assertEquals("a,b\tc" + RECORD_SEPARATOR, sw.toString()); + assertEquals(1, printer.getRecordCount()); + } + } + + @Test + void testMongoDbTsvTabInValue() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.MONGODB_TSV)) { + printer.printRecord("a\tb", "c"); + assertEquals("\"a\tb\"\tc" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testMultiLineComment() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withCommentMarker('#'))) { + printer.printComment("This is a comment\non multiple lines"); + assertEquals("# This is a comment" + RECORD_SEPARATOR + "# on multiple lines" + RECORD_SEPARATOR, sw.toString()); + assertEquals(0, printer.getRecordCount()); + } + } + + @Test + void testMySqlNullOutput() throws IOException { + Object[] s = new String[] { "NULL", null }; + CSVFormat format = CSVFormat.MYSQL.withQuote(DQUOTE_CHAR).withNullString("NULL").withQuoteMode(QuoteMode.NON_NUMERIC); + StringWriter writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + String expected = "\"NULL\"\tNULL\n"; + assertEquals(expected, writer.toString()); + String[] record0 = toFirstRecordValues(expected, format); + assertArrayEquals(s, record0); + + s = new String[] { "\\N", null }; + format = CSVFormat.MYSQL.withNullString("\\N"); + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\\\\N\t\\N\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "\\N", "A" }; + format = CSVFormat.MYSQL.withNullString("\\N"); + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\\\\N\tA\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "\n", "A" }; + format = CSVFormat.MYSQL.withNullString("\\N"); + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\\n\tA\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "", null }; + format = CSVFormat.MYSQL.withNullString("NULL"); + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\tNULL\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "", null }; + format = CSVFormat.MYSQL; + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\t\\N\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "\\N", "", "\u000e,\\\r" }; + format = CSVFormat.MYSQL; + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\\\\N\t\t\u000e,\\\\\\r\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "NULL", "\\\r" }; + format = CSVFormat.MYSQL; + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "NULL\t\\\\\\r\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "\\\r" }; + format = CSVFormat.MYSQL; + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\\\\\\r\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + } + + @Test + void testMySqlNullStringDefault() { + assertEquals("\\N", CSVFormat.MYSQL.getNullString()); + } + + @Test + void testNewCsvPrinterAppendableNullFormat() { + assertThrows(NullPointerException.class, () -> new CSVPrinter(new StringWriter(), null)); + } + + @Test + void testNewCsvPrinterNullAppendableFormat() { + assertThrows(NullPointerException.class, () -> new CSVPrinter(null, CSVFormat.DEFAULT)); + } + + @Test + void testNotFlushable() throws IOException { + final Appendable out = new StringBuilder(); + try (CSVPrinter printer = new CSVPrinter(out, CSVFormat.DEFAULT)) { + printer.printRecord("a", "b", "c"); + assertEquals("a,b,c" + RECORD_SEPARATOR, out.toString()); + printer.flush(); + } + } + + @Test + void testParseCustomNullValues() throws IOException { + final StringWriter sw = new StringWriter(); + final CSVFormat format = CSVFormat.DEFAULT.withNullString("NULL"); + try (CSVPrinter printer = new CSVPrinter(sw, format)) { + printer.printRecord("a", null, "b"); + } + final String csvString = sw.toString(); + assertEquals("a,NULL,b" + RECORD_SEPARATOR, csvString); + try (CSVParser iterable = format.parse(new StringReader(csvString))) { + final Iterator iterator = iterable.iterator(); + final CSVRecord record = iterator.next(); + assertEquals("a", record.get(0)); + assertNull(record.get(1)); + assertEquals("b", record.get(2)); + assertFalse(iterator.hasNext()); + } + } + + @Test + void testPlainEscaped() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null).withEscape('!'))) { + printer.print("abc"); + printer.print("xyz"); + assertEquals("abc,xyz", sw.toString()); + } + } + + @Test + void testPlainPlain() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null))) { + printer.print("abc"); + printer.print("xyz"); + assertEquals("abc,xyz", sw.toString()); + } + } + + @Test + void testPlainQuoted() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote('\''))) { + printer.print("abc"); + assertEquals("abc", sw.toString()); + } + } + + @Test + @Disabled + void testPostgreSqlCsvNullOutput() throws IOException { + Object[] s = new String[] { "NULL", null }; + CSVFormat format = CSVFormat.POSTGRESQL_CSV.withQuote(DQUOTE_CHAR).withNullString("NULL").withQuoteMode(QuoteMode.ALL_NON_NULL); + StringWriter writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + String expected = "\"NULL\",NULL\n"; + assertEquals(expected, writer.toString()); + String[] record0 = toFirstRecordValues(expected, format); + assertArrayEquals(new Object[2], record0); + + s = new String[] { "\\N", null }; + format = CSVFormat.POSTGRESQL_CSV.withNullString("\\N"); + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\\\\N\t\\N\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "\\N", "A" }; + format = CSVFormat.POSTGRESQL_CSV.withNullString("\\N"); + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\\\\N\tA\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "\n", "A" }; + format = CSVFormat.POSTGRESQL_CSV.withNullString("\\N"); + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\\n\tA\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "", null }; + format = CSVFormat.POSTGRESQL_CSV.withNullString("NULL"); + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\tNULL\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "", null }; + format = CSVFormat.POSTGRESQL_CSV; + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\t\\N\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "\\N", "", "\u000e,\\\r" }; + format = CSVFormat.POSTGRESQL_CSV; + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\\\\N\t\t\u000e,\\\\\\r\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "NULL", "\\\r" }; + format = CSVFormat.POSTGRESQL_CSV; + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "NULL\t\\\\\\r\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "\\\r" }; + format = CSVFormat.POSTGRESQL_CSV; + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\\\\\\r\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + } + + @Test + @Disabled + void testPostgreSqlCsvTextOutput() throws IOException { + Object[] s = new String[] { "NULL", null }; + CSVFormat format = CSVFormat.POSTGRESQL_TEXT.withQuote(DQUOTE_CHAR).withNullString("NULL").withQuoteMode(QuoteMode.ALL_NON_NULL); + StringWriter writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + String expected = "\"NULL\"\tNULL\n"; + assertEquals(expected, writer.toString()); + String[] record0 = toFirstRecordValues(expected, format); + assertArrayEquals(new Object[2], record0); + + s = new String[] { "\\N", null }; + format = CSVFormat.POSTGRESQL_TEXT.withNullString("\\N"); + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\\\\N\t\\N\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "\\N", "A" }; + format = CSVFormat.POSTGRESQL_TEXT.withNullString("\\N"); + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\\\\N\tA\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "\n", "A" }; + format = CSVFormat.POSTGRESQL_TEXT.withNullString("\\N"); + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\\n\tA\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "", null }; + format = CSVFormat.POSTGRESQL_TEXT.withNullString("NULL"); + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\tNULL\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "", null }; + format = CSVFormat.POSTGRESQL_TEXT; + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\t\\N\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "\\N", "", "\u000e,\\\r" }; + format = CSVFormat.POSTGRESQL_TEXT; + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\\\\N\t\t\u000e,\\\\\\r\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "NULL", "\\\r" }; + format = CSVFormat.POSTGRESQL_TEXT; + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "NULL\t\\\\\\r\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + + s = new String[] { "\\\r" }; + format = CSVFormat.POSTGRESQL_TEXT; + writer = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(writer, format)) { + printer.printRecord(s); + } + expected = "\\\\\\r\n"; + assertEquals(expected, writer.toString()); + record0 = toFirstRecordValues(expected, format); + assertArrayEquals(expectNulls(s, format), record0); + } + + @Test + void testPostgreSqlNullStringDefaultCsv() { + assertEquals("", CSVFormat.POSTGRESQL_CSV.getNullString()); + } + + @Test + void testPostgreSqlNullStringDefaultText() { + assertEquals("\\N", CSVFormat.POSTGRESQL_TEXT.getNullString()); + } + + @Test + void testPrint() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = CSVFormat.DEFAULT.print(sw)) { + assertInitialState(printer); + printer.printRecord("a", "b\\c"); + assertEquals("a,b\\c" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testPrintCSVParser() throws IOException { + // @formatter:off + final String code = "a1,b1\n" + // 1) + "a2,b2\n" + // 2) + "a3,b3\n" + // 3) + "a4,b4\n"; // 4) + // @formatter:on + final String[][] res = { { "a1", "b1" }, { "a2", "b2" }, { "a3", "b3" }, { "a4", "b4" } }; + final CSVFormat format = CSVFormat.DEFAULT; + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = format.print(sw); + CSVParser parser = CSVParser.parse(code, format)) { + assertInitialState(printer); + printer.printRecords(parser); + } + try (CSVParser parser = CSVParser.parse(sw.toString(), format)) { + final List records = parser.getRecords(); + assertFalse(records.isEmpty()); + Utils.compare("Fail", res, records, -1); + } + } + + @Test + void testPrintCSVRecord() throws IOException { + // @formatter:off + final String code = "a1,b1\n" + // 1) + "a2,b2\n" + // 2) + "a3,b3\n" + // 3) + "a4,b4\n"; // 4) + // @formatter:on + final String[][] res = { { "a1", "b1" }, { "a2", "b2" }, { "a3", "b3" }, { "a4", "b4" } }; + final CSVFormat format = CSVFormat.DEFAULT; + final StringWriter sw = new StringWriter(); + int row = 0; + try (CSVPrinter printer = format.print(sw); + CSVParser parser = CSVParser.parse(code, format)) { + assertInitialState(printer); + for (final CSVRecord record : parser) { + printer.printRecord(record); + assertEquals(++row, printer.getRecordCount()); + } + assertEquals(row, printer.getRecordCount()); + } + try (CSVParser parser = CSVParser.parse(sw.toString(), format)) { + final List records = parser.getRecords(); + assertFalse(records.isEmpty()); + Utils.compare("Fail", res, records, -1); + } + } + + @ParameterizedTest + @ValueSource(longs = { -1, 0, 3, 4, Long.MAX_VALUE }) + void testPrintCSVRecords(final long maxRows) throws IOException { + // @formatter:off + final String code = "a1,b1\n" + // 1) + "a2,b2\n" + // 2) + "a3,b3\n" + // 3) + "a4,b4\n"; // 4) + // @formatter:on + final String[][] expected = { { "a1", "b1" }, { "a2", "b2" }, { "a3", "b3" }, { "a4", "b4" } }; + final CSVFormat format = CSVFormat.DEFAULT.builder().setMaxRows(maxRows).get(); + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = format.print(sw); + CSVParser parser = CSVParser.parse(code, format)) { + assertInitialState(printer); + printer.printRecords(parser.getRecords()); + } + try (CSVParser parser = CSVParser.parse(sw.toString(), format)) { + final List records = parser.getRecords(); + assertFalse(records.isEmpty()); + Utils.compare("Fail", expected, records, maxRows); + } + } + + @Test + void testPrintCustomNullValues() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withNullString("NULL"))) { + assertInitialState(printer); + printer.printRecord("a", null, "b"); + assertEquals("a,NULL,b" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testPrinter1() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT)) { + assertInitialState(printer); + printer.printRecord("a", "b"); + assertEquals(1, printer.getRecordCount()); + assertEquals("a,b" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testPrinter2() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT)) { + assertInitialState(printer); + printer.printRecord("a,b", "b"); + assertEquals("\"a,b\",b" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testPrinter3() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT)) { + assertInitialState(printer); + printer.printRecord("a, b", "b "); + assertEquals("\"a, b\",\"b \"" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testPrinter4() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT)) { + assertInitialState(printer); + printer.printRecord("a", "b\"c"); + assertEquals("a,\"b\"\"c\"" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testPrinter5() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT)) { + assertInitialState(printer); + printer.printRecord("a", "b\nc"); + assertEquals("a,\"b\nc\"" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testPrinter6() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT)) { + assertInitialState(printer); + printer.printRecord("a", "b\r\nc"); + assertEquals("a,\"b\r\nc\"" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testPrinter7() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT)) { + assertInitialState(printer); + printer.printRecord("a", "b\\c"); + assertEquals("a,b\\c" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testPrintNullValues() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT)) { + assertInitialState(printer); + printer.printRecord("a", null, "b"); + assertEquals("a,,b" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testPrintOnePositiveInteger() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuoteMode(QuoteMode.MINIMAL))) { + assertInitialState(printer); + printer.print(Integer.MAX_VALUE); + assertEquals(String.valueOf(Integer.MAX_VALUE), sw.toString()); + } + } + + /** + * Test to target the use of {@link IOUtils#copy(java.io.Reader, Appendable)} which directly buffers the value from the Reader to the Appendable. + * + *

+ * Requires the format to have no quote or escape character, value to be a {@link Reader Reader} and the output MUST NOT be a {@link Writer Writer} + * but some other Appendable. + *

+ * + * @throws IOException Not expected to happen + */ + @Test + void testPrintReaderWithoutQuoteToAppendable() throws IOException { + final StringBuilder sb = new StringBuilder(); + final String content = "testValue"; + try (CSVPrinter printer = new CSVPrinter(sb, CSVFormat.DEFAULT.withQuote(null))) { + assertInitialState(printer); + final StringReader value = new StringReader(content); + printer.print(value); + } + assertEquals(content, sb.toString()); + } + + /** + * Test to target the use of {@link IOUtils#copyLarge(java.io.Reader, Writer)} which directly buffers the value from the Reader to the Writer. + * + *

+ * Requires the format to have no quote or escape character, value to be a {@link Reader Reader} and the output MUST be a {@link Writer Writer}. + *

+ * + * @throws IOException Not expected to happen + */ + @Test + void testPrintReaderWithoutQuoteToWriter() throws IOException { + final StringWriter sw = new StringWriter(); + final String content = "testValue"; + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null))) { + final StringReader value = new StringReader(content); + printer.print(value); + } + assertEquals(content, sw.toString()); + } + + @Test + void testPrintRecordStream() throws IOException { + // @formatter:off + final String code = "a1,b1\n" + // 1) + "a2,b2\n" + // 2) + "a3,b3\n" + // 3) + "a4,b4\n"; // 4) + // @formatter:on + final String[][] res = { { "a1", "b1" }, { "a2", "b2" }, { "a3", "b3" }, { "a4", "b4" } }; + final CSVFormat format = CSVFormat.DEFAULT; + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = format.print(sw); + CSVParser parser = CSVParser.parse(code, format)) { + long count = 0; + for (final CSVRecord record : parser) { + printer.printRecord(record.stream()); + assertEquals(++count, printer.getRecordCount()); + } + } + try (CSVParser parser = CSVParser.parse(sw.toString(), format)) { + final List records = parser.getRecords(); + assertFalse(records.isEmpty()); + Utils.compare("Fail", res, records, -1); + } + } + + @Test + void testPrintRecordsWithCSVRecord() throws IOException { + final String[] values = { "A", "B", "C" }; + final String rowData = StringUtils.join(values, ','); + final CharArrayWriter charArrayWriter = new CharArrayWriter(0); + try (CSVParser parser = CSVFormat.DEFAULT.parse(new StringReader(rowData)); + CSVPrinter printer = CSVFormat.INFORMIX_UNLOAD.print(charArrayWriter)) { + long count = 0; + for (final CSVRecord record : parser) { + printer.printRecord(record); + assertEquals(++count, printer.getRecordCount()); + } + } + assertEquals(6, charArrayWriter.size()); + assertEquals("A|B|C" + CSVFormat.INFORMIX_UNLOAD.getRecordSeparator(), charArrayWriter.toString()); + } + + @Test + void testPrintRecordsWithEmptyVector() throws IOException { + final PrintStream out = System.out; + try { + System.setOut(new PrintStream(NullOutputStream.INSTANCE)); + try (CSVPrinter printer = CSVFormat.POSTGRESQL_TEXT.printer()) { + final Vector vector = new Vector<>(); + final int expectedCapacity = 23; + vector.setSize(expectedCapacity); + printer.printRecords(vector); + assertEquals(expectedCapacity, vector.capacity()); + assertEquals(expectedCapacity, printer.getRecordCount()); + } + } finally { + System.setOut(out); + } + } + + @Test + void testPrintRecordsWithObjectArray() throws IOException { + final CharArrayWriter charArrayWriter = new CharArrayWriter(0); + final Object[] objectArray = new Object[6]; + try (CSVPrinter printer = CSVFormat.INFORMIX_UNLOAD.print(charArrayWriter)) { + final HashSet hashSet = new HashSet<>(); + objectArray[3] = hashSet; + printer.printRecords(objectArray); + assertEquals(objectArray.length, printer.getRecordCount()); + } + assertEquals(6, charArrayWriter.size()); + assertEquals("\n\n\n\n\n\n", charArrayWriter.toString()); + } + + @Test + void testPrintRecordsWithResultSetOneRow() throws IOException, SQLException { + try (CSVPrinter printer = CSVFormat.MYSQL.printer()) { + try (ResultSet resultSet = new SimpleResultSet()) { + assertInitialState(printer); + printer.printRecords(resultSet); + assertInitialState(printer); + assertEquals(0, resultSet.getRow()); + } + } + } + + @Test + void testPrintToFileWithCharsetUtf16Be() throws IOException { + final File file = createTempFile(); + try (CSVPrinter printer = CSVFormat.DEFAULT.print(file, StandardCharsets.UTF_16BE)) { + printer.printRecord("a", "b\\c"); + } + assertEquals("a,b\\c" + RECORD_SEPARATOR, FileUtils.readFileToString(file, StandardCharsets.UTF_16BE)); + } + + @Test + void testPrintToFileWithDefaultCharset() throws IOException { + final File file = createTempFile(); + try (CSVPrinter printer = CSVFormat.DEFAULT.print(file, Charset.defaultCharset())) { + printer.printRecord("a", "b\\c"); + } + assertEquals("a,b\\c" + RECORD_SEPARATOR, FileUtils.readFileToString(file, Charset.defaultCharset())); + } + + @Test + void testPrintToPathWithDefaultCharset() throws IOException { + final Path file = createTempPath(); + try (CSVPrinter printer = CSVFormat.DEFAULT.print(file, Charset.defaultCharset())) { + printer.printRecord("a", "b\\c"); + } + assertEquals("a,b\\c" + RECORD_SEPARATOR, new String(Files.readAllBytes(file), Charset.defaultCharset())); + } + + @Test + void testQuoteAll() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuoteMode(QuoteMode.ALL))) { + printer.printRecord("a", "b\nc", "d"); + assertEquals("\"a\",\"b\nc\",\"d\"" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testQuoteCharEscapedWithQuoteModeNone() throws IOException { + final CSVFormat format = CSVFormat.DEFAULT.builder().setQuote('"').setEscape('?').setQuoteMode(QuoteMode.NONE).get(); + final StringWriter sw = new StringWriter(); + final String col1 = "\"abc"; + final String col2 = "x\"y"; + try (CSVPrinter printer = new CSVPrinter(sw, format)) { + printer.printRecord(col1, col2); + printer.printRecord(new StringReader(col1), new StringReader(col2)); + } + assertEquals("?\"abc,x?\"y" + RECORD_SEPARATOR + "?\"abc,x?\"y" + RECORD_SEPARATOR, sw.toString()); + // The emitted records must read back as the original values. + try (CSVParser parser = CSVParser.parse(sw.toString(), format)) { + final List records = parser.getRecords(); + assertEquals(2, records.size()); + for (final CSVRecord record : records) { + assertEquals(col1, record.get(0)); + assertEquals(col2, record.get(1)); + } + } + } + + @Test + void testQuoteCommaFirstChar() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.RFC4180)) { + printer.printRecord(","); + assertEquals("\",\"" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testQuoteCommentMarkerFirstChar() throws IOException { + final CSVFormat format = CSVFormat.DEFAULT.builder().setCommentMarker(';').get(); + final StringWriter sw = new StringWriter(); + final String col1 = ";comment-like"; + try (CSVPrinter printer = new CSVPrinter(sw, format)) { + // A real comment is written with the marker, unquoted. + printer.printComment("a real comment"); + // A value starting with the marker is quoted, so it does not read back as a comment. + printer.printRecord(col1, "b"); + // The marker past the first character does not start a comment, so only the leading-marker value is quoted. + printer.printRecord("a;b", ";c"); + } + final String string = sw.toString(); + assertEquals("; a real comment" + RECORD_SEPARATOR + + "\";comment-like\",b" + RECORD_SEPARATOR + + "a;b,\";c\"" + RECORD_SEPARATOR, string); + // The comment is dropped on read; both data records survive intact. + try (CSVParser parser = CSVParser.parse(string, format)) { + final List records = parser.getRecords(); + assertEquals(2, records.size()); + assertEquals(col1, records.get(0).get(0)); + assertEquals("b", records.get(0).get(1)); + assertEquals("a;b", records.get(1).get(0)); + assertEquals(";c", records.get(1).get(1)); + } + } + + @Test + void testQuoteNonNumeric() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuoteMode(QuoteMode.NON_NUMERIC))) { + printer.printRecord("a", "b\nc", Integer.valueOf(1)); + assertEquals("\"a\",\"b\nc\",1" + RECORD_SEPARATOR, sw.toString()); + } + } + + @Test + void testRandomDefault() throws Exception { + doRandom(CSVFormat.DEFAULT, ITERATIONS_FOR_RANDOM_TEST); + } + + @Test + void testRandomExcel() throws Exception { + doRandom(CSVFormat.EXCEL, ITERATIONS_FOR_RANDOM_TEST); + } + + @Test + @Disabled + void testRandomMongoDbCsv() throws Exception { + doRandom(CSVFormat.MONGODB_CSV, ITERATIONS_FOR_RANDOM_TEST); + } + + @Test + void testRandomMySql() throws Exception { + doRandom(CSVFormat.MYSQL, ITERATIONS_FOR_RANDOM_TEST); + } + + @Test + @Disabled + void testRandomOracle() throws Exception { + doRandom(CSVFormat.ORACLE, ITERATIONS_FOR_RANDOM_TEST); + } + + @Test + @Disabled + void testRandomPostgreSqlCsv() throws Exception { + doRandom(CSVFormat.POSTGRESQL_CSV, ITERATIONS_FOR_RANDOM_TEST); + } + + @Test + void testRandomPostgreSqlText() throws Exception { + doRandom(CSVFormat.POSTGRESQL_TEXT, ITERATIONS_FOR_RANDOM_TEST); + } + + @Test + void testRandomRfc4180() throws Exception { + doRandom(CSVFormat.RFC4180, ITERATIONS_FOR_RANDOM_TEST); + } + + @Test + void testRandomTdf() throws Exception { + doRandom(CSVFormat.TDF, ITERATIONS_FOR_RANDOM_TEST); + } + + @Test + void testSingleLineComment() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withCommentMarker('#'))) { + printer.printComment("This is a comment"); + assertEquals("# This is a comment" + RECORD_SEPARATOR, sw.toString()); + assertEquals(0, printer.getRecordCount()); + } + } + + @Test + void testSingleQuoteQuoted() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote('\''))) { + printer.print("a'b'c"); + printer.print("xyz"); + assertEquals("'a''b''c',xyz", sw.toString()); + } + } + + @Test + void testSkipHeaderRecordFalse() throws IOException { + // functionally identical to testHeader, used to test CSV-153 + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null).withHeader("C1", "C2", "C3").withSkipHeaderRecord(false))) { + printer.printRecord("a", "b", "c"); + printer.printRecord("x", "y", "z"); + assertEquals("C1,C2,C3\r\na,b,c\r\nx,y,z\r\n", sw.toString()); + } + } + + @Test + void testSkipHeaderRecordTrue() throws IOException { + // functionally identical to testHeaderNotSet, used to test CSV-153 + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withQuote(null).withHeader("C1", "C2", "C3").withSkipHeaderRecord(true))) { + printer.printRecord("a", "b", "c"); + printer.printRecord("x", "y", "z"); + assertEquals("a,b,c\r\nx,y,z\r\n", sw.toString()); + } + } + + @Test + void testTrailingDelimiterOnTwoColumns() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withTrailingDelimiter())) { + printer.printRecord("A", "B"); + assertEquals("A,B,\r\n", sw.toString()); + } + } + + @Test + void testTrimOffOneColumn() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withTrim(false))) { + printer.print(" A "); + assertEquals("\" A \"", sw.toString()); + } + } + + @Test + void testTrimOnOneColumn() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withTrim())) { + printer.print(" A "); + assertEquals("A", sw.toString()); + } + } + + @Test + void testTrimOnTwoColumns() throws IOException { + final StringWriter sw = new StringWriter(); + try (CSVPrinter printer = new CSVPrinter(sw, CSVFormat.DEFAULT.withTrim())) { + printer.print(" A "); + printer.print(" B "); + assertEquals("A,B", sw.toString()); + } + } + + private String[] toFirstRecordValues(final String expected, final CSVFormat format) throws IOException { + try (CSVParser parser = CSVParser.parse(expected, format)) { + return parser.getRecords().get(0).values(); + } + } + + private void tryFormat(final List list, final Character quote, final Character escape, final String expected) throws IOException { + final CSVFormat format = CSVFormat.DEFAULT.withQuote(quote).withEscape(escape).withRecordSeparator(null); + final Appendable out = new StringBuilder(); + try (CSVPrinter printer = new CSVPrinter(out, format)) { + printer.printRecord(list); + } + assertEquals(expected, out.toString()); + } + +} diff --git a/src/test/java/org/apache/commons/csv/CSVRecordTest.java b/src/test/java/org/apache/commons/csv/CSVRecordTest.java index 5b0c5d812c..94060d62b2 100644 --- a/src/test/java/org/apache/commons/csv/CSVRecordTest.java +++ b/src/test/java/org/apache/commons/csv/CSVRecordTest.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv; @@ -43,7 +45,7 @@ import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; -public class CSVRecordTest { +class CSVRecordTest { private enum EnumFixture { UNKNOWN_COLUMN @@ -66,37 +68,38 @@ public String toString() { } private Map headerMap; - private CSVRecord record, recordWithHeader; + private CSVRecord record; + private CSVRecord recordWithHeader; private String[] values; @BeforeEach public void setUp() throws Exception { values = new String[] { "A", "B", "C" }; final String rowData = StringUtils.join(values, ','); - try (final CSVParser parser = CSVFormat.DEFAULT.parse(new StringReader(rowData))) { + try (CSVParser parser = CSVFormat.DEFAULT.parse(new StringReader(rowData))) { record = parser.iterator().next(); } - try (final CSVParser parser = CSVFormat.DEFAULT.builder().setHeader(EnumHeader.class).get().parse(new StringReader(rowData))) { + try (CSVParser parser = CSVFormat.DEFAULT.builder().setHeader(EnumHeader.class).get().parse(new StringReader(rowData))) { recordWithHeader = parser.iterator().next(); headerMap = parser.getHeaderMap(); } } @Test - public void testCSVRecordNULLValues() throws IOException { + void testCSVRecordNULLValues() throws IOException { try (CSVParser parser = CSVParser.parse("A,B\r\nONE,TWO", CSVFormat.DEFAULT.withHeader())) { - final CSVRecord csvRecord = new CSVRecord(parser, null, null, 0L, 0L); + final CSVRecord csvRecord = new CSVRecord(parser, null, null, 0L, 0L, 0L); assertEquals(0, csvRecord.size()); assertThrows(IllegalArgumentException.class, () -> csvRecord.get("B")); } } @Test - public void testDuplicateHeaderGet() throws IOException { + void testDuplicateHeaderGet() throws IOException { final String csv = "A,A,B,B\n1,2,5,6\n"; final CSVFormat format = CSVFormat.DEFAULT.builder().setHeader().get(); - try (final CSVParser parser = CSVParser.parse(csv, format)) { + try (CSVParser parser = CSVParser.parse(csv, format)) { final CSVRecord record = parser.nextRecord(); assertAll("Test that it gets the last instance of a column when there are duplicate headings", @@ -107,11 +110,11 @@ public void testDuplicateHeaderGet() throws IOException { } @Test - public void testDuplicateHeaderToMap() throws IOException { + void testDuplicateHeaderToMap() throws IOException { final String csv = "A,A,B,B\n1,2,5,6\n"; final CSVFormat format = CSVFormat.DEFAULT.builder().setHeader().get(); - try (final CSVParser parser = CSVParser.parse(csv, format)) { + try (CSVParser parser = CSVParser.parse(csv, format)) { final CSVRecord record = parser.nextRecord(); final Map map = record.toMap(); @@ -123,64 +126,64 @@ public void testDuplicateHeaderToMap() throws IOException { } @Test - public void testGetInt() { + void testGetInt() { assertEquals(values[0], record.get(0)); assertEquals(values[1], record.get(1)); assertEquals(values[2], record.get(2)); } @Test - public void testGetNullEnum() { + void testGetNullEnum() { assertThrows(IllegalArgumentException.class, () -> recordWithHeader.get((Enum) null)); } @Test - public void testGetString() { + void testGetString() { assertEquals(values[0], recordWithHeader.get(EnumHeader.FIRST.name())); assertEquals(values[1], recordWithHeader.get(EnumHeader.SECOND.name())); assertEquals(values[2], recordWithHeader.get(EnumHeader.THIRD.name())); } @Test - public void testGetStringInconsistentRecord() { + void testGetStringInconsistentRecord() { headerMap.put("fourth", Integer.valueOf(4)); assertThrows(IllegalArgumentException.class, () -> recordWithHeader.get("fourth")); } @Test - public void testGetStringNoHeader() { + void testGetStringNoHeader() { assertThrows(IllegalStateException.class, () -> record.get("first")); } @Test - public void testGetUnmappedEnum() { + void testGetUnmappedEnum() { assertThrows(IllegalArgumentException.class, () -> recordWithHeader.get(EnumFixture.UNKNOWN_COLUMN)); } @Test - public void testGetUnmappedName() { + void testGetUnmappedName() { assertThrows(IllegalArgumentException.class, () -> assertNull(recordWithHeader.get("fourth"))); } @Test - public void testGetUnmappedNegativeInt() { + void testGetUnmappedNegativeInt() { assertThrows(ArrayIndexOutOfBoundsException.class, () -> recordWithHeader.get(Integer.MIN_VALUE)); } @Test - public void testGetUnmappedPositiveInt() { + void testGetUnmappedPositiveInt() { assertThrows(ArrayIndexOutOfBoundsException.class, () -> recordWithHeader.get(Integer.MAX_VALUE)); } @Test - public void testGetWithEnum() { + void testGetWithEnum() { assertEquals(recordWithHeader.get("FIRST"), recordWithHeader.get(EnumHeader.FIRST)); assertEquals(recordWithHeader.get("SECOND"), recordWithHeader.get(EnumHeader.SECOND)); assertThrows(IllegalArgumentException.class, () -> recordWithHeader.get(EnumFixture.UNKNOWN_COLUMN)); } @Test - public void testIsConsistent() { + void testIsConsistent() { assertTrue(record.isConsistent()); assertTrue(recordWithHeader.isConsistent()); final Map map = recordWithHeader.getParser().getHeaderMap(); @@ -190,10 +193,10 @@ public void testIsConsistent() { } @Test - public void testIsInconsistent() throws IOException { + void testIsInconsistent() throws IOException { final String[] headers = { "first", "second", "third" }; final String rowData = StringUtils.join(values, ','); - try (final CSVParser parser = CSVFormat.DEFAULT.withHeader(headers).parse(new StringReader(rowData))) { + try (CSVParser parser = CSVFormat.DEFAULT.withHeader(headers).parse(new StringReader(rowData))) { final Map map = parser.getHeaderMapRaw(); final CSVRecord record1 = parser.iterator().next(); map.put("fourth", Integer.valueOf(4)); @@ -202,14 +205,14 @@ public void testIsInconsistent() throws IOException { } @Test - public void testIsMapped() { + void testIsMapped() { assertFalse(record.isMapped("first")); assertTrue(recordWithHeader.isMapped(EnumHeader.FIRST.name())); assertFalse(recordWithHeader.isMapped("fourth")); } @Test - public void testIsSetInt() { + void testIsSetInt() { assertFalse(record.isSet(-1)); assertTrue(record.isSet(0)); assertTrue(record.isSet(2)); @@ -219,14 +222,14 @@ public void testIsSetInt() { } @Test - public void testIsSetString() { + void testIsSetString() { assertFalse(record.isSet("first")); assertTrue(recordWithHeader.isSet(EnumHeader.FIRST.name())); assertFalse(recordWithHeader.isSet("DOES NOT EXIST")); } @Test - public void testIterator() { + void testIterator() { int i = 0; for (final String value : record) { assertEquals(values[i], value); @@ -235,7 +238,7 @@ public void testIterator() { } @Test - public void testPutInMap() { + void testPutInMap() { final Map map = new ConcurrentHashMap<>(); this.recordWithHeader.putIn(map); validateMap(map, false); @@ -245,9 +248,9 @@ public void testPutInMap() { } @Test - public void testRemoveAndAddColumns() throws IOException { + void testRemoveAndAddColumns() throws IOException { // do: - try (final CSVPrinter printer = new CSVPrinter(new StringBuilder(), CSVFormat.DEFAULT)) { + try (CSVPrinter printer = new CSVPrinter(new StringBuilder(), CSVFormat.DEFAULT)) { final Map map = recordWithHeader.toMap(); map.remove("OldColumn"); map.put("ZColumn", "NewValue"); @@ -260,9 +263,9 @@ public void testRemoveAndAddColumns() throws IOException { } @Test - public void testSerialization() throws IOException, ClassNotFoundException { + void testSerialization() throws IOException, ClassNotFoundException { final CSVRecord shortRec; - try (final CSVParser parser = CSVParser.parse("A,B\n#my comment\nOne,Two", CSVFormat.DEFAULT.withHeader().withCommentMarker('#'))) { + try (CSVParser parser = CSVParser.parse("A,B\n#my comment\nOne,Two", CSVFormat.DEFAULT.withHeader().withCommentMarker('#'))) { shortRec = parser.iterator().next(); } final ByteArrayOutputStream out = new ByteArrayOutputStream(); @@ -293,7 +296,7 @@ public void testSerialization() throws IOException, ClassNotFoundException { } @Test - public void testStream() { + void testStream() { final AtomicInteger i = new AtomicInteger(); record.stream().forEach(value -> { assertEquals(values[i.get()], value); @@ -302,7 +305,7 @@ public void testStream() { } @Test - public void testToListAdd() { + void testToListAdd() { final String[] expected = values.clone(); final List list = record.toList(); list.add("Last"); @@ -312,7 +315,7 @@ public void testToListAdd() { } @Test - public void testToListFor() { + void testToListFor() { int i = 0; for (final String value : record.toList()) { assertEquals(values[i], value); @@ -321,7 +324,7 @@ public void testToListFor() { } @Test - public void testToListForEach() { + void testToListForEach() { final AtomicInteger i = new AtomicInteger(); record.toList().forEach(e -> { assertEquals(values[i.getAndIncrement()], e); @@ -329,7 +332,7 @@ public void testToListForEach() { } @Test - public void testToListSet() { + void testToListSet() { final String[] expected = values.clone(); final List list = record.toList(); list.set(list.size() - 1, "Last"); @@ -339,14 +342,14 @@ public void testToListSet() { } @Test - public void testToMap() { + void testToMap() { final Map map = this.recordWithHeader.toMap(); validateMap(map, true); } @Test - public void testToMapWithNoHeader() throws Exception { - try (final CSVParser parser = CSVParser.parse("a,b", CSVFormat.newFormat(','))) { + void testToMapWithNoHeader() throws Exception { + try (CSVParser parser = CSVParser.parse("a,b", CSVFormat.newFormat(','))) { final CSVRecord shortRec = parser.iterator().next(); final Map map = shortRec.toMap(); assertNotNull(map, "Map is not null."); @@ -355,15 +358,15 @@ public void testToMapWithNoHeader() throws Exception { } @Test - public void testToMapWithShortRecord() throws Exception { - try (final CSVParser parser = CSVParser.parse("a,b", CSVFormat.DEFAULT.withHeader("A", "B", "C"))) { + void testToMapWithShortRecord() throws Exception { + try (CSVParser parser = CSVParser.parse("a,b", CSVFormat.DEFAULT.withHeader("A", "B", "C"))) { final CSVRecord shortRec = parser.iterator().next(); shortRec.toMap(); } } @Test - public void testToString() { + void testToString() { assertNotNull(recordWithHeader.toString()); assertTrue(recordWithHeader.toString().contains("comment=")); assertTrue(recordWithHeader.toString().contains("recordNumber=")); diff --git a/src/test/java/org/apache/commons/csv/CsvAssertions.java b/src/test/java/org/apache/commons/csv/CsvAssertions.java new file mode 100644 index 0000000000..b6c2b5d9cd --- /dev/null +++ b/src/test/java/org/apache/commons/csv/CsvAssertions.java @@ -0,0 +1,29 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.commons.csv; + +import static org.junit.jupiter.api.Assertions.assertArrayEquals; + +public class CsvAssertions { + + public static void assertValuesEquals(final String[] expected, final CSVRecord actual) { + assertArrayEquals(expected, actual.values()); + } +} diff --git a/src/test/java/org/apache/commons/csv/ExtendedBufferedReaderTest.java b/src/test/java/org/apache/commons/csv/ExtendedBufferedReaderTest.java index 90b91c2978..b8d9b9f198 100644 --- a/src/test/java/org/apache/commons/csv/ExtendedBufferedReaderTest.java +++ b/src/test/java/org/apache/commons/csv/ExtendedBufferedReaderTest.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv; @@ -24,21 +26,27 @@ import static org.junit.jupiter.api.Assertions.assertNull; import java.io.StringReader; +import java.nio.charset.StandardCharsets; import org.junit.jupiter.api.Test; /** * Test {@link ExtendedBufferedReader}. */ -public class ExtendedBufferedReaderTest { +class ExtendedBufferedReaderTest { + + static final String LF = "\n"; + static final String CR = "\r"; + static final String CRLF = CR + LF; + static final String LFCR = LF + CR; // easier to read the string below private ExtendedBufferedReader createBufferedReader(final String s) { return new ExtendedBufferedReader(new StringReader(s)); } @Test - public void testEmptyInput() throws Exception { - try (final ExtendedBufferedReader br = createBufferedReader("")) { + void testEmptyInput() throws Exception { + try (ExtendedBufferedReader br = createBufferedReader("")) { assertEquals(EOF, br.read()); assertEquals(EOF, br.peek()); assertEquals(EOF, br.getLastChar()); @@ -51,48 +59,45 @@ public void testEmptyInput() throws Exception { * Test to illustrate https://issues.apache.org/jira/browse/CSV-75 */ @Test - public void testReadChar() throws Exception { - final String LF = "\n"; - final String CR = "\r"; - final String CRLF = CR + LF; - final String LFCR = LF + CR; // easier to read the string below + void testReadChar() throws Exception { final String test = "a" + LF + "b" + CR + "c" + LF + LF + "d" + CR + CR + "e" + LFCR + "f " + CRLF; // EOL eol EOL EOL eol eol EOL+CR EOL - final int EOLeolct = 9; + final int eolCount = 9; - try (final ExtendedBufferedReader br = createBufferedReader(test)) { + try (ExtendedBufferedReader br = createBufferedReader(test)) { assertEquals(0, br.getLineNumber()); int lineCount = 0; while (br.readLine() != null) { // consume all lineCount++; } - assertEquals(EOLeolct, br.getLineNumber()); + assertEquals(eolCount, br.getLineNumber()); assertEquals(lineCount, br.getLineNumber()); } - try (final ExtendedBufferedReader br = createBufferedReader(test)) { + try (ExtendedBufferedReader br = createBufferedReader(test)) { assertEquals(0, br.getLineNumber()); int readCount = 0; while (br.read() != EOF) { // consume all readCount++; } - assertEquals(EOLeolct, br.getLineNumber()); + assertEquals(eolCount, br.getLineNumber()); assertEquals(readCount, test.length()); } - try (final ExtendedBufferedReader br = createBufferedReader(test)) { + try (ExtendedBufferedReader br = createBufferedReader(test)) { assertEquals(0, br.getLineNumber()); final char[] buff = new char[10]; while (br.read(buff, 0, 3) != EOF) { // consume all } - assertEquals(EOLeolct, br.getLineNumber()); + assertEquals(eolCount, br.getLineNumber()); } } @Test - public void testReadingInDifferentBuffer() throws Exception { - final char[] tmp1 = new char[2], tmp2 = new char[4]; + void testReadingInDifferentBuffer() throws Exception { + final char[] tmp1 = new char[2]; + final char[] tmp2 = new char[4]; try (ExtendedBufferedReader reader = createBufferedReader("1\r\n2\r\n")) { reader.read(tmp1, 0, 2); reader.read(tmp2, 2, 2); @@ -101,15 +106,28 @@ public void testReadingInDifferentBuffer() throws Exception { } @Test - public void testReadLine() throws Exception { - try (final ExtendedBufferedReader br = createBufferedReader("")) { + void testReadingSupplementaryCharacterTracksBytes() throws Exception { + final String input = "๐Ÿ˜€"; + final char[] buffer = new char[input.length()]; + try (ExtendedBufferedReader reader = new ExtendedBufferedReader(new StringReader(input), StandardCharsets.UTF_8, true)) { + assertEquals(input.length(), reader.read(buffer, 0, buffer.length)); + assertArrayEquals(input.toCharArray(), buffer); + assertEquals(input.getBytes(StandardCharsets.UTF_8).length, reader.getBytesRead()); + assertEquals(input.length(), reader.getPosition()); + assertEquals(input.charAt(input.length() - 1), reader.getLastChar()); + } + } + + @Test + void testReadLine() throws Exception { + try (ExtendedBufferedReader br = createBufferedReader("")) { assertNull(br.readLine()); } - try (final ExtendedBufferedReader br = createBufferedReader("\n")) { + try (ExtendedBufferedReader br = createBufferedReader("\n")) { assertEquals("", br.readLine()); assertNull(br.readLine()); } - try (final ExtendedBufferedReader br = createBufferedReader("foo\n\nhello")) { + try (ExtendedBufferedReader br = createBufferedReader("foo\n\nhello")) { assertEquals(0, br.getLineNumber()); assertEquals("foo", br.readLine()); assertEquals(1, br.getLineNumber()); @@ -120,7 +138,7 @@ public void testReadLine() throws Exception { assertNull(br.readLine()); assertEquals(3, br.getLineNumber()); } - try (final ExtendedBufferedReader br = createBufferedReader("foo\n\nhello")) { + try (ExtendedBufferedReader br = createBufferedReader("foo\n\nhello")) { assertEquals('f', br.read()); assertEquals('o', br.peek()); assertEquals("oo", br.readLine()); @@ -133,7 +151,7 @@ public void testReadLine() throws Exception { assertNull(br.readLine()); assertEquals(3, br.getLineNumber()); } - try (final ExtendedBufferedReader br = createBufferedReader("foo\rbaar\r\nfoo")) { + try (ExtendedBufferedReader br = createBufferedReader("foo\rbaar\r\nfoo")) { assertEquals("foo", br.readLine()); assertEquals('b', br.peek()); assertEquals("baar", br.readLine()); @@ -144,8 +162,8 @@ public void testReadLine() throws Exception { } @Test - public void testReadLookahead1() throws Exception { - try (final ExtendedBufferedReader br = createBufferedReader("1\n2\r3\n")) { + void testReadLookahead1() throws Exception { + try (ExtendedBufferedReader br = createBufferedReader("1\n2\r3\n")) { assertEquals(0, br.getLineNumber()); assertEquals('1', br.peek()); assertEquals(UNDEFINED, br.getLastChar()); @@ -203,11 +221,11 @@ public void testReadLookahead1() throws Exception { } @Test - public void testReadLookahead2() throws Exception { + void testReadLookahead2() throws Exception { final char[] ref = new char[5]; final char[] res = new char[5]; - try (final ExtendedBufferedReader br = createBufferedReader("abcdefg")) { + try (ExtendedBufferedReader br = createBufferedReader("abcdefg")) { ref[0] = 'a'; ref[1] = 'b'; ref[2] = 'c'; diff --git a/src/test/java/org/apache/commons/csv/JiraCsv196Test.java b/src/test/java/org/apache/commons/csv/JiraCsv196Test.java new file mode 100644 index 0000000000..aaf8e206b3 --- /dev/null +++ b/src/test/java/org/apache/commons/csv/JiraCsv196Test.java @@ -0,0 +1,76 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.commons.csv; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +import java.io.IOException; +import java.io.InputStreamReader; +import java.io.Reader; +import java.nio.charset.StandardCharsets; + +import org.junit.jupiter.api.Test; + +class JiraCsv196Test { + + private Reader getTestInput(final String path) { + return new InputStreamReader(ClassLoader.getSystemClassLoader().getResourceAsStream(path)); + } + + @Test + void testParseFourBytes() throws IOException { + final CSVFormat format = CSVFormat.Builder.create().setDelimiter(',').setQuote('\'').get(); + // @formatter:off + try (@SuppressWarnings("resource") // parser closes the reader. + CSVParser parser = new CSVParser.Builder() + .setFormat(format) + .setReader(getTestInput("org/apache/commons/csv/CSV-196/emoji.csv")) + .setCharset(StandardCharsets.UTF_8) + .setTrackBytes(true) + .get()) { + // @formatter:on + final long[] charByteKey = { 0, 84, 701, 1318, 1935 }; + int idx = 0; + for (final CSVRecord record : parser) { + assertEquals(charByteKey[idx++], record.getBytePosition(), "At index " + idx); + } + } + } + + @Test + void testParseThreeBytes() throws IOException { + final CSVFormat format = CSVFormat.Builder.create().setDelimiter(',').setQuote('\'').get(); + // @formatter:off + try (@SuppressWarnings("resource") // parser closes the reader. + CSVParser parser = new CSVParser.Builder() + .setFormat(format) + .setReader(getTestInput("org/apache/commons/csv/CSV-196/japanese.csv")) + .setCharset(StandardCharsets.UTF_8) + .setTrackBytes(true) + .get()) { + // @formatter:on + final long[] charByteKey = { 0, 89, 242, 395 }; + int idx = 0; + for (final CSVRecord record : parser) { + assertEquals(charByteKey[idx++], record.getBytePosition(), "At index " + idx); + } + } + } +} diff --git a/src/test/java/org/apache/commons/csv/JiraCsv318Test.java b/src/test/java/org/apache/commons/csv/JiraCsv318Test.java new file mode 100644 index 0000000000..984509e87d --- /dev/null +++ b/src/test/java/org/apache/commons/csv/JiraCsv318Test.java @@ -0,0 +1,125 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.commons.csv; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.PrintWriter; +import java.util.ArrayList; +import java.util.List; +import java.util.stream.Stream; + +import org.apache.commons.io.function.IOConsumer; +import org.apache.commons.io.function.IOStream; +import org.apache.commons.lang3.ArrayUtils; +import org.junit.jupiter.api.Test; + +/** + * Tests https://issues.apache.org/jira/projects/CSV/issues/CSV-318?filter=allopenissues + * + * @see CSVPrinter + */ +class JiraCsv318Test { + + private void checkOutput(final ByteArrayOutputStream baos) { + checkOutput(baos.toString()); + } + + private void checkOutput(final String string) { + assertEquals("col a,col b,col c", string.trim()); + } + + private Stream newParallelStream() { + // returned stream is intermediate + return newStream().parallel(); + } + + private CSVPrinter newPrinter(final ByteArrayOutputStream baos) throws IOException { + return new CSVPrinter(new PrintWriter(baos), CSVFormat.DEFAULT); + } + + private Stream newSequentialStream() { + // returned stream is intermediate + return newStream().sequential(); + } + + private Stream newStream() { + return Stream.of("col a", "col b", "col c"); + } + + @Test + void testDefaultStream() throws IOException { + final ByteArrayOutputStream baos = new ByteArrayOutputStream(); + try (CSVPrinter printer = newPrinter(baos)) { + printer.printRecord(newStream()); + } + checkOutput(baos); + } + + @SuppressWarnings("resource") + @Test + void testParallelIOStream() throws IOException { + final ByteArrayOutputStream baos = new ByteArrayOutputStream(); + try (CSVPrinter printer = newPrinter(baos)) { + IOStream.adapt(newParallelStream()).forEachOrdered(printer::print); + } + // No EOR marker in this test intentionally, so checkOutput will trim. + checkOutput(baos); + } + + @SuppressWarnings("resource") + @Test + void testParallelIOStreamSynchronizedPrinterNotUsed() throws IOException { + final ByteArrayOutputStream baos = new ByteArrayOutputStream(); + try (CSVPrinter printer = newPrinter(baos)) { + synchronized (printer) { + IOStream.adapt(newParallelStream()).forEachOrdered(IOConsumer.noop()); + } + } + final List list = new ArrayList<>(); + try (CSVPrinter printer = newPrinter(baos)) { + synchronized (printer) { + IOStream.adapt(newParallelStream()).forEachOrdered(list::add); + } + } + // No EOR marker in this test intentionally, so checkOutput will trim. + checkOutput(String.join(",", list.toArray(ArrayUtils.EMPTY_STRING_ARRAY))); + } + + @Test + void testParallelStream() throws IOException { + final ByteArrayOutputStream baos = new ByteArrayOutputStream(); + try (CSVPrinter printer = newPrinter(baos)) { + printer.printRecord(newParallelStream()); + } + checkOutput(baos); + } + + @Test + void testSequentialStream() throws IOException { + final ByteArrayOutputStream baos = new ByteArrayOutputStream(); + try (CSVPrinter printer = newPrinter(baos)) { + printer.printRecord(newSequentialStream()); + } + checkOutput(baos); + } +} diff --git a/src/test/java/org/apache/commons/csv/LexerTest.java b/src/test/java/org/apache/commons/csv/LexerTest.java index 6a1aabf300..a76f6e513b 100644 --- a/src/test/java/org/apache/commons/csv/LexerTest.java +++ b/src/test/java/org/apache/commons/csv/LexerTest.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv; @@ -26,9 +28,6 @@ import static org.apache.commons.csv.Token.Type.EOF; import static org.apache.commons.csv.Token.Type.EORECORD; import static org.apache.commons.csv.Token.Type.TOKEN; -import static org.apache.commons.csv.TokenMatchers.hasContent; -import static org.apache.commons.csv.TokenMatchers.matches; -import static org.hamcrest.MatcherAssert.assertThat; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertThrows; @@ -42,7 +41,21 @@ /** */ -public class LexerTest { +class LexerTest { + + private static void assertContent(final String expectedContent, final Token actualToken) { + assertEquals(expectedContent, actualToken.content.toString()); + } + + private static void assertNextToken(final String expectedContent, final Lexer lexer) throws IOException { + assertContent(expectedContent, lexer.nextToken(new Token())); + } + + private static void assertNextToken(final Token.Type expectedType, final String expectedContent, final Lexer lexer) throws IOException { + final Token actualToken = lexer.nextToken(new Token()); + assertEquals(expectedType, actualToken.type); + assertContent(expectedContent, actualToken); + } private CSVFormat formatWithEscaping; @@ -58,78 +71,85 @@ public void setUp() { // simple token with escaping enabled @Test - public void testBackslashWithEscaping() throws IOException { + void testBackslashWithEscaping() throws IOException { /* * file: a,\,,b \,, */ final String code = "a,\\,,b\\\\\n\\,,\\\nc,d\\\r\ne"; final CSVFormat format = formatWithEscaping.withIgnoreEmptyLines(false); assertTrue(format.isEscapeCharacterSet()); - try (final Lexer parser = createLexer(code, format)) { - assertThat(parser.nextToken(new Token()), matches(TOKEN, "a")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, ",")); - assertThat(parser.nextToken(new Token()), matches(EORECORD, "b\\")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, ",")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "\nc")); - assertThat(parser.nextToken(new Token()), matches(EORECORD, "d\r")); - assertThat(parser.nextToken(new Token()), matches(EOF, "e")); + try (Lexer lexer = createLexer(code, format)) { + assertNextToken(TOKEN, "a", lexer); + assertNextToken(TOKEN, ",", lexer); + assertNextToken(EORECORD, "b\\", lexer); + assertNextToken(TOKEN, ",", lexer); + assertNextToken(TOKEN, "\nc", lexer); + assertNextToken(EORECORD, "d\r", lexer); + assertNextToken(EOF, "e", lexer); } } // simple token with escaping not enabled @Test - public void testBackslashWithoutEscaping() throws IOException { + void testBackslashWithoutEscaping() throws IOException { /* * file: a,\,,b \,, */ final String code = "a,\\,,b\\\n\\,,"; final CSVFormat format = CSVFormat.DEFAULT; assertFalse(format.isEscapeCharacterSet()); - try (final Lexer parser = createLexer(code, format)) { - assertThat(parser.nextToken(new Token()), matches(TOKEN, "a")); + try (Lexer lexer = createLexer(code, format)) { + // parser.nextToken(new Token()) + assertNextToken(TOKEN, "a", lexer); // an unquoted single backslash is not an escape char - assertThat(parser.nextToken(new Token()), matches(TOKEN, "\\")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "")); - assertThat(parser.nextToken(new Token()), matches(EORECORD, "b\\")); + assertNextToken(TOKEN, "\\", lexer); + assertNextToken(TOKEN, "", lexer); + assertNextToken(EORECORD, "b\\", lexer); // an unquoted single backslash is not an escape char - assertThat(parser.nextToken(new Token()), matches(TOKEN, "\\")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "")); - assertThat(parser.nextToken(new Token()), matches(EOF, "")); + assertNextToken(TOKEN, "\\", lexer); + assertNextToken(TOKEN, "", lexer); + assertNextToken(EOF, "", lexer); } } @Test - public void testBackspace() throws Exception { - try (final Lexer lexer = createLexer("character" + BACKSPACE + "NotEscaped", formatWithEscaping)) { - assertThat(lexer.nextToken(new Token()), hasContent("character" + BACKSPACE + "NotEscaped")); + void testBackspace() throws Exception { + try (Lexer lexer = createLexer("character" + BACKSPACE + "NotEscaped", formatWithEscaping)) { + assertNextToken("character" + BACKSPACE + "NotEscaped", lexer); } } @Test - public void testComments() throws IOException { - final String code = "first,line,\n" + "second,line,tokenWith#no-comment\n" + "# comment line \n" + - "third,line,#no-comment\n" + "# penultimate comment\n" + "# Final comment\n"; + void testComments() throws IOException { + // @formatter:off + final String code = "first,line,\n" + + "second,line,tokenWith#no-comment\n" + + "# comment line \n" + + "third,line,#no-comment\n" + + "# penultimate comment\n" + + "# Final comment\n"; + // @formatter:on final CSVFormat format = CSVFormat.DEFAULT.withCommentMarker('#'); - try (final Lexer parser = createLexer(code, format)) { - assertThat(parser.nextToken(new Token()), matches(TOKEN, "first")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "line")); - assertThat(parser.nextToken(new Token()), matches(EORECORD, "")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "second")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "line")); - assertThat(parser.nextToken(new Token()), matches(EORECORD, "tokenWith#no-comment")); - assertThat(parser.nextToken(new Token()), matches(COMMENT, "comment line")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "third")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "line")); - assertThat(parser.nextToken(new Token()), matches(EORECORD, "#no-comment")); - assertThat(parser.nextToken(new Token()), matches(COMMENT, "penultimate comment")); - assertThat(parser.nextToken(new Token()), matches(COMMENT, "Final comment")); - assertThat(parser.nextToken(new Token()), matches(EOF, "")); - assertThat(parser.nextToken(new Token()), matches(EOF, "")); - } - } - - @Test - public void testCommentsAndEmptyLines() throws IOException { + try (Lexer lexer = createLexer(code, format)) { + assertNextToken(TOKEN, "first", lexer); + assertNextToken(TOKEN, "line", lexer); + assertNextToken(EORECORD, "", lexer); + assertNextToken(TOKEN, "second", lexer); + assertNextToken(TOKEN, "line", lexer); + assertNextToken(EORECORD, "tokenWith#no-comment", lexer); + assertNextToken(COMMENT, "comment line", lexer); + assertNextToken(TOKEN, "third", lexer); + assertNextToken(TOKEN, "line", lexer); + assertNextToken(EORECORD, "#no-comment", lexer); + assertNextToken(COMMENT, "penultimate comment", lexer); + assertNextToken(COMMENT, "Final comment", lexer); + assertNextToken(EOF, "", lexer); + assertNextToken(EOF, "", lexer); + } + } + + @Test + void testCommentsAndEmptyLines() throws IOException { final String code = "1,2,3,\n" + // 1 "\n" + // 1b "\n" + // 1c @@ -147,314 +167,384 @@ public void testCommentsAndEmptyLines() throws IOException { final CSVFormat format = CSVFormat.DEFAULT.withCommentMarker('#').withIgnoreEmptyLines(false); assertFalse(format.getIgnoreEmptyLines(), "Should not ignore empty lines"); - try (final Lexer parser = createLexer(code, format)) { - assertThat(parser.nextToken(new Token()), matches(TOKEN, "1")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "2")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "3")); - assertThat(parser.nextToken(new Token()), matches(EORECORD, "")); // 1 - assertThat(parser.nextToken(new Token()), matches(EORECORD, "")); // 1b - assertThat(parser.nextToken(new Token()), matches(EORECORD, "")); // 1c - assertThat(parser.nextToken(new Token()), matches(TOKEN, "a")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "b x")); - assertThat(parser.nextToken(new Token()), matches(EORECORD, "c#no-comment")); // 2 - assertThat(parser.nextToken(new Token()), matches(COMMENT, "foo")); // 3 - assertThat(parser.nextToken(new Token()), matches(EORECORD, "")); // 4 - assertThat(parser.nextToken(new Token()), matches(EORECORD, "")); // 4b - assertThat(parser.nextToken(new Token()), matches(TOKEN, "d")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "e")); - assertThat(parser.nextToken(new Token()), matches(EORECORD, "#no-comment")); // 5 - assertThat(parser.nextToken(new Token()), matches(EORECORD, "")); // 5b - assertThat(parser.nextToken(new Token()), matches(EORECORD, "")); // 5c - assertThat(parser.nextToken(new Token()), matches(COMMENT, "penultimate comment")); // 6 - assertThat(parser.nextToken(new Token()), matches(EORECORD, "")); // 6b - assertThat(parser.nextToken(new Token()), matches(EORECORD, "")); // 6c - assertThat(parser.nextToken(new Token()), matches(COMMENT, "Final comment")); // 7 - assertThat(parser.nextToken(new Token()), matches(EOF, "")); - assertThat(parser.nextToken(new Token()), matches(EOF, "")); - } - } - - @Test - public void testCR() throws Exception { - try (final Lexer lexer = createLexer("character" + CR + "NotEscaped", formatWithEscaping)) { - assertThat(lexer.nextToken(new Token()), hasContent("character")); - assertThat(lexer.nextToken(new Token()), hasContent("NotEscaped")); + try (Lexer lexer = createLexer(code, format)) { + assertNextToken(TOKEN, "1", lexer); + assertNextToken(TOKEN, "2", lexer); + assertNextToken(TOKEN, "3", lexer); + assertNextToken(EORECORD, "", lexer); // 1 + assertNextToken(EORECORD, "", lexer); // 1b + assertNextToken(EORECORD, "", lexer); // 1c + assertNextToken(TOKEN, "a", lexer); + assertNextToken(TOKEN, "b x", lexer); + assertNextToken(EORECORD, "c#no-comment", lexer); // 2 + assertNextToken(COMMENT, "foo", lexer); // 3 + assertNextToken(EORECORD, "", lexer); // 4 + assertNextToken(EORECORD, "", lexer); // 4b + assertNextToken(TOKEN, "d", lexer); + assertNextToken(TOKEN, "e", lexer); + assertNextToken(EORECORD, "#no-comment", lexer); // 5 + assertNextToken(EORECORD, "", lexer); // 5b + assertNextToken(EORECORD, "", lexer); // 5c + assertNextToken(COMMENT, "penultimate comment", lexer); // 6 + assertNextToken(EORECORD, "", lexer); // 6b + assertNextToken(EORECORD, "", lexer); // 6c + assertNextToken(COMMENT, "Final comment", lexer); // 7 + assertNextToken(EOF, "", lexer); + assertNextToken(EOF, "", lexer); + } + } + + @Test + void testCR() throws Exception { + try (Lexer lexer = createLexer("character" + CR + "NotEscaped", formatWithEscaping)) { + assertNextToken("character", lexer); + assertNextToken("NotEscaped", lexer); } } // From CSV-1 @Test - public void testDelimiterIsWhitespace() throws IOException { + void testDelimiterIsWhitespace() throws IOException { final String code = "one\ttwo\t\tfour \t five\t six"; - try (final Lexer parser = createLexer(code, CSVFormat.TDF)) { - assertThat(parser.nextToken(new Token()), matches(TOKEN, "one")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "two")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "four")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "five")); - assertThat(parser.nextToken(new Token()), matches(EOF, "six")); + try (Lexer lexer = createLexer(code, CSVFormat.TDF)) { + assertNextToken(TOKEN, "one", lexer); + assertNextToken(TOKEN, "two", lexer); + assertNextToken(TOKEN, "", lexer); + assertNextToken(TOKEN, "four", lexer); + assertNextToken(TOKEN, "five", lexer); + assertNextToken(EOF, "six", lexer); } } + /** + * With {@code ignoreSurroundingSpaces} enabled and a multi-character delimiter whose first character is whitespace, + * the side-effecting {@link Lexer#isDelimiter(int)} must only be evaluated once per character, otherwise the + * delimiter is consumed in the whitespace-skip loop and the empty field at the boundary is dropped. + */ @Test - public void testEOFWithoutClosingQuote() throws Exception { + void testEmptyTokenBeforeWhitespacePrefixedMultiCharacterDelimiter() throws IOException { + final CSVFormat format = CSVFormat.DEFAULT.builder().setDelimiter(" |").setIgnoreSurroundingSpaces(true).get(); + try (Lexer lexer = createLexer(" |a", format)) { + assertNextToken(TOKEN, "", lexer); + assertNextToken(EOF, "a", lexer); + } + try (Lexer lexer = createLexer("a | |b", format)) { + assertNextToken(TOKEN, "a", lexer); + assertNextToken(TOKEN, "", lexer); + assertNextToken(EOF, "b", lexer); + } + } + + @Test + void testEOFWithoutClosingQuote() throws Exception { final String code = "a,\"b"; - try (final Lexer parser = createLexer(code, CSVFormat.Builder.create().setLenientEof(true).get())) { - assertThat(parser.nextToken(new Token()), matches(TOKEN, "a")); - assertThat(parser.nextToken(new Token()), matches(EOF, "b")); + try (Lexer lexer = createLexer(code, CSVFormat.Builder.create().setLenientEof(true).get())) { + assertNextToken(TOKEN, "a", lexer); + assertNextToken(EOF, "b", lexer); } - try (final Lexer parser = createLexer(code, CSVFormat.Builder.create().setLenientEof(false).get())) { - assertThat(parser.nextToken(new Token()), matches(TOKEN, "a")); - assertThrows(IOException.class, () -> parser.nextToken(new Token())); + try (Lexer lexer = createLexer(code, CSVFormat.Builder.create().setLenientEof(false).get())) { + assertNextToken(TOKEN, "a", lexer); + assertThrows(IOException.class, () -> lexer.nextToken(new Token())); } } @Test // TODO is this correct? Do we expect BACKSPACE to be unescaped? - public void testEscapedBackspace() throws Exception { - try (final Lexer lexer = createLexer("character\\" + BACKSPACE + "Escaped", formatWithEscaping)) { - assertThat(lexer.nextToken(new Token()), hasContent("character" + BACKSPACE + "Escaped")); + void testEscapedBackspace() throws Exception { + try (Lexer lexer = createLexer("character\\" + BACKSPACE + "Escaped", formatWithEscaping)) { + assertNextToken("character" + BACKSPACE + "Escaped", lexer); } } @Test - public void testEscapedCharacter() throws Exception { - try (final Lexer lexer = createLexer("character\\aEscaped", formatWithEscaping)) { - assertThat(lexer.nextToken(new Token()), hasContent("character\\aEscaped")); + void testEscapedCharacter() throws Exception { + try (Lexer lexer = createLexer("character\\aEscaped", formatWithEscaping)) { + assertNextToken("character\\aEscaped", lexer); } } @Test - public void testEscapedControlCharacter() throws Exception { + void testEscapedControlCharacter() throws Exception { // we are explicitly using an escape different from \ here - try (final Lexer lexer = createLexer("character!rEscaped", CSVFormat.DEFAULT.withEscape('!'))) { - assertThat(lexer.nextToken(new Token()), hasContent("character" + CR + "Escaped")); + try (Lexer lexer = createLexer("character!rEscaped", CSVFormat.DEFAULT.withEscape('!'))) { + assertNextToken("character" + CR + "Escaped", lexer); } } @Test - public void testEscapedControlCharacter2() throws Exception { - try (final Lexer lexer = createLexer("character\\rEscaped", CSVFormat.DEFAULT.withEscape('\\'))) { - assertThat(lexer.nextToken(new Token()), hasContent("character" + CR + "Escaped")); + void testEscapedControlCharacter2() throws Exception { + try (Lexer lexer = createLexer("character\\rEscaped", CSVFormat.DEFAULT.withEscape('\\'))) { + assertNextToken("character" + CR + "Escaped", lexer); } } @Test - public void testEscapedCR() throws Exception { - try (final Lexer lexer = createLexer("character\\" + CR + "Escaped", formatWithEscaping)) { - assertThat(lexer.nextToken(new Token()), hasContent("character" + CR + "Escaped")); + void testEscapedCR() throws Exception { + try (Lexer lexer = createLexer("character\\" + CR + "Escaped", formatWithEscaping)) { + assertNextToken("character" + CR + "Escaped", lexer); } } @Test // TODO is this correct? Do we expect FF to be unescaped? - public void testEscapedFF() throws Exception { - try (final Lexer lexer = createLexer("character\\" + FF + "Escaped", formatWithEscaping)) { - assertThat(lexer.nextToken(new Token()), hasContent("character" + FF + "Escaped")); + void testEscapedFF() throws Exception { + try (Lexer lexer = createLexer("character\\" + FF + "Escaped", formatWithEscaping)) { + assertNextToken("character" + FF + "Escaped", lexer); } } @Test - public void testEscapedLF() throws Exception { - try (final Lexer lexer = createLexer("character\\" + LF + "Escaped", formatWithEscaping)) { - assertThat(lexer.nextToken(new Token()), hasContent("character" + LF + "Escaped")); + void testEscapedLF() throws Exception { + try (Lexer lexer = createLexer("character\\" + LF + "Escaped", formatWithEscaping)) { + assertNextToken("character" + LF + "Escaped", lexer); } } @Test - public void testEscapedMySqlNullValue() throws Exception { + void testEscapedMySqlNullValue() throws Exception { // MySQL uses \N to symbolize null values. We have to restore this - try (final Lexer lexer = createLexer("character\\NEscaped", formatWithEscaping)) { - assertThat(lexer.nextToken(new Token()), hasContent("character\\NEscaped")); + try (Lexer lexer = createLexer("character\\NEscaped", formatWithEscaping)) { + assertNextToken("character\\NEscaped", lexer); } } @Test // TODO is this correct? Do we expect TAB to be unescaped? - public void testEscapedTab() throws Exception { - try (final Lexer lexer = createLexer("character\\" + TAB + "Escaped", formatWithEscaping)) { - assertThat(lexer.nextToken(new Token()), hasContent("character" + TAB + "Escaped")); + void testEscapedTab() throws Exception { + try (Lexer lexer = createLexer("character\\" + TAB + "Escaped", formatWithEscaping)) { + assertNextToken("character" + TAB + "Escaped", lexer); } } @Test - public void testEscapingAtEOF() throws Exception { + void testEscapingAtEOF() throws Exception { final String code = "escaping at EOF is evil\\"; - try (final Lexer lexer = createLexer(code, formatWithEscaping)) { + try (Lexer lexer = createLexer(code, formatWithEscaping)) { assertThrows(IOException.class, () -> lexer.nextToken(new Token())); } } @Test - public void testFF() throws Exception { - try (final Lexer lexer = createLexer("character" + FF + "NotEscaped", formatWithEscaping)) { - assertThat(lexer.nextToken(new Token()), hasContent("character" + FF + "NotEscaped")); + void testFF() throws Exception { + try (Lexer lexer = createLexer("character" + FF + "NotEscaped", formatWithEscaping)) { + assertNextToken("character" + FF + "NotEscaped", lexer); } } @Test - public void testIgnoreEmptyLines() throws IOException { - final String code = "first,line,\n" + "\n" + "\n" + "second,line\n" + "\n" + "\n" + "third line \n" + "\n" + - "\n" + "last, line \n" + "\n" + "\n" + "\n"; + void testIgnoreEmptyLines() throws IOException { + // @formatter:off + final String code = "first,line,\n" + + "\n" + + "\n" + + "second,line\n" + + "\n" + + "\n" + + "third line \n" + + "\n" + + "\n" + + "last, line \n" + + "\n" + + "\n" + + "\n"; + // @formatter:on final CSVFormat format = CSVFormat.DEFAULT.withIgnoreEmptyLines(); - try (final Lexer parser = createLexer(code, format)) { - assertThat(parser.nextToken(new Token()), matches(TOKEN, "first")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "line")); - assertThat(parser.nextToken(new Token()), matches(EORECORD, "")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "second")); - assertThat(parser.nextToken(new Token()), matches(EORECORD, "line")); - assertThat(parser.nextToken(new Token()), matches(EORECORD, "third line ")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "last")); - assertThat(parser.nextToken(new Token()), matches(EORECORD, " line ")); - assertThat(parser.nextToken(new Token()), matches(EOF, "")); - assertThat(parser.nextToken(new Token()), matches(EOF, "")); + try (Lexer lexer = createLexer(code, format)) { + assertNextToken(TOKEN, "first", lexer); + assertNextToken(TOKEN, "line", lexer); + assertNextToken(EORECORD, "", lexer); + assertNextToken(TOKEN, "second", lexer); + assertNextToken(EORECORD, "line", lexer); + assertNextToken(EORECORD, "third line ", lexer); + assertNextToken(TOKEN, "last", lexer); + assertNextToken(EORECORD, " line ", lexer); + assertNextToken(EOF, "", lexer); + assertNextToken(EOF, "", lexer); } } @Test - public void testIsMetaCharCommentStart() throws IOException { - try (final Lexer lexer = createLexer("#", CSVFormat.DEFAULT.withCommentMarker('#'))) { + void testIsMetaCharCommentStart() throws IOException { + try (Lexer lexer = createLexer("#", CSVFormat.DEFAULT.withCommentMarker('#'))) { final int ch = lexer.readEscape(); assertEquals('#', ch); } } @Test - public void testLF() throws Exception { - try (final Lexer lexer = createLexer("character" + LF + "NotEscaped", formatWithEscaping)) { - assertThat(lexer.nextToken(new Token()), hasContent("character")); - assertThat(lexer.nextToken(new Token()), hasContent("NotEscaped")); + void testLF() throws Exception { + try (Lexer lexer = createLexer("character" + LF + "NotEscaped", formatWithEscaping)) { + assertNextToken("character", lexer); + assertNextToken("NotEscaped", lexer); } } // encapsulator tokenizer (single line) @Test - public void testNextToken4() throws IOException { + void testNextToken4() throws IOException { /* * file: a,"foo",b a, " foo",b a,"foo " ,b // whitespace after closing encapsulator a, " foo " ,b */ final String code = "a,\"foo\",b\na, \" foo\",b\na,\"foo \" ,b\na, \" foo \" ,b"; - try (final Lexer parser = createLexer(code, CSVFormat.DEFAULT.withIgnoreSurroundingSpaces())) { - assertThat(parser.nextToken(new Token()), matches(TOKEN, "a")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "foo")); - assertThat(parser.nextToken(new Token()), matches(EORECORD, "b")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "a")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, " foo")); - assertThat(parser.nextToken(new Token()), matches(EORECORD, "b")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "a")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "foo ")); - assertThat(parser.nextToken(new Token()), matches(EORECORD, "b")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "a")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, " foo ")); - // assertTokenEquals(EORECORD, "b", parser.nextToken(new Token())); - assertThat(parser.nextToken(new Token()), matches(EOF, "b")); + try (Lexer lexer = createLexer(code, CSVFormat.DEFAULT.withIgnoreSurroundingSpaces())) { + assertNextToken(TOKEN, "a", lexer); + assertNextToken(TOKEN, "foo", lexer); + assertNextToken(EORECORD, "b", lexer); + assertNextToken(TOKEN, "a", lexer); + assertNextToken(TOKEN, " foo", lexer); + assertNextToken(EORECORD, "b", lexer); + assertNextToken(TOKEN, "a", lexer); + assertNextToken(TOKEN, "foo ", lexer); + assertNextToken(EORECORD, "b", lexer); + assertNextToken(TOKEN, "a", lexer); + assertNextToken(TOKEN, " foo ", lexer); + // assertTokenEquals(EORECORD, "b", parser); + assertNextToken(EOF, "b", lexer); } } // encapsulator tokenizer (multi line, delimiter in string) @Test - public void testNextToken5() throws IOException { + void testNextToken5() throws IOException { final String code = "a,\"foo\n\",b\n\"foo\n baar ,,,\"\n\"\n\t \n\""; - try (final Lexer parser = createLexer(code, CSVFormat.DEFAULT)) { - assertThat(parser.nextToken(new Token()), matches(TOKEN, "a")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "foo\n")); - assertThat(parser.nextToken(new Token()), matches(EORECORD, "b")); - assertThat(parser.nextToken(new Token()), matches(EORECORD, "foo\n baar ,,,")); - assertThat(parser.nextToken(new Token()), matches(EOF, "\n\t \n")); + try (Lexer lexer = createLexer(code, CSVFormat.DEFAULT)) { + assertNextToken(TOKEN, "a", lexer); + assertNextToken(TOKEN, "foo\n", lexer); + assertNextToken(EORECORD, "b", lexer); + assertNextToken(EORECORD, "foo\n baar ,,,", lexer); + assertNextToken(EOF, "\n\t \n", lexer); } } // change delimiters, comment, encapsulater @Test - public void testNextToken6() throws IOException { + void testNextToken6() throws IOException { /* * file: a;'b and \' more ' !comment;;;; ;; */ final String code = "a;'b and '' more\n'\n!comment;;;;\n;;"; final CSVFormat format = CSVFormat.DEFAULT.withQuote('\'').withCommentMarker('!').withDelimiter(';'); - try (final Lexer parser = createLexer(code, format)) { - assertThat(parser.nextToken(new Token()), matches(TOKEN, "a")); - assertThat(parser.nextToken(new Token()), matches(EORECORD, "b and ' more\n")); + try (Lexer lexer = createLexer(code, format)) { + assertNextToken(TOKEN, "a", lexer); + assertNextToken(EORECORD, "b and ' more\n", lexer); + } + } + + /** + * A truncated escaped multi-character delimiter at EOF must not be accepted by reusing the previous escape delimiter + * look-ahead in {@link Lexer#isEscapeDelimiter()}. + */ + @Test + void testPartialEscapedMultiCharacterDelimiterAtEOF() throws IOException { + final CSVFormat format = CSVFormat.DEFAULT.builder().setDelimiter("[|]").setEscape('!').get(); + try (Lexer lexer = createLexer("x![!|!]y![!|", format)) { + assertNextToken(EOF, "x[|]y![!|", lexer); + } + } + + /** + * Tests CSV-324. + */ + @Test + void testPartialMultiCharacterDelimiterAtEOF() throws IOException { + final CSVFormat format = CSVFormat.DEFAULT.builder().setDelimiter("[|]").get(); + try (Lexer lexer = createLexer("a[|]b[|", format)) { + assertNextToken(TOKEN, "a", lexer); + assertNextToken(EOF, "b[|", lexer); + } + } + + /** + * A truncated multi-character delimiter at EOF must not be accepted by reusing the look-ahead buffer left dirty by an + * earlier non-matching peek in the same token (CSV-324 only cleared the buffer once per token). + */ + @Test + void testPartialMultiCharacterDelimiterAtEOFAfterMismatch() throws IOException { + final CSVFormat format = CSVFormat.DEFAULT.builder().setDelimiter("[|]").get(); + // The "[a]" peek leaves ']' in the look-ahead buffer; the trailing "[|" must not match "[|]". + final String recordString = "x[a][|"; + try (Lexer lexer = createLexer(recordString, format)) { + assertNextToken(EOF, recordString, lexer); } } @Test - public void testReadEscapeBackspace() throws IOException { - try (final Lexer lexer = createLexer("b", CSVFormat.DEFAULT.withEscape('\b'))) { + void testReadEscapeBackspace() throws IOException { + try (Lexer lexer = createLexer("b", CSVFormat.DEFAULT.withEscape('\b'))) { final int ch = lexer.readEscape(); assertEquals(BACKSPACE, ch); } } @Test - public void testReadEscapeFF() throws IOException { - try (final Lexer lexer = createLexer("f", CSVFormat.DEFAULT.withEscape('\f'))) { + void testReadEscapeFF() throws IOException { + try (Lexer lexer = createLexer("f", CSVFormat.DEFAULT.withEscape('\f'))) { final int ch = lexer.readEscape(); assertEquals(FF, ch); } } @Test - public void testReadEscapeTab() throws IOException { - try (final Lexer lexer = createLexer("t", CSVFormat.DEFAULT.withEscape('\t'))) { + void testReadEscapeTab() throws IOException { + try (Lexer lexer = createLexer("t", CSVFormat.DEFAULT.withEscape('\t'))) { final int ch = lexer.readEscape(); - assertThat(lexer.nextToken(new Token()), matches(EOF, "")); + assertNextToken(EOF, "", lexer); assertEquals(TAB, ch); } } @Test - public void testSurroundingSpacesAreDeleted() throws IOException { + void testSurroundingSpacesAreDeleted() throws IOException { final String code = "noSpaces, leadingSpaces,trailingSpaces , surroundingSpaces , ,,"; - try (final Lexer parser = createLexer(code, CSVFormat.DEFAULT.withIgnoreSurroundingSpaces())) { - assertThat(parser.nextToken(new Token()), matches(TOKEN, "noSpaces")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "leadingSpaces")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "trailingSpaces")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "surroundingSpaces")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "")); - assertThat(parser.nextToken(new Token()), matches(EOF, "")); + try (Lexer lexer = createLexer(code, CSVFormat.DEFAULT.withIgnoreSurroundingSpaces())) { + assertNextToken(TOKEN, "noSpaces", lexer); + assertNextToken(TOKEN, "leadingSpaces", lexer); + assertNextToken(TOKEN, "trailingSpaces", lexer); + assertNextToken(TOKEN, "surroundingSpaces", lexer); + assertNextToken(TOKEN, "", lexer); + assertNextToken(TOKEN, "", lexer); + assertNextToken(EOF, "", lexer); } } @Test - public void testSurroundingTabsAreDeleted() throws IOException { + void testSurroundingTabsAreDeleted() throws IOException { final String code = "noTabs,\tleadingTab,trailingTab\t,\tsurroundingTabs\t,\t\t,,"; - try (final Lexer parser = createLexer(code, CSVFormat.DEFAULT.withIgnoreSurroundingSpaces())) { - assertThat(parser.nextToken(new Token()), matches(TOKEN, "noTabs")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "leadingTab")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "trailingTab")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "surroundingTabs")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "")); - assertThat(parser.nextToken(new Token()), matches(EOF, "")); + try (Lexer lexer = createLexer(code, CSVFormat.DEFAULT.withIgnoreSurroundingSpaces())) { + assertNextToken(TOKEN, "noTabs", lexer); + assertNextToken(TOKEN, "leadingTab", lexer); + assertNextToken(TOKEN, "trailingTab", lexer); + assertNextToken(TOKEN, "surroundingTabs", lexer); + assertNextToken(TOKEN, "", lexer); + assertNextToken(TOKEN, "", lexer); + assertNextToken(EOF, "", lexer); } } @Test - public void testTab() throws Exception { - try (final Lexer lexer = createLexer("character" + TAB + "NotEscaped", formatWithEscaping)) { - assertThat(lexer.nextToken(new Token()), hasContent("character" + TAB + "NotEscaped")); + void testTab() throws Exception { + try (Lexer lexer = createLexer("character" + TAB + "NotEscaped", formatWithEscaping)) { + assertNextToken("character" + TAB + "NotEscaped", lexer); } } @Test - public void testTrailingTextAfterQuote() throws Exception { + void testTrailingTextAfterQuote() throws Exception { final String code = "\"a\" b,\"a\" \" b,\"a\" b \"\""; - try (final Lexer parser = createLexer(code, CSVFormat.Builder.create().setTrailingData(true).get())) { - assertThat(parser.nextToken(new Token()), matches(TOKEN, "a b")); - assertThat(parser.nextToken(new Token()), matches(TOKEN, "a \" b")); - assertThat(parser.nextToken(new Token()), matches(EOF, "a b \"\"")); + try (Lexer lexer = createLexer(code, CSVFormat.Builder.create().setTrailingData(true).get())) { + assertNextToken(TOKEN, "a b", lexer); + assertNextToken(TOKEN, "a \" b", lexer); + assertNextToken(EOF, "a b \"\"", lexer); } - try (final Lexer parser = createLexer(code, CSVFormat.Builder.create().setTrailingData(false).get())) { + try (Lexer parser = createLexer(code, CSVFormat.Builder.create().setTrailingData(false).get())) { assertThrows(IOException.class, () -> parser.nextToken(new Token())); } } @Test - public void testTrimTrailingSpacesZeroLength() throws Exception { + void testTrimTrailingSpacesZeroLength() throws Exception { final StringBuilder buffer = new StringBuilder(""); try (Lexer lexer = createLexer(buffer.toString(), CSVFormat.DEFAULT)) { lexer.trimTrailingSpaces(buffer); - assertThat(lexer.nextToken(new Token()), matches(EOF, "")); + assertNextToken(EOF, "", lexer); } } } diff --git a/src/test/java/org/apache/commons/csv/PerformanceTest.java b/src/test/java/org/apache/commons/csv/PerformanceTest.java index 8523a9a66e..9284828e6c 100644 --- a/src/test/java/org/apache/commons/csv/PerformanceTest.java +++ b/src/test/java/org/apache/commons/csv/PerformanceTest.java @@ -1,343 +1,345 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.apache.commons.csv; - -import static org.apache.commons.io.IOUtils.EOF; - -import java.io.BufferedReader; -import java.io.File; -import java.io.FileInputStream; -import java.io.FileOutputStream; -import java.io.IOException; -import java.io.InputStream; -import java.io.InputStreamReader; -import java.io.OutputStream; -import java.io.Reader; -import java.lang.reflect.Constructor; -import java.lang.reflect.InvocationTargetException; -import java.nio.charset.StandardCharsets; -import java.nio.file.Files; -import java.nio.file.Paths; -import java.util.zip.GZIPInputStream; - -import org.apache.commons.io.FileUtils; -import org.apache.commons.io.IOUtils; - -/** - * Basic test harness. - */ -@SuppressWarnings("boxing") -public class PerformanceTest { - - @FunctionalInterface - private interface CSVParserFactory { - CSVParser createParser() throws IOException; - } - - // Container for basic statistics - private static final class Stats { - final int count; - final int fields; - - Stats(final int c, final int f) { - count = c; - fields = f; - } - } - - private static final String[] PROPERTY_NAMES = { "java.version", // Java Runtime Environment version - "java.vendor", // Java Runtime Environment vendor -// "java.vm.specification.version", // Java Virtual Machine specification version -// "java.vm.specification.vendor", // Java Virtual Machine specification vendor -// "java.vm.specification.name", // Java Virtual Machine specification name - "java.vm.version", // Java Virtual Machine implementation version -// "java.vm.vendor", // Java Virtual Machine implementation vendor - "java.vm.name", // Java Virtual Machine implementation name -// "java.specification.version", // Java Runtime Environment specification version -// "java.specification.vendor", // Java Runtime Environment specification vendor -// "java.specification.name", // Java Runtime Environment specification name - - "os.name", // Operating system name - "os.arch", // Operating system architecture - "os.version", // Operating system version - }; - private static int max = 11; // skip first test - - private static int num; // number of elapsed times recorded - - private static final long[] ELAPSED_TIMES = new long[max]; - private static final CSVFormat format = CSVFormat.EXCEL; - - private static final String TEST_RESRC = "org/apache/commons/csv/perf/worldcitiespop.txt.gz"; - - private static final File BIG_FILE = new File(FileUtils.getTempDirectoryPath(), "worldcitiespop.txt"); - - private static Reader createReader() throws IOException { - return new InputStreamReader(new FileInputStream(BIG_FILE), StandardCharsets.ISO_8859_1); - } - - private static Lexer createTestCSVLexer(final String test, final ExtendedBufferedReader input) - throws InstantiationException, IllegalAccessException, InvocationTargetException, Exception { - return test.startsWith("CSVLexer") ? getLexerCtor(test).newInstance(format, input) : new Lexer(format, input); - } - - private static Constructor getLexerCtor(final String clazz) throws Exception { - @SuppressWarnings("unchecked") - final Class lexer = (Class) Class.forName("org.apache.commons.csv." + clazz); - return lexer.getConstructor(CSVFormat.class, ExtendedBufferedReader.class); - } - - private static Stats iterate(final Iterable iterable) { - int count = 0; - int fields = 0; - for (final CSVRecord record : iterable) { - count++; - fields += record.size(); - } - return new Stats(count, fields); - } - - public static void main(final String[] args) throws Exception { - if (BIG_FILE.exists()) { - System.out.printf("Found test fixture %s: %,d bytes.%n", BIG_FILE, BIG_FILE.length()); - } else { - System.out.println("Decompressing test fixture to: " + BIG_FILE + "..."); - try (final InputStream input = new GZIPInputStream(PerformanceTest.class.getClassLoader().getResourceAsStream(TEST_RESRC)); - final OutputStream output = new FileOutputStream(BIG_FILE)) { - IOUtils.copy(input, output); - System.out.println(String.format("Decompressed test fixture %s: %,d bytes.", BIG_FILE, BIG_FILE.length())); - } - } - final int argc = args.length; - if (argc > 0) { - max = Integer.parseInt(args[0]); - } - - final String[] tests; - if (argc > 1) { - tests = new String[argc - 1]; - System.arraycopy(args, 1, tests, 0, argc - 1); - } else { - tests = new String[] { "file", "split", "extb", "exts", "csv", "csv-path", "csv-path-db", "csv-url", "lexreset", "lexnew" }; - } - for (final String p : PROPERTY_NAMES) { - System.out.printf("%s=%s%n", p, System.getProperty(p)); - } - System.out.printf("Max count: %d%n%n", max); - - for (final String test : tests) { - switch (test) { - case "file": - testReadBigFile(false); - break; - case "split": - testReadBigFile(true); - break; - case "csv": - testParseCommonsCSV(); - break; - case "csv-path": - testParsePath(); - break; - case "csv-path-db": - testParsePathDoubleBuffering(); - break; - case "csv-url": - testParseURL(); - break; - case "lexreset": - testCSVLexer(false, test); - break; - case "lexnew": - testCSVLexer(true, test); - break; - default: - if (test.startsWith("CSVLexer")) { - testCSVLexer(false, test); - } else if ("extb".equals(test)) { - testExtendedBuffer(false); - } else if ("exts".equals(test)) { - testExtendedBuffer(true); - } else { - System.out.printf("Invalid test name: %s%n", test); - } - break; - } - } - } - - private static Stats readAll(final BufferedReader in, final boolean split) throws IOException { - int count = 0; - int fields = 0; - String record; - while ((record = in.readLine()) != null) { - count++; - fields += split ? record.split(",").length : 1; - } - return new Stats(count, fields); - } - - // calculate and show average - private static void show() { - if (num > 1) { - long tot = 0; - for (int i = 1; i < num; i++) { // skip first test - tot += ELAPSED_TIMES[i]; - } - System.out.printf("%-20s: %5dms%n%n", "Average(not first)", tot / (num - 1)); - } - num = 0; // ready for next set - } - - // Display end stats; store elapsed for average - private static void show(final String msg, final Stats s, final long start) { - final long elapsed = System.currentTimeMillis() - start; - System.out.printf("%-20s: %5dms %d lines %d fields%n", msg, elapsed, s.count, s.fields); - ELAPSED_TIMES[num] = elapsed; - num++; - } - - private static void testCSVLexer(final boolean newToken, final String test) throws Exception { - Token token = new Token(); - String dynamic = ""; - for (int i = 0; i < max; i++) { - final String simpleName; - final Stats stats; - final long startMillis; - try (final ExtendedBufferedReader input = new ExtendedBufferedReader(createReader()); - final Lexer lexer = createTestCSVLexer(test, input)) { - if (test.startsWith("CSVLexer")) { - dynamic = "!"; - } - simpleName = lexer.getClass().getSimpleName(); - int count = 0; - int fields = 0; - startMillis = System.currentTimeMillis(); - do { - if (newToken) { - token = new Token(); - } else { - token.reset(); - } - lexer.nextToken(token); - switch (token.type) { - case EOF: - break; - case EORECORD: - fields++; - count++; - break; - case INVALID: - throw new IOException("invalid parse sequence <" + token.content.toString() + ">"); - case TOKEN: - fields++; - break; - case COMMENT: // not really expecting these - break; - default: - throw new IllegalStateException("Unexpected Token type: " + token.type); - } - } while (!token.type.equals(Token.Type.EOF)); - stats = new Stats(count, fields); - } - show(simpleName + dynamic + " " + (newToken ? "new" : "reset"), stats, startMillis); - } - show(); - } - - private static void testExtendedBuffer(final boolean makeString) throws Exception { - for (int i = 0; i < max; i++) { - int fields = 0; - int lines = 0; - final long startMillis; - try (final ExtendedBufferedReader in = new ExtendedBufferedReader(createReader())) { - startMillis = System.currentTimeMillis(); - int read; - if (makeString) { - StringBuilder sb = new StringBuilder(); - while ((read = in.read()) != EOF) { - sb.append((char) read); - if (read == ',') { // count delimiters - sb.toString(); - sb = new StringBuilder(); - fields++; - } else if (read == '\n') { - sb.toString(); - sb = new StringBuilder(); - lines++; - } - } - } else { - while ((read = in.read()) != EOF) { - if (read == ',') { // count delimiters - fields++; - } else if (read == '\n') { - lines++; - } - } - } - fields += lines; // EOL is a delimiter too - } - show("Extended" + (makeString ? " toString" : ""), new Stats(lines, fields), startMillis); - } - show(); - } - - private static void testParseCommonsCSV() throws Exception { - testParser("CSV", () -> CSVParser.builder().setReader(createReader()).setFormat(format).get()); - } - - private static void testParsePath() throws Exception { - testParser("CSV-PATH", () -> CSVParser.parse(Files.newInputStream(Paths.get(BIG_FILE.toURI())), StandardCharsets.ISO_8859_1, format)); - } - - private static void testParsePathDoubleBuffering() throws Exception { - testParser("CSV-PATH-DB", () -> CSVParser.parse(Files.newBufferedReader(Paths.get(BIG_FILE.toURI()), StandardCharsets.ISO_8859_1), format)); - } - - private static void testParser(final String msg, final CSVParserFactory fac) throws Exception { - for (int i = 0; i < max; i++) { - final long startMillis; - final Stats stats; - try (final CSVParser parser = fac.createParser()) { - startMillis = System.currentTimeMillis(); - stats = iterate(parser); - } - show(msg, stats, startMillis); - } - show(); - } - - private static void testParseURL() throws Exception { - testParser("CSV-URL", () -> CSVParser.parse(BIG_FILE.toURI().toURL(), StandardCharsets.ISO_8859_1, format)); - } - - private static void testReadBigFile(final boolean split) throws Exception { - for (int i = 0; i < max; i++) { - final long startMillis; - final Stats stats; - try (final BufferedReader in = new BufferedReader(createReader())) { - startMillis = System.currentTimeMillis(); - stats = readAll(in, split); - } - show(split ? "file+split" : "file", stats, startMillis); - } - show(); - } -} - +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.commons.csv; + +import static org.apache.commons.io.IOUtils.EOF; + +import java.io.BufferedReader; +import java.io.File; +import java.io.FileInputStream; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.io.OutputStream; +import java.io.Reader; +import java.lang.reflect.Constructor; +import java.lang.reflect.InvocationTargetException; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.util.zip.GZIPInputStream; + +import org.apache.commons.io.FileUtils; +import org.apache.commons.io.IOUtils; + +/** + * Basic test harness. + */ +@SuppressWarnings("boxing") +class PerformanceTest { + + @FunctionalInterface + private interface CSVParserFactory { + CSVParser createParser() throws IOException; + } + + // Container for basic statistics + private static final class Stats { + final int count; + final int fields; + + Stats(final int c, final int f) { + count = c; + fields = f; + } + } + + private static final String[] PROPERTY_NAMES = { "java.version", // Java Runtime Environment version + "java.vendor", // Java Runtime Environment vendor +// "java.vm.specification.version", // Java Virtual Machine specification version +// "java.vm.specification.vendor", // Java Virtual Machine specification vendor +// "java.vm.specification.name", // Java Virtual Machine specification name + "java.vm.version", // Java Virtual Machine implementation version +// "java.vm.vendor", // Java Virtual Machine implementation vendor + "java.vm.name", // Java Virtual Machine implementation name +// "java.specification.version", // Java Runtime Environment specification version +// "java.specification.vendor", // Java Runtime Environment specification vendor +// "java.specification.name", // Java Runtime Environment specification name + + "os.name", // Operating system name + "os.arch", // Operating system architecture + "os.version", // Operating system version + }; + private static int max = 11; // skip first test + + private static int num; // number of elapsed times recorded + + private static final long[] ELAPSED_TIMES = new long[max]; + private static final CSVFormat format = CSVFormat.EXCEL; + + private static final String TEST_RESRC = "org/apache/commons/csv/perf/worldcitiespop.txt.gz"; + + private static final File BIG_FILE = new File(FileUtils.getTempDirectoryPath(), "worldcitiespop.txt"); + + private static Reader createReader() throws IOException { + return new InputStreamReader(new FileInputStream(BIG_FILE), StandardCharsets.ISO_8859_1); + } + + private static Lexer createTestCSVLexer(final String test, final ExtendedBufferedReader input) + throws InstantiationException, IllegalAccessException, InvocationTargetException, Exception { + return test.startsWith("CSVLexer") ? getLexerCtor(test).newInstance(format, input) : new Lexer(format, input); + } + + private static Constructor getLexerCtor(final String clazz) throws Exception { + @SuppressWarnings("unchecked") + final Class lexer = (Class) Class.forName("org.apache.commons.csv." + clazz); + return lexer.getConstructor(CSVFormat.class, ExtendedBufferedReader.class); + } + + private static Stats iterate(final Iterable iterable) { + int count = 0; + int fields = 0; + for (final CSVRecord record : iterable) { + count++; + fields += record.size(); + } + return new Stats(count, fields); + } + + public static void main(final String[] args) throws Exception { + if (BIG_FILE.exists()) { + System.out.printf("Found test fixture %s: %,d bytes.%n", BIG_FILE, BIG_FILE.length()); + } else { + System.out.println("Decompressing test fixture to: " + BIG_FILE + "..."); + try (InputStream input = new GZIPInputStream(PerformanceTest.class.getClassLoader().getResourceAsStream(TEST_RESRC)); + OutputStream output = new FileOutputStream(BIG_FILE)) { + IOUtils.copy(input, output); + System.out.println(String.format("Decompressed test fixture %s: %,d bytes.", BIG_FILE, BIG_FILE.length())); + } + } + final int argc = args.length; + if (argc > 0) { + max = Integer.parseInt(args[0]); + } + + final String[] tests; + if (argc > 1) { + tests = new String[argc - 1]; + System.arraycopy(args, 1, tests, 0, argc - 1); + } else { + tests = new String[] { "file", "split", "extb", "exts", "csv", "csv-path", "csv-path-db", "csv-url", "lexreset", "lexnew" }; + } + for (final String p : PROPERTY_NAMES) { + System.out.printf("%s=%s%n", p, System.getProperty(p)); + } + System.out.printf("Max count: %d%n%n", max); + + for (final String test : tests) { + switch (test) { + case "file": + testReadBigFile(false); + break; + case "split": + testReadBigFile(true); + break; + case "csv": + testParseCommonsCSV(); + break; + case "csv-path": + testParsePath(); + break; + case "csv-path-db": + testParsePathDoubleBuffering(); + break; + case "csv-url": + testParseURL(); + break; + case "lexreset": + testCSVLexer(false, test); + break; + case "lexnew": + testCSVLexer(true, test); + break; + default: + if (test.startsWith("CSVLexer")) { + testCSVLexer(false, test); + } else if ("extb".equals(test)) { + testExtendedBuffer(false); + } else if ("exts".equals(test)) { + testExtendedBuffer(true); + } else { + System.out.printf("Invalid test name: %s%n", test); + } + break; + } + } + } + + private static Stats readAll(final BufferedReader in, final boolean split) throws IOException { + int count = 0; + int fields = 0; + String record; + while ((record = in.readLine()) != null) { + count++; + fields += split ? record.split(",").length : 1; + } + return new Stats(count, fields); + } + + // calculate and show average + private static void show() { + if (num > 1) { + long tot = 0; + for (int i = 1; i < num; i++) { // skip first test + tot += ELAPSED_TIMES[i]; + } + System.out.printf("%-20s: %5dms%n%n", "Average(not first)", tot / (num - 1)); + } + num = 0; // ready for next set + } + + // Display end stats; store elapsed for average + private static void show(final String msg, final Stats s, final long start) { + final long elapsed = System.currentTimeMillis() - start; + System.out.printf("%-20s: %5dms %d lines %d fields%n", msg, elapsed, s.count, s.fields); + ELAPSED_TIMES[num] = elapsed; + num++; + } + + private static void testCSVLexer(final boolean newToken, final String test) throws Exception { + Token token = new Token(); + String dynamic = ""; + for (int i = 0; i < max; i++) { + final String simpleName; + final Stats stats; + final long startMillis; + try (ExtendedBufferedReader input = new ExtendedBufferedReader(createReader()); + Lexer lexer = createTestCSVLexer(test, input)) { + if (test.startsWith("CSVLexer")) { + dynamic = "!"; + } + simpleName = lexer.getClass().getSimpleName(); + int count = 0; + int fields = 0; + startMillis = System.currentTimeMillis(); + do { + if (newToken) { + token = new Token(); + } else { + token.reset(); + } + lexer.nextToken(token); + switch (token.type) { + case EOF: + break; + case EORECORD: + fields++; + count++; + break; + case INVALID: + throw new IOException("invalid parse sequence <" + token.content.toString() + ">"); + case TOKEN: + fields++; + break; + case COMMENT: // not really expecting these + break; + default: + throw new IllegalStateException("Unexpected Token type: " + token.type); + } + } while (!token.type.equals(Token.Type.EOF)); + stats = new Stats(count, fields); + } + show(simpleName + dynamic + " " + (newToken ? "new" : "reset"), stats, startMillis); + } + show(); + } + + private static void testExtendedBuffer(final boolean makeString) throws Exception { + for (int i = 0; i < max; i++) { + int fields = 0; + int lines = 0; + final long startMillis; + try (ExtendedBufferedReader in = new ExtendedBufferedReader(createReader())) { + startMillis = System.currentTimeMillis(); + int read; + if (makeString) { + StringBuilder sb = new StringBuilder(); + while ((read = in.read()) != EOF) { + sb.append((char) read); + if (read == ',') { // count delimiters + sb.toString(); + sb = new StringBuilder(); + fields++; + } else if (read == '\n') { + sb.toString(); + sb = new StringBuilder(); + lines++; + } + } + } else { + while ((read = in.read()) != EOF) { + if (read == ',') { // count delimiters + fields++; + } else if (read == '\n') { + lines++; + } + } + } + fields += lines; // EOL is a delimiter too + } + show("Extended" + (makeString ? " toString" : ""), new Stats(lines, fields), startMillis); + } + show(); + } + + private static void testParseCommonsCSV() throws Exception { + testParser("CSV", () -> CSVParser.builder().setReader(createReader()).setFormat(format).get()); + } + + private static void testParsePath() throws Exception { + testParser("CSV-PATH", () -> CSVParser.parse(Files.newInputStream(Paths.get(BIG_FILE.toURI())), StandardCharsets.ISO_8859_1, format)); + } + + private static void testParsePathDoubleBuffering() throws Exception { + testParser("CSV-PATH-DB", () -> CSVParser.parse(Files.newBufferedReader(Paths.get(BIG_FILE.toURI()), StandardCharsets.ISO_8859_1), format)); + } + + private static void testParser(final String msg, final CSVParserFactory fac) throws Exception { + for (int i = 0; i < max; i++) { + final long startMillis; + final Stats stats; + try (CSVParser parser = fac.createParser()) { + startMillis = System.currentTimeMillis(); + stats = iterate(parser); + } + show(msg, stats, startMillis); + } + show(); + } + + private static void testParseURL() throws Exception { + testParser("CSV-URL", () -> CSVParser.parse(BIG_FILE.toURI().toURL(), StandardCharsets.ISO_8859_1, format)); + } + + private static void testReadBigFile(final boolean split) throws Exception { + for (int i = 0; i < max; i++) { + final long startMillis; + final Stats stats; + try (BufferedReader in = new BufferedReader(createReader())) { + startMillis = System.currentTimeMillis(); + stats = readAll(in, split); + } + show(split ? "file+split" : "file", stats, startMillis); + } + show(); + } +} + diff --git a/src/test/java/org/apache/commons/csv/TokenMatchers.java b/src/test/java/org/apache/commons/csv/TokenMatchers.java deleted file mode 100644 index c081e7eee9..0000000000 --- a/src/test/java/org/apache/commons/csv/TokenMatchers.java +++ /dev/null @@ -1,89 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.csv; - -import static org.hamcrest.core.AllOf.allOf; - -import org.hamcrest.Description; -import org.hamcrest.Matcher; -import org.hamcrest.TypeSafeDiagnosingMatcher; - -/** - * Collection of matchers for asserting the type and content of tokens. - */ -final class TokenMatchers { - - public static Matcher hasContent(final String expectedContent) { - return new TypeSafeDiagnosingMatcher() { - - @Override - public void describeTo(final Description description) { - description.appendText("token has content "); - description.appendValue(expectedContent); - } - - @Override - protected boolean matchesSafely(final Token item, - final Description mismatchDescription) { - mismatchDescription.appendText("token content is "); - mismatchDescription.appendValue(item.content.toString()); - return expectedContent.equals(item.content.toString()); - } - }; - } - - public static Matcher hasType(final Token.Type expectedType) { - return new TypeSafeDiagnosingMatcher() { - - @Override - public void describeTo(final Description description) { - description.appendText("token has type "); - description.appendValue(expectedType); - } - - @Override - protected boolean matchesSafely(final Token item, - final Description mismatchDescription) { - mismatchDescription.appendText("token type is "); - mismatchDescription.appendValue(item.type); - return item.type == expectedType; - } - }; - } - - public static Matcher isReady() { - return new TypeSafeDiagnosingMatcher() { - - @Override - public void describeTo(final Description description) { - description.appendText("token is ready "); - } - - @Override - protected boolean matchesSafely(final Token item, - final Description mismatchDescription) { - mismatchDescription.appendText("token is not ready "); - return item.isReady; - } - }; - } - - public static Matcher matches(final Token.Type expectedType, final String expectedContent) { - return allOf(hasType(expectedType), hasContent(expectedContent)); - } - -} diff --git a/src/test/java/org/apache/commons/csv/TokenMatchersTest.java b/src/test/java/org/apache/commons/csv/TokenMatchersTest.java deleted file mode 100644 index 47c213d7bd..0000000000 --- a/src/test/java/org/apache/commons/csv/TokenMatchersTest.java +++ /dev/null @@ -1,77 +0,0 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.csv; - -import static org.apache.commons.csv.TokenMatchers.hasContent; -import static org.apache.commons.csv.TokenMatchers.hasType; -import static org.apache.commons.csv.TokenMatchers.isReady; -import static org.apache.commons.csv.TokenMatchers.matches; -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertFalse; -import static org.junit.jupiter.api.Assertions.assertTrue; - -import org.junit.jupiter.api.BeforeEach; -import org.junit.jupiter.api.Test; - -public class TokenMatchersTest { - - private Token token; - - @BeforeEach - public void setUp() { - token = new Token(); - token.type = Token.Type.TOKEN; - token.isReady = true; - token.content.append("content"); - } - - @Test - public void testHasContent() { - assertFalse(hasContent("This is not the token's content").matches(token)); - assertTrue(hasContent("content").matches(token)); - } - - @Test - public void testHasType() { - assertFalse(hasType(Token.Type.COMMENT).matches(token)); - assertFalse(hasType(Token.Type.EOF).matches(token)); - assertFalse(hasType(Token.Type.EORECORD).matches(token)); - assertTrue(hasType(Token.Type.TOKEN).matches(token)); - } - - @Test - public void testIsReady() { - assertTrue(isReady().matches(token)); - token.isReady = false; - assertFalse(isReady().matches(token)); - } - - @Test - public void testMatches() { - assertTrue(matches(Token.Type.TOKEN, "content").matches(token)); - assertFalse(matches(Token.Type.EOF, "content").matches(token)); - assertFalse(matches(Token.Type.TOKEN, "not the content").matches(token)); - assertFalse(matches(Token.Type.EORECORD, "not the content").matches(token)); - } - - @Test - public void testToString() { - assertTrue(matches(Token.Type.TOKEN, "content").matches(token)); - assertEquals("TOKEN", token.type.name()); - assertEquals("TOKEN [content]", token.toString()); - } -} diff --git a/src/test/java/org/apache/commons/csv/TokenTest.java b/src/test/java/org/apache/commons/csv/TokenTest.java new file mode 100644 index 0000000000..075c1b1d9c --- /dev/null +++ b/src/test/java/org/apache/commons/csv/TokenTest.java @@ -0,0 +1,50 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.commons.csv; + +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.EnumSource; + +/** + * Tests {@link Token}. + */ +class TokenTest { + + @ParameterizedTest + @EnumSource(Token.Type.class) + void testToString(final Token.Type type) { + // Should never blow up + final Token token = new Token(); + final String resetName = Token.Type.INVALID.name(); + assertTrue(token.toString().contains(resetName)); + token.reset(); + assertTrue(token.toString().contains(resetName)); + token.type = null; + assertFalse(token.toString().isEmpty()); + token.reset(); + token.type = type; + assertTrue(token.toString().contains(type.name())); + token.content.setLength(1000); + assertTrue(token.toString().contains(type.name())); + } +} diff --git a/src/test/java/org/apache/commons/csv/UserGuideTest.java b/src/test/java/org/apache/commons/csv/UserGuideTest.java new file mode 100644 index 0000000000..6cd8c72d7f --- /dev/null +++ b/src/test/java/org/apache/commons/csv/UserGuideTest.java @@ -0,0 +1,94 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.commons.csv; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +import java.io.IOException; +import java.io.InputStreamReader; +import java.io.Reader; +import java.io.UnsupportedEncodingException; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; + +import org.apache.commons.io.input.BOMInputStream; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +/** + * Tests for the user guide. + */ +class UserGuideTest { + + @TempDir + Path tempDir; + + /** + * Creates a reader capable of handling BOMs. + * + * @param path The path to read. + * @return a new InputStreamReader for UTF-8 bytes. + * @throws IOException if an I/O error occurs. + */ + public InputStreamReader newReader(final Path path) throws IOException { + return new InputStreamReader(BOMInputStream.builder() + .setPath(path) + .get(), StandardCharsets.UTF_8); + } + + @Test + void testBomFull() throws UnsupportedEncodingException, IOException { + final Path path = tempDir.resolve("test1.csv"); + Files.copy(Utils.createUtf8Input("ColumnA, ColumnB, ColumnC\r\nA, B, C\r\n".getBytes(StandardCharsets.UTF_8), true), path); + // @formatter:off + try (Reader reader = new InputStreamReader(BOMInputStream.builder() + .setPath(path) + .get(), "UTF-8"); + CSVParser parser = CSVFormat.EXCEL.builder() + .setHeader() + .get() + .parse(reader)) { + // @formatter:off + for (final CSVRecord record : parser) { + final String string = record.get("ColumnA"); + assertEquals("A", string); + } + } + } + + @Test + void testBomUtil() throws UnsupportedEncodingException, IOException { + final Path path = tempDir.resolve("test2.csv"); + Files.copy(Utils.createUtf8Input("ColumnA, ColumnB, ColumnC\r\nA, B, C\r\n".getBytes(StandardCharsets.UTF_8), true), path); + try (Reader reader = newReader(path); + // @formatter:off + CSVParser parser = CSVFormat.EXCEL.builder() + .setHeader() + .get() + .parse(reader)) { + // @formatter:off + for (final CSVRecord record : parser) { + final String string = record.get("ColumnA"); + assertEquals("A", string); + } + } + } + +} diff --git a/src/test/java/org/apache/commons/csv/Utils.java b/src/test/java/org/apache/commons/csv/Utils.java index 23ff79b60c..5b5a05e043 100644 --- a/src/test/java/org/apache/commons/csv/Utils.java +++ b/src/test/java/org/apache/commons/csv/Utils.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv; @@ -20,6 +22,8 @@ import static org.junit.jupiter.api.Assertions.assertArrayEquals; import static org.junit.jupiter.api.Assertions.assertEquals; +import java.io.ByteArrayInputStream; +import java.io.InputStream; import java.util.List; /** @@ -30,18 +34,34 @@ final class Utils { /** * Checks if the 2d array has the same contents as the list of records. * - * @param message the message to be displayed + * @param message the message to be displayed * @param expected the 2d array of expected results - * @param actual the List of {@link CSVRecord} entries, each containing an array of values + * @param actual the List of {@link CSVRecord} entries, each containing an array of values + * @param maxRows the maximum number of rows expected, less than or equal to zero means no limit. */ - public static void compare(final String message, final String[][] expected, final List actual) { - final int expectedLength = expected.length; + public static void compare(final String message, final String[][] expected, final List actual, final long maxRows) { + final long expectedLength = maxRows > 0 ? Math.min(maxRows, expected.length) : expected.length; assertEquals(expectedLength, actual.size(), message + " - outer array size"); for (int i = 0; i < expectedLength; i++) { assertArrayEquals(expected[i], actual.get(i).values(), message + " (entry " + i + ")"); } } + /** + * Creates an input stream, with or without a BOM. + */ + static InputStream createUtf8Input(final byte[] baseData, final boolean addBom) { + byte[] data = baseData; + if (addBom) { + data = new byte[baseData.length + 3]; + data[0] = (byte) 0xEF; + data[1] = (byte) 0xBB; + data[2] = (byte) 0xBF; + System.arraycopy(baseData, 0, data, 3, baseData.length); + } + return new ByteArrayInputStream(data); + } + private Utils() { } } diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv148Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv148Test.java index 82fd985603..67f1b785d5 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv148Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv148Test.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.issues; @@ -22,10 +24,10 @@ import org.apache.commons.csv.QuoteMode; import org.junit.jupiter.api.Test; -public class JiraCsv148Test { +class JiraCsv148Test { @Test - public void testWithIgnoreSurroundingSpacesEmpty() { + void testWithIgnoreSurroundingSpacesEmpty() { // @formatter:off final CSVFormat format = CSVFormat.DEFAULT.builder() .setQuoteMode(QuoteMode.ALL) @@ -45,7 +47,7 @@ public void testWithIgnoreSurroundingSpacesEmpty() { * quotation marks, while withIgnoreSurroundingSpace() cannot The same point: you can remove the leading and trailing spaces, tabs and other symbols. */ @Test - public void testWithTrimEmpty() { + void testWithTrimEmpty() { // @formatter:off final CSVFormat format = CSVFormat.DEFAULT.builder() .setQuoteMode(QuoteMode.ALL) @@ -53,7 +55,7 @@ public void testWithTrimEmpty() { .get(); // @formatter:on assertEquals( - "\"\",\"\",\"Single space on the left\",\"Single space on the right\"," + "\"Single spaces on both sides\",\"Multiple spaces on the left\"," + + "\"\",\"\",\"Single space on the left\",\"Single space on the right\",\"Single spaces on both sides\",\"Multiple spaces on the left\"," + "\"Multiple spaces on the right\",\"Multiple spaces on both sides\"", format.format("", " ", " Single space on the left", "Single space on the right ", " Single spaces on both sides ", " Multiple spaces on the left", "Multiple spaces on the right ", " Multiple spaces on both sides ")); diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv149Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv149Test.java index d287c32f6f..b32e965665 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv149Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv149Test.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.issues; @@ -27,12 +29,12 @@ import org.apache.commons.csv.CSVRecord; import org.junit.jupiter.api.Test; -public class JiraCsv149Test { +class JiraCsv149Test { private static final String CR_LF = "\r\n"; @Test - public void testJiraCsv149EndWithEOL() throws IOException { + void testJiraCsv149EndWithEOL() throws IOException { testJiraCsv149EndWithEolAtEof(true); } @@ -50,7 +52,7 @@ private void testJiraCsv149EndWithEolAtEof(final boolean eolAtEof) throws IOExce .get(); // @formatter:on int lineCounter = 2; - try (final CSVParser parser = CSVParser.builder().setReader(reader).setFormat(format).get()) { + try (CSVParser parser = CSVParser.builder().setReader(reader).setFormat(format).get()) { for (final CSVRecord record : parser) { assertNotNull(record); assertEquals(lineCounter++, parser.getCurrentLineNumber()); @@ -59,7 +61,7 @@ private void testJiraCsv149EndWithEolAtEof(final boolean eolAtEof) throws IOExce } @Test - public void testJiraCsv149EndWithoutEOL() throws IOException { + void testJiraCsv149EndWithoutEOL() throws IOException { testJiraCsv149EndWithEolAtEof(false); } } diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv150Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv150Test.java index 620dab7fcf..eec91d52d0 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv150Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv150Test.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.issues; @@ -25,7 +27,7 @@ import org.apache.commons.csv.CSVParser; import org.junit.jupiter.api.Test; -public class JiraCsv150Test { +class JiraCsv150Test { private void testDisable(final CSVFormat format, final StringReader reader) throws IOException { try (CSVParser csvParser = CSVParser.builder().setReader(reader).setFormat(format).get()) { @@ -34,19 +36,19 @@ private void testDisable(final CSVFormat format, final StringReader reader) thro } @Test - public void testDisableComment() throws IOException { + void testDisableComment() throws IOException { final StringReader stringReader = new StringReader("\"66\u2441\",,\"\",\"DeutscheBK\ufffe\",\"000\"\r\n"); testDisable(CSVFormat.DEFAULT.builder().setCommentMarker(null).get(), stringReader); } @Test - public void testDisableEncapsulation() throws IOException { + void testDisableEncapsulation() throws IOException { final StringReader stringReader = new StringReader("66\u2441,,\"\",\ufffeDeutscheBK,\"000\"\r\n"); testDisable(CSVFormat.DEFAULT.builder().setQuote(null).get(), stringReader); } @Test - public void testDisableEscaping() throws IOException { + void testDisableEscaping() throws IOException { final StringReader stringReader = new StringReader("\"66\u2441\",,\"\",\"DeutscheBK\ufffe\",\"000\"\r\n"); testDisable(CSVFormat.DEFAULT.builder().setEscape(null).get(), stringReader); } diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv154Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv154Test.java index 93a429632e..90d657fcd1 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv154Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv154Test.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.issues; @@ -24,10 +26,10 @@ import org.apache.commons.csv.CSVPrinter; import org.junit.jupiter.api.Test; -public class JiraCsv154Test { +class JiraCsv154Test { @Test - public void testJiraCsv154_withCommentMarker() throws IOException { + void testJiraCsv154_withCommentMarker() throws IOException { final String comment = "This is a header comment"; // @formatter:off final CSVFormat format = CSVFormat.EXCEL.builder() @@ -37,7 +39,7 @@ public void testJiraCsv154_withCommentMarker() throws IOException { .get(); // @formatter:on final StringBuilder out = new StringBuilder(); - try (final CSVPrinter printer = format.print(out)) { + try (CSVPrinter printer = format.print(out)) { printer.print("A"); printer.print("B"); } @@ -46,7 +48,7 @@ public void testJiraCsv154_withCommentMarker() throws IOException { } @Test - public void testJiraCsv154_withHeaderComments() throws IOException { + void testJiraCsv154_withHeaderComments() throws IOException { final String comment = "This is a header comment"; // @formatter:off final CSVFormat format = CSVFormat.EXCEL.builder() @@ -56,7 +58,7 @@ public void testJiraCsv154_withHeaderComments() throws IOException { .get(); // @formatter:on final StringBuilder out = new StringBuilder(); - try (final CSVPrinter printer = format.print(out)) { + try (CSVPrinter printer = format.print(out)) { printer.print("A"); printer.print("B"); } diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv167Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv167Test.java index f7e85b5f18..607d0cf2a3 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv167Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv167Test.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.issues; @@ -29,7 +31,7 @@ import org.apache.commons.csv.QuoteMode; import org.junit.jupiter.api.Test; -public class JiraCsv167Test { +class JiraCsv167Test { private Reader getTestReader() { return new InputStreamReader( @@ -37,10 +39,10 @@ private Reader getTestReader() { } @Test - public void testParse() throws IOException { + void testParse() throws IOException { int totcomment = 0; int totrecs = 0; - try (final Reader reader = getTestReader(); final BufferedReader br = new BufferedReader(reader)) { + try (Reader reader = getTestReader(); BufferedReader br = new BufferedReader(reader)) { String s = null; boolean lastWasComment = false; while ((s = br.readLine()) != null) { @@ -74,7 +76,7 @@ public void testParse() throws IOException { // @formatter:on int comments = 0; int records = 0; - try (final Reader reader = getTestReader(); final CSVParser parser = format.parse(reader)) { + try (Reader reader = getTestReader(); CSVParser parser = format.parse(reader)) { for (final CSVRecord csvRecord : parser) { records++; if (csvRecord.hasComment()) { diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv198Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv198Test.java index e07cf98bc6..1117c12ac9 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv198Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv198Test.java @@ -1,51 +1,54 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.csv.issues; - -import static org.junit.jupiter.api.Assertions.assertNotNull; - -import java.io.IOException; -import java.io.InputStream; -import java.io.InputStreamReader; -import java.io.UnsupportedEncodingException; -import java.nio.charset.StandardCharsets; - -import org.apache.commons.csv.CSVFormat; -import org.apache.commons.csv.CSVParser; -import org.junit.jupiter.api.Test; - -public class JiraCsv198Test { - - // @formatter:off - private static final CSVFormat CSV_FORMAT = CSVFormat.EXCEL.builder() - .setDelimiter('^') - .setHeader() - .setSkipHeaderRecord(true) - .get(); - // @formatter:on - - @Test - public void test() throws UnsupportedEncodingException, IOException { - final InputStream pointsOfReference = getClass().getResourceAsStream("/org/apache/commons/csv/CSV-198/optd_por_public.csv"); - assertNotNull(pointsOfReference); - try (@SuppressWarnings("resource") - CSVParser parser = CSV_FORMAT.parse(new InputStreamReader(pointsOfReference, StandardCharsets.UTF_8))) { - parser.forEach(record -> assertNotNull(record.get("location_type"))); - } - } - -} +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.commons.csv.issues; + +import static org.junit.jupiter.api.Assertions.assertNotNull; + +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.io.UnsupportedEncodingException; +import java.nio.charset.StandardCharsets; + +import org.apache.commons.csv.CSVFormat; +import org.apache.commons.csv.CSVParser; +import org.junit.jupiter.api.Test; + +class JiraCsv198Test { + + // @formatter:off + private static final CSVFormat CSV_FORMAT = CSVFormat.EXCEL.builder() + .setDelimiter('^') + .setHeader() + .setSkipHeaderRecord(true) + .get(); + // @formatter:on + + @Test + void test() throws UnsupportedEncodingException, IOException { + final InputStream pointsOfReference = getClass().getResourceAsStream("/org/apache/commons/csv/CSV-198/optd_por_public.csv"); + assertNotNull(pointsOfReference); + try (@SuppressWarnings("resource") + CSVParser parser = CSV_FORMAT.parse(new InputStreamReader(pointsOfReference, StandardCharsets.UTF_8))) { + parser.forEach(record -> assertNotNull(record.get("location_type"))); + } + } + +} diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv203Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv203Test.java index 4469b36603..2c9226506c 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv203Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv203Test.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.issues; @@ -27,10 +29,10 @@ * JIRA: withNullString value is printed without quotes when * QuoteMode.ALL is specified */ -public class JiraCsv203Test { +class JiraCsv203Test { @Test - public void testQuoteModeAll() throws Exception { + void testQuoteModeAll() throws Exception { // @formatter:off final CSVFormat format = CSVFormat.EXCEL.builder() .setNullString("N/A") @@ -39,14 +41,14 @@ public void testQuoteModeAll() throws Exception { .get(); // @formatter:on final StringBuilder buffer = new StringBuilder(); - try (final CSVPrinter printer = new CSVPrinter(buffer, format)) { + try (CSVPrinter printer = new CSVPrinter(buffer, format)) { printer.printRecord(null, "Hello", null, "World"); } assertEquals("\"N/A\",\"Hello\",\"N/A\",\"World\"\r\n", buffer.toString()); } @Test - public void testQuoteModeAllNonNull() throws Exception { + void testQuoteModeAllNonNull() throws Exception { // @formatter:off final CSVFormat format = CSVFormat.EXCEL.builder() .setNullString("N/A") @@ -55,14 +57,14 @@ public void testQuoteModeAllNonNull() throws Exception { .get(); // @formatter:on final StringBuilder buffer = new StringBuilder(); - try (final CSVPrinter printer = new CSVPrinter(buffer, format)) { + try (CSVPrinter printer = new CSVPrinter(buffer, format)) { printer.printRecord(null, "Hello", null, "World"); } assertEquals("N/A,\"Hello\",N/A,\"World\"\r\n", buffer.toString()); } @Test - public void testQuoteModeMinimal() throws Exception { + void testQuoteModeMinimal() throws Exception { // @formatter:off final CSVFormat format = CSVFormat.EXCEL.builder() .setNullString("N/A") @@ -71,14 +73,14 @@ public void testQuoteModeMinimal() throws Exception { .get(); // @formatter:on final StringBuilder buffer = new StringBuilder(); - try (final CSVPrinter printer = new CSVPrinter(buffer, format)) { + try (CSVPrinter printer = new CSVPrinter(buffer, format)) { printer.printRecord(null, "Hello", null, "World"); } assertEquals("N/A,Hello,N/A,World\r\n", buffer.toString()); } @Test - public void testQuoteModeNonNumeric() throws Exception { + void testQuoteModeNonNumeric() throws Exception { // @formatter:off final CSVFormat format = CSVFormat.EXCEL.builder() .setNullString("N/A") @@ -87,14 +89,14 @@ public void testQuoteModeNonNumeric() throws Exception { .get(); // @formatter:on final StringBuilder buffer = new StringBuilder(); - try (final CSVPrinter printer = new CSVPrinter(buffer, format)) { + try (CSVPrinter printer = new CSVPrinter(buffer, format)) { printer.printRecord(null, "Hello", null, "World"); } assertEquals("N/A,\"Hello\",N/A,\"World\"\r\n", buffer.toString()); } @Test - public void testWithEmptyValues() throws Exception { + void testWithEmptyValues() throws Exception { // @formatter:off final CSVFormat format = CSVFormat.EXCEL.builder() .setNullString("N/A") @@ -103,7 +105,7 @@ public void testWithEmptyValues() throws Exception { .get(); // @formatter:on final StringBuilder buffer = new StringBuilder(); - try (final CSVPrinter printer = new CSVPrinter(buffer, format)) { + try (CSVPrinter printer = new CSVPrinter(buffer, format)) { printer.printRecord("", "Hello", "", "World"); // printer.printRecord(new Object[] { null, "Hello", null, "World" }); } @@ -111,7 +113,7 @@ public void testWithEmptyValues() throws Exception { } @Test - public void testWithoutNullString() throws Exception { + void testWithoutNullString() throws Exception { // @formatter:off final CSVFormat format = CSVFormat.EXCEL.builder() //.setNullString("N/A") @@ -120,14 +122,14 @@ public void testWithoutNullString() throws Exception { .get(); // @formatter:on final StringBuilder buffer = new StringBuilder(); - try (final CSVPrinter printer = new CSVPrinter(buffer, format)) { + try (CSVPrinter printer = new CSVPrinter(buffer, format)) { printer.printRecord(null, "Hello", null, "World"); } assertEquals(",\"Hello\",,\"World\"\r\n", buffer.toString()); } @Test - public void testWithoutQuoteMode() throws Exception { + void testWithoutQuoteMode() throws Exception { // @formatter:off final CSVFormat format = CSVFormat.EXCEL.builder() .setNullString("N/A") @@ -135,7 +137,7 @@ public void testWithoutQuoteMode() throws Exception { .get(); // @formatter:on final StringBuilder buffer = new StringBuilder(); - try (final CSVPrinter printer = new CSVPrinter(buffer, format)) { + try (CSVPrinter printer = new CSVPrinter(buffer, format)) { printer.printRecord(null, "Hello", null, "World"); } assertEquals("N/A,Hello,N/A,World\r\n", buffer.toString()); diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv206Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv206Test.java index 2932982fc8..2fecd10f16 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv206Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv206Test.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.issues; @@ -28,16 +30,16 @@ import org.apache.commons.csv.CSVRecord; import org.junit.jupiter.api.Test; -public class JiraCsv206Test { +class JiraCsv206Test { @Test - public void testJiraCsv206MultipleCharacterDelimiter() throws IOException { + void testJiraCsv206MultipleCharacterDelimiter() throws IOException { // Read with multiple character delimiter final String source = "FirstName[|]LastName[|]Address\r\nJohn[|]Smith[|]123 Main St."; final StringReader reader = new StringReader(source); final CSVFormat format = CSVFormat.DEFAULT.builder().setDelimiter("[|]").get(); CSVRecord record = null; - try (final CSVParser csvParser = CSVParser.builder().setReader(reader).setFormat(format).get()) { + try (CSVParser csvParser = CSVParser.builder().setReader(reader).setFormat(format).get()) { final Iterator iterator = csvParser.iterator(); record = iterator.next(); assertEquals("FirstName", record.get(0)); @@ -63,7 +65,7 @@ record = iterator.next(); .setHeaderComments(comment).get(); // @formatter:on final StringBuilder out = new StringBuilder(); - try (final CSVPrinter printer = formatExcel.print(out)) { + try (CSVPrinter printer = formatExcel.print(out)) { printer.print(record.get(0)); printer.print(record.get(1)); printer.print(record.get(2)); diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv211Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv211Test.java index 0cc552206c..28b559d1e1 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv211Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv211Test.java @@ -1,51 +1,54 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.commons.csv.issues; - -import static org.junit.jupiter.api.Assertions.assertEquals; - -import java.io.IOException; -import java.io.StringReader; - -import org.apache.commons.csv.CSVFormat; -import org.apache.commons.csv.CSVParser; -import org.junit.jupiter.api.Test; - -public class JiraCsv211Test { - - @Test - public void testJiraCsv211Format() throws IOException { - // @formatter:off - final CSVFormat printFormat = CSVFormat.DEFAULT.builder() - .setDelimiter('\t') - .setHeader("ID", "Name", "Country", "Age") - .get(); - // @formatter:on - final String formatted = printFormat.format("1", "Jane Doe", "USA", ""); - assertEquals("ID\tName\tCountry\tAge\r\n1\tJane Doe\tUSA\t", formatted); - - final CSVFormat parseFormat = CSVFormat.DEFAULT.builder().setDelimiter('\t').setHeader().setSkipHeaderRecord(true).get(); - try (final CSVParser parser = parseFormat.parse(new StringReader(formatted))) { - parser.forEach(record -> { - assertEquals("1", record.get(0)); - assertEquals("Jane Doe", record.get(1)); - assertEquals("USA", record.get(2)); - assertEquals("", record.get(3)); - }); - } - } -} +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.commons.csv.issues; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +import java.io.IOException; +import java.io.StringReader; + +import org.apache.commons.csv.CSVFormat; +import org.apache.commons.csv.CSVParser; +import org.junit.jupiter.api.Test; + +class JiraCsv211Test { + + @Test + void testJiraCsv211Format() throws IOException { + // @formatter:off + final CSVFormat printFormat = CSVFormat.DEFAULT.builder() + .setDelimiter('\t') + .setHeader("ID", "Name", "Country", "Age") + .get(); + // @formatter:on + final String formatted = printFormat.format("1", "Jane Doe", "USA", ""); + assertEquals("ID\tName\tCountry\tAge\r\n1\tJane Doe\tUSA\t", formatted); + + final CSVFormat parseFormat = CSVFormat.DEFAULT.builder().setDelimiter('\t').setHeader().setSkipHeaderRecord(true).get(); + try (CSVParser parser = parseFormat.parse(new StringReader(formatted))) { + parser.forEach(record -> { + assertEquals("1", record.get(0)); + assertEquals("Jane Doe", record.get(1)); + assertEquals("USA", record.get(2)); + assertEquals("", record.get(3)); + }); + } + } +} diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv213Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv213Test.java index 8e5ec9baa9..90f5da4c5a 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv213Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv213Test.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.issues; @@ -36,7 +38,7 @@ * you want, you need to open a new CSVParser. *

*/ -public class JiraCsv213Test { +class JiraCsv213Test { private void createEndChannel(final File csvFile) { // @formatter:off @@ -62,7 +64,7 @@ private void createEndChannel(final File csvFile) { } @Test - public void test() { + void test() { createEndChannel(new File("src/test/resources/org/apache/commons/csv/CSV-213/999751170.patch.csv")); } } diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv227Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv227Test.java new file mode 100644 index 0000000000..2b9e335a8f --- /dev/null +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv227Test.java @@ -0,0 +1,49 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.commons.csv.issues; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +import java.io.IOException; + +import org.apache.commons.csv.CSVFormat; +import org.apache.commons.csv.CSVPrinter; +import org.apache.commons.csv.QuoteMode; +import org.junit.jupiter.api.Test; + +/** + * Tests https://issues.apache.org/jira/browse/CSV-227 + */ +class JiraCsv227Test { + + @Test + public void test() throws IOException { + final StringBuilder out = new StringBuilder(); + try (CSVPrinter printer = new CSVPrinter(out, CSVFormat.DEFAULT.withQuoteMode(QuoteMode.MINIMAL))) { + printer.printRecord("ใ…ใ…Žใ„ทใ„น", "ใ…ใ…Žใ„ทใ„น", "", "test2"); + printer.printRecord("ํ•œ๊ธ€3", "hello3", "3ํ•œ๊ธ€3", "test3"); + printer.printRecord("", "hello4", "", "test4"); + } + // ใ…ใ…Žใ„ทใ„น,ใ…ใ…Žใ„ทใ„น,,test2 + // ํ•œ๊ธ€3,hello3,3ํ•œ๊ธ€3,test3 + // "",hello4,,test4 + assertEquals("ใ…ใ…Žใ„ทใ„น,ใ…ใ…Žใ„ทใ„น,,test2\r\nํ•œ๊ธ€3,hello3,3ํ•œ๊ธ€3,test3\r\n\"\",hello4,,test4\r\n", out.toString()); + } +} diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv247Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv247Test.java index 4cf5bbbe39..c2d9ac5910 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv247Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv247Test.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.issues; @@ -32,16 +34,16 @@ import org.apache.commons.csv.CSVRecord; import org.junit.jupiter.api.Test; -public class JiraCsv247Test { +class JiraCsv247Test { @Test - public void testHeadersMissingOneColumnWhenAllowingMissingColumnNames() throws Exception { + void testHeadersMissingOneColumnWhenAllowingMissingColumnNames() throws Exception { final CSVFormat format = CSVFormat.DEFAULT.builder().setHeader().setAllowMissingColumnNames(true).get(); assertTrue(format.getAllowMissingColumnNames(), "We should allow missing column names"); final Reader in = new StringReader("a,,c,d,e\n1,2,3,4,5\nv,w,x,y,z"); - try (final CSVParser parser = format.parse(in)) { + try (CSVParser parser = format.parse(in)) { assertEquals(Arrays.asList("a", "", "c", "d", "e"), parser.getHeaderNames()); final Iterator iterator = parser.iterator(); CSVRecord record = iterator.next(); @@ -61,20 +63,20 @@ record = iterator.next(); } @Test - public void testHeadersMissingThrowsWhenNotAllowingMissingColumnNames() { + void testHeadersMissingThrowsWhenNotAllowingMissingColumnNames() { final CSVFormat format = CSVFormat.DEFAULT.builder().setHeader().get(); assertFalse(format.getAllowMissingColumnNames(), "By default we should not allow missing column names"); assertThrows(IllegalArgumentException.class, () -> { - try (final Reader reader = new StringReader("a,,c,d,e\n1,2,3,4,5\nv,w,x,y,z"); + try (Reader reader = new StringReader("a,,c,d,e\n1,2,3,4,5\nv,w,x,y,z"); CSVParser parser = format.parse(reader);) { // should fail } }, "1 missing column header is not allowed"); assertThrows(IllegalArgumentException.class, () -> { - try (final Reader reader = new StringReader("a,,c,d,\n1,2,3,4,5\nv,w,x,y,z"); + try (Reader reader = new StringReader("a,,c,d,\n1,2,3,4,5\nv,w,x,y,z"); CSVParser parser = format.parse(reader);) { // should fail } diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv248Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv248Test.java index 7db2977f07..480a9dffa9 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv248Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv248Test.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.issues; @@ -31,13 +33,14 @@ import org.apache.commons.csv.CSVRecord; import org.junit.jupiter.api.Test; -public class JiraCsv248Test { +class JiraCsv248Test { + private static InputStream getTestInput() { return ClassLoader.getSystemClassLoader().getResourceAsStream("org/apache/commons/csv/CSV-248/csvRecord.bin"); } /** - * Test deserialisation of a CSVRecord created using version 1.6. + * Test deserialization of a CSVRecord created using version 1.6. * *

* This test asserts that serialization from 1.8 onwards is consistent with previous versions. Serialization was @@ -47,13 +50,13 @@ private static InputStream getTestInput() { * @throws ClassNotFoundException If the CSVRecord cannot be deserialized */ @Test - public void testJiraCsv248() throws IOException, ClassNotFoundException { + void testJiraCsv248() throws IOException, ClassNotFoundException { // Record was originally created using CSV version 1.6 with the following code: - // try (final CSVParser parser = CSVParser.parse("A,B\n#my comment\nOne,Two", + // try (CSVParser parser = CSVParser.parse("A,B\n#my comment\nOne,Two", // CSVFormat.DEFAULT.builder().setHeader().setCommentMarker('#'))) { // CSVRecord rec = parser.iterator().next(); // } - try (InputStream in = getTestInput(); final ObjectInputStream ois = new ObjectInputStream(in)) { + try (InputStream in = getTestInput(); ObjectInputStream ois = new ObjectInputStream(in)) { final Object object = ois.readObject(); assertInstanceOf(CSVRecord.class, object); final CSVRecord rec = (CSVRecord) object; diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv249Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv249Test.java index e8b2cbf86c..4034b04bd7 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv249Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv249Test.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.issues; @@ -30,10 +32,10 @@ import org.apache.commons.csv.CSVRecord; import org.junit.jupiter.api.Test; -public class JiraCsv249Test { +class JiraCsv249Test { @Test - public void testJiraCsv249() throws IOException { + void testJiraCsv249() throws IOException { final CSVFormat format = CSVFormat.DEFAULT.builder().setEscape('\\').get(); final StringWriter stringWriter = new StringWriter(); try (CSVPrinter printer = new CSVPrinter(stringWriter, format)) { diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv253Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv253Test.java index 0e429a372d..13bb6a8270 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv253Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv253Test.java @@ -1,22 +1,24 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.issues; -import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.apache.commons.csv.CsvAssertions.assertValuesEquals; import java.io.IOException; import java.io.StringReader; @@ -31,24 +33,24 @@ /** * Setting QuoteMode:ALL_NON_NULL or NON_NUMERIC can distinguish between empty string columns and absent value columns. */ -public class JiraCsv253Test { - - private void assertArrayEqual(final String[] expected, final CSVRecord actual) { - for (int i = 0; i < expected.length; i++) { - assertEquals(expected[i], actual.get(i)); - } - } +class JiraCsv253Test { @Test - public void testHandleAbsentValues() throws IOException { - final String source = "\"John\",,\"Doe\"\n" + ",\"AA\",123\n" + "\"John\",90,\n" + "\"\",,90"; + void testHandleAbsentValues() throws IOException { + // @formatter:off + final String source = + "\"John\",,\"Doe\"\n" + + ",\"AA\",123\n" + + "\"John\",90,\n" + + "\"\",,90"; + // @formatter:on final CSVFormat csvFormat = CSVFormat.DEFAULT.builder().setQuoteMode(QuoteMode.NON_NUMERIC).get(); - try (final CSVParser parser = csvFormat.parse(new StringReader(source))) { + try (CSVParser parser = csvFormat.parse(new StringReader(source))) { final Iterator csvRecords = parser.iterator(); - assertArrayEqual(new String[] {"John", null, "Doe"}, csvRecords.next()); - assertArrayEqual(new String[] {null, "AA", "123"}, csvRecords.next()); - assertArrayEqual(new String[] {"John", "90", null}, csvRecords.next()); - assertArrayEqual(new String[] {"", null, "90"}, csvRecords.next()); + assertValuesEquals(new String[] {"John", null, "Doe"}, csvRecords.next()); + assertValuesEquals(new String[] {null, "AA", "123"}, csvRecords.next()); + assertValuesEquals(new String[] {"John", "90", null}, csvRecords.next()); + assertValuesEquals(new String[] {"", null, "90"}, csvRecords.next()); } } } diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv254Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv254Test.java new file mode 100644 index 0000000000..629b42ee6b --- /dev/null +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv254Test.java @@ -0,0 +1,52 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.commons.csv.issues; + +import static org.apache.commons.csv.CsvAssertions.assertValuesEquals; + +import java.io.BufferedReader; +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.util.Iterator; + +import org.apache.commons.csv.CSVFormat; +import org.apache.commons.csv.CSVParser; +import org.apache.commons.csv.CSVRecord; +import org.junit.jupiter.api.Test; + +/** + * Tests https://issues.apache.org/jira/browse/CSV-254. + */ +class JiraCsv254Test { + + @Test + void test() throws IOException { + final CSVFormat csvFormat = CSVFormat.POSTGRESQL_CSV; + try (BufferedReader reader = Files.newBufferedReader(Paths.get("src/test/resources/org/apache/commons/csv/CSV-254/csv-254.csv"), + StandardCharsets.UTF_8); CSVParser parser = csvFormat.parse(reader)) { + final Iterator csvRecords = parser.iterator(); + assertValuesEquals(new String[] { "AA", "33", null }, csvRecords.next()); + assertValuesEquals(new String[] { "AA", null, "" }, csvRecords.next()); + assertValuesEquals(new String[] { null, "33", "CC" }, csvRecords.next()); + } + } +} diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv257Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv257Test.java new file mode 100644 index 0000000000..4234a7a0fa --- /dev/null +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv257Test.java @@ -0,0 +1,84 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.commons.csv.issues; + +import static org.junit.jupiter.api.Assertions.assertThrows; + +import java.io.IOException; +import java.io.StringReader; + +import org.apache.commons.csv.CSVFormat; +import org.apache.commons.csv.CSVParser; +import org.junit.jupiter.api.Test; + +/** + * Tests https://issues.apache.org/jira/browse/CSV-257 + */ +class JiraCsv257Test { + + private static final String INPUT = ","; + + @Test + void testHeaderBuilder() throws IOException { + // @formatter:off + final CSVFormat format = CSVFormat.RFC4180.builder() + .setDelimiter(INPUT.charAt(0)) + .setHeader() + .setSkipHeaderRecord(true) + .setIgnoreSurroundingSpaces(true) + .get(); + // @formatter:on + // Document the current behavior: Throw a IllegalArgumentException is a header name is missing. + assertThrows(IllegalArgumentException.class, () -> { + try (CSVParser parser = CSVParser.parse(INPUT, format)) { + // empty + } + }); + } + + @Test + void testHeaderDepreacted() throws IOException { + // @formatter:off + final CSVFormat format = CSVFormat.RFC4180 + .withDelimiter(INPUT.charAt(0)) + .withFirstRecordAsHeader() + .withIgnoreSurroundingSpaces(); + // @formatter:on + // Document the current behavior: Throw a IllegalArgumentException is a header name is missing. + assertThrows(IllegalArgumentException.class, () -> { + try (CSVParser parser = new CSVParser(new StringReader(INPUT), format)) { + // empty + } + }); + } + + @Test + void testNoHeaderBuilder() throws IOException { + // @formatter:off + final CSVFormat format = CSVFormat.RFC4180.builder() + .setDelimiter(INPUT.charAt(0)) + .setIgnoreSurroundingSpaces(true) + .get(); + // @formatter:on + try (CSVParser parser = CSVParser.parse(INPUT, format)) { + // empty + } + } +} diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv263Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv263Test.java index 39e61b46ab..18bb9580a3 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv263Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv263Test.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.issues; @@ -30,10 +32,10 @@ /** * Tests [CSV-263] Print from Reader with embedded quotes generates incorrect output. */ -public class JiraCsv263Test { +class JiraCsv263Test { @Test - public void testPrintFromReaderWithQuotes() throws IOException { + void testPrintFromReaderWithQuotes() throws IOException { // @formatter:off final CSVFormat format = CSVFormat.RFC4180.builder() .setDelimiter(',') diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv264Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv264Test.java index ee83c569ef..857e42cb8f 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv264Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv264Test.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.issues; @@ -33,7 +35,7 @@ * * @see Jira Ticker */ -public class JiraCsv264Test { +class JiraCsv264Test { private static final String CSV_STRING = "\"\",\"B\",\"\"\n" + "\"1\",\"2\",\"3\"\n" + @@ -47,42 +49,39 @@ public class JiraCsv264Test { "\"6\",\"7\",\"\",\"\",\"10\""; @Test - public void testJiraCsv264() { + void testJiraCsv264() { final CSVFormat csvFormat = CSVFormat.DEFAULT .builder() .setHeader() .setDuplicateHeaderMode(DuplicateHeaderMode.DISALLOW) .setAllowMissingColumnNames(true) .get(); - try (StringReader reader = new StringReader(CSV_STRING)) { assertThrows(IllegalArgumentException.class, () -> csvFormat.parse(reader)); } } @Test - public void testJiraCsv264WithGapAllowEmpty() throws IOException { + void testJiraCsv264WithGapAllowEmpty() throws IOException { final CSVFormat csvFormat = CSVFormat.DEFAULT .builder() .setHeader() .setDuplicateHeaderMode(DuplicateHeaderMode.ALLOW_EMPTY) .setAllowMissingColumnNames(true) .get(); - - try (StringReader reader = new StringReader(CSV_STRING_GAP); final CSVParser parser = csvFormat.parse(reader)) { + try (StringReader reader = new StringReader(CSV_STRING_GAP); CSVParser parser = csvFormat.parse(reader)) { // empty } } @Test - public void testJiraCsv264WithGapDisallow() { + void testJiraCsv264WithGapDisallow() { final CSVFormat csvFormat = CSVFormat.DEFAULT .builder() .setHeader() .setDuplicateHeaderMode(DuplicateHeaderMode.DISALLOW) .setAllowMissingColumnNames(true) .get(); - try (StringReader reader = new StringReader(CSV_STRING_GAP)) { assertThrows(IllegalArgumentException.class, () -> csvFormat.parse(reader)); } diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv265Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv265Test.java index 6d89976859..1bccad702f 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv265Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv265Test.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.issues; @@ -31,10 +33,10 @@ /** * Tests [CSV-265] {@link CSVRecord#getCharacterPosition()} returns the correct position after encountering a comment. */ -public class JiraCsv265Test { +class JiraCsv265Test { @Test - public void testCharacterPositionWithComments() throws IOException { + void testCharacterPositionWithComments() throws IOException { // @formatter:off final String csv = "# Comment1\n" + @@ -50,7 +52,7 @@ public void testCharacterPositionWithComments() throws IOException { .setSkipHeaderRecord(true) .get(); // @formatter:on - try (final CSVParser parser = csvFormat.parse(new StringReader(csv))) { + try (CSVParser parser = csvFormat.parse(new StringReader(csv))) { final Iterator itr = parser.iterator(); final CSVRecord record1 = itr.next(); assertEquals(csv.indexOf("# Comment2"), record1.getCharacterPosition()); @@ -60,7 +62,7 @@ public void testCharacterPositionWithComments() throws IOException { } @Test - public void testCharacterPositionWithCommentsSpanningMultipleLines() throws IOException { + void testCharacterPositionWithCommentsSpanningMultipleLines() throws IOException { // @formatter:off final String csv = "# Comment1\n" + @@ -78,7 +80,7 @@ public void testCharacterPositionWithCommentsSpanningMultipleLines() throws IOEx .setSkipHeaderRecord(true) .get(); // @formatter:on - try (final CSVParser parser = csvFormat.parse(new StringReader(csv))) { + try (CSVParser parser = csvFormat.parse(new StringReader(csv))) { final Iterator itr = parser.iterator(); final CSVRecord record1 = itr.next(); assertEquals(csv.indexOf("# Comment3"), record1.getCharacterPosition()); diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv271Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv271Test.java index c7e03492e1..0269dec5d1 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv271Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv271Test.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.issues; @@ -27,10 +29,10 @@ import org.apache.commons.csv.CSVPrinter; import org.junit.jupiter.api.Test; -public class JiraCsv271Test { +class JiraCsv271Test { @Test - public void testJiraCsv271_withArray() throws IOException { + void testJiraCsv271_withArray() throws IOException { final CSVFormat csvFormat = CSVFormat.DEFAULT; final StringWriter stringWriter = new StringWriter(); try (CSVPrinter printer = new CSVPrinter(stringWriter, csvFormat)) { @@ -41,7 +43,7 @@ public void testJiraCsv271_withArray() throws IOException { } @Test - public void testJiraCsv271_withList() throws IOException { + void testJiraCsv271_withList() throws IOException { final CSVFormat csvFormat = CSVFormat.DEFAULT; final StringWriter stringWriter = new StringWriter(); try (CSVPrinter printer = new CSVPrinter(stringWriter, csvFormat)) { diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv288Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv288Test.java index 965469c647..065ee6bb37 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv288Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv288Test.java @@ -1,214 +1,216 @@ -/* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.apache.commons.csv.issues; - -import static org.junit.jupiter.api.Assertions.assertEquals; - -import java.io.IOException; -import java.io.Reader; -import java.io.StringReader; - -import org.apache.commons.csv.CSVFormat; -import org.apache.commons.csv.CSVParser; -import org.apache.commons.csv.CSVPrinter; -import org.apache.commons.csv.CSVRecord; -import org.junit.jupiter.api.Test; - -public class JiraCsv288Test { - - private void print(final CSVRecord csvRecord, final CSVPrinter csvPrinter) throws IOException { - for (final String value : csvRecord) { - csvPrinter.print(value); - } - } - - @Test - // Before fix: - // expected: but was: - public void testParseWithABADelimiter() throws Exception { - final Reader in = new StringReader("a|~|b|~|c|~|d|~||~|f"); - final StringBuilder stringBuilder = new StringBuilder(); - try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); - CSVParser parser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("|~|").get())) { - for (final CSVRecord csvRecord : parser) { - print(csvRecord, csvPrinter); - assertEquals("a,b,c,d,,f", stringBuilder.toString()); - } - } - } - - @Test - // Before fix: - // expected: but was: - public void testParseWithDoublePipeDelimiter() throws Exception { - final Reader in = new StringReader("a||b||c||d||||f"); - final StringBuilder stringBuilder = new StringBuilder(); - try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); - CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("||").get())) { - for (final CSVRecord csvRecord : csvParser) { - print(csvRecord, csvPrinter); - assertEquals("a,b,c,d,,f", stringBuilder.toString()); - } - } - } - - @Test - // Regression, already passed before fix - - public void testParseWithDoublePipeDelimiterDoubleCharValue() throws Exception { - final Reader in = new StringReader("a||bb||cc||dd||f"); - final StringBuilder stringBuilder = new StringBuilder(); - try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); - CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("||").get())) { - for (final CSVRecord csvRecord : csvParser) { - print(csvRecord, csvPrinter); - assertEquals("a,bb,cc,dd,f", stringBuilder.toString()); - } - } - } - - @Test - // Before fix: - // expected: but was: - public void testParseWithDoublePipeDelimiterEndsWithDelimiter() throws Exception { - final Reader in = new StringReader("a||b||c||d||||f||"); - final StringBuilder stringBuilder = new StringBuilder(); - try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); - CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("||").get())) { - for (final CSVRecord csvRecord : csvParser) { - print(csvRecord, csvPrinter); - assertEquals("a,b,c,d,,f,", stringBuilder.toString()); - } - } - } - - @Test - // Before fix: - // expected: but was: - public void testParseWithDoublePipeDelimiterQuoted() throws Exception { - final Reader in = new StringReader("a||\"b||c\"||d||||f"); - final StringBuilder stringBuilder = new StringBuilder(); - try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); - CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("||").get())) { - for (final CSVRecord csvRecord : csvParser) { - print(csvRecord, csvPrinter); - assertEquals("a,b||c,d,,f", stringBuilder.toString()); - } - } - } - - @Test - // Regression, already passed before fix - public void testParseWithSinglePipeDelimiterEndsWithDelimiter() throws Exception { - final Reader in = new StringReader("a|b|c|d||f|"); - final StringBuilder stringBuilder = new StringBuilder(); - try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); - CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("|").get())) { - for (final CSVRecord csvRecord : csvParser) { - print(csvRecord, csvPrinter); - assertEquals("a,b,c,d,,f,", stringBuilder.toString()); - } - } - } - - @Test - // Before fix: - // expected: but was: - public void testParseWithTriplePipeDelimiter() throws Exception { - final Reader in = new StringReader("a|||b|||c|||d||||||f"); - final StringBuilder stringBuilder = new StringBuilder(); - try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); - CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("|||").get())) { - for (final CSVRecord csvRecord : csvParser) { - print(csvRecord, csvPrinter); - assertEquals("a,b,c,d,,f", stringBuilder.toString()); - } - } - } - - @Test - // Regression, already passed before fix - public void testParseWithTwoCharDelimiter1() throws Exception { - final Reader in = new StringReader("a~|b~|c~|d~|~|f"); - final StringBuilder stringBuilder = new StringBuilder(); - try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); - CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("~|").get())) { - for (final CSVRecord csvRecord : csvParser) { - print(csvRecord, csvPrinter); - assertEquals("a,b,c,d,,f", stringBuilder.toString()); - } - } - } - - @Test - // Regression, already passed before fix - public void testParseWithTwoCharDelimiter2() throws Exception { - final Reader in = new StringReader("a~|b~|c~|d~|~|f~"); - final StringBuilder stringBuilder = new StringBuilder(); - try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); - CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("~|").get())) { - for (final CSVRecord csvRecord : csvParser) { - print(csvRecord, csvPrinter); - assertEquals("a,b,c,d,,f~", stringBuilder.toString()); - } - } - } - - @Test - // Regression, already passed before fix - public void testParseWithTwoCharDelimiter3() throws Exception { - final Reader in = new StringReader("a~|b~|c~|d~|~|f|"); - final StringBuilder stringBuilder = new StringBuilder(); - try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); - CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("~|").get())) { - for (final CSVRecord csvRecord : csvParser) { - print(csvRecord, csvPrinter); - assertEquals("a,b,c,d,,f|", stringBuilder.toString()); - } - } - } - - @Test - // Regression, already passed before fix - public void testParseWithTwoCharDelimiter4() throws Exception { - final Reader in = new StringReader("a~|b~|c~|d~|~|f~~||g"); - final StringBuilder stringBuilder = new StringBuilder(); - try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); - CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("~|").get())) { - for (final CSVRecord csvRecord : csvParser) { - print(csvRecord, csvPrinter); - assertEquals("a,b,c,d,,f~,|g", stringBuilder.toString()); - } - } - } - - @Test - // Before fix: - // expected: but was: - public void testParseWithTwoCharDelimiterEndsWithDelimiter() throws Exception { - final Reader in = new StringReader("a~|b~|c~|d~|~|f~|"); - final StringBuilder stringBuilder = new StringBuilder(); - try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); - CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("~|").get())) { - for (final CSVRecord csvRecord : csvParser) { - print(csvRecord, csvPrinter); - assertEquals("a,b,c,d,,f,", stringBuilder.toString()); - } - } - } -} +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.commons.csv.issues; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +import java.io.IOException; +import java.io.Reader; +import java.io.StringReader; + +import org.apache.commons.csv.CSVFormat; +import org.apache.commons.csv.CSVParser; +import org.apache.commons.csv.CSVPrinter; +import org.apache.commons.csv.CSVRecord; +import org.junit.jupiter.api.Test; + +class JiraCsv288Test { + + private void print(final CSVRecord csvRecord, final CSVPrinter csvPrinter) throws IOException { + for (final String value : csvRecord) { + csvPrinter.print(value); + } + } + + @Test + // Before fix: + // expected: but was: + void testParseWithABADelimiter() throws Exception { + final Reader in = new StringReader("a|~|b|~|c|~|d|~||~|f"); + final StringBuilder stringBuilder = new StringBuilder(); + try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); + CSVParser parser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("|~|").get())) { + for (final CSVRecord csvRecord : parser) { + print(csvRecord, csvPrinter); + assertEquals("a,b,c,d,,f", stringBuilder.toString()); + } + } + } + + @Test + // Before fix: + // expected: but was: + void testParseWithDoublePipeDelimiter() throws Exception { + final Reader in = new StringReader("a||b||c||d||||f"); + final StringBuilder stringBuilder = new StringBuilder(); + try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); + CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("||").get())) { + for (final CSVRecord csvRecord : csvParser) { + print(csvRecord, csvPrinter); + assertEquals("a,b,c,d,,f", stringBuilder.toString()); + } + } + } + + @Test + // Regression, already passed before fix + + void testParseWithDoublePipeDelimiterDoubleCharValue() throws Exception { + final Reader in = new StringReader("a||bb||cc||dd||f"); + final StringBuilder stringBuilder = new StringBuilder(); + try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); + CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("||").get())) { + for (final CSVRecord csvRecord : csvParser) { + print(csvRecord, csvPrinter); + assertEquals("a,bb,cc,dd,f", stringBuilder.toString()); + } + } + } + + @Test + // Before fix: + // expected: but was: + void testParseWithDoublePipeDelimiterEndsWithDelimiter() throws Exception { + final Reader in = new StringReader("a||b||c||d||||f||"); + final StringBuilder stringBuilder = new StringBuilder(); + try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); + CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("||").get())) { + for (final CSVRecord csvRecord : csvParser) { + print(csvRecord, csvPrinter); + assertEquals("a,b,c,d,,f,", stringBuilder.toString()); + } + } + } + + @Test + // Before fix: + // expected: but was: + void testParseWithDoublePipeDelimiterQuoted() throws Exception { + final Reader in = new StringReader("a||\"b||c\"||d||||f"); + final StringBuilder stringBuilder = new StringBuilder(); + try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); + CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("||").get())) { + for (final CSVRecord csvRecord : csvParser) { + print(csvRecord, csvPrinter); + assertEquals("a,b||c,d,,f", stringBuilder.toString()); + } + } + } + + @Test + // Regression, already passed before fix + void testParseWithSinglePipeDelimiterEndsWithDelimiter() throws Exception { + final Reader in = new StringReader("a|b|c|d||f|"); + final StringBuilder stringBuilder = new StringBuilder(); + try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); + CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("|").get())) { + for (final CSVRecord csvRecord : csvParser) { + print(csvRecord, csvPrinter); + assertEquals("a,b,c,d,,f,", stringBuilder.toString()); + } + } + } + + @Test + // Before fix: + // expected: but was: + void testParseWithTriplePipeDelimiter() throws Exception { + final Reader in = new StringReader("a|||b|||c|||d||||||f"); + final StringBuilder stringBuilder = new StringBuilder(); + try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); + CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("|||").get())) { + for (final CSVRecord csvRecord : csvParser) { + print(csvRecord, csvPrinter); + assertEquals("a,b,c,d,,f", stringBuilder.toString()); + } + } + } + + @Test + // Regression, already passed before fix + void testParseWithTwoCharDelimiter1() throws Exception { + final Reader in = new StringReader("a~|b~|c~|d~|~|f"); + final StringBuilder stringBuilder = new StringBuilder(); + try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); + CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("~|").get())) { + for (final CSVRecord csvRecord : csvParser) { + print(csvRecord, csvPrinter); + assertEquals("a,b,c,d,,f", stringBuilder.toString()); + } + } + } + + @Test + // Regression, already passed before fix + void testParseWithTwoCharDelimiter2() throws Exception { + final Reader in = new StringReader("a~|b~|c~|d~|~|f~"); + final StringBuilder stringBuilder = new StringBuilder(); + try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); + CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("~|").get())) { + for (final CSVRecord csvRecord : csvParser) { + print(csvRecord, csvPrinter); + assertEquals("a,b,c,d,,f~", stringBuilder.toString()); + } + } + } + + @Test + // Regression, already passed before fix + void testParseWithTwoCharDelimiter3() throws Exception { + final Reader in = new StringReader("a~|b~|c~|d~|~|f|"); + final StringBuilder stringBuilder = new StringBuilder(); + try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); + CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("~|").get())) { + for (final CSVRecord csvRecord : csvParser) { + print(csvRecord, csvPrinter); + assertEquals("a,b,c,d,,f|", stringBuilder.toString()); + } + } + } + + @Test + // Regression, already passed before fix + void testParseWithTwoCharDelimiter4() throws Exception { + final Reader in = new StringReader("a~|b~|c~|d~|~|f~~||g"); + final StringBuilder stringBuilder = new StringBuilder(); + try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); + CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("~|").get())) { + for (final CSVRecord csvRecord : csvParser) { + print(csvRecord, csvPrinter); + assertEquals("a,b,c,d,,f~,|g", stringBuilder.toString()); + } + } + } + + @Test + // Before fix: + // expected: but was: + void testParseWithTwoCharDelimiterEndsWithDelimiter() throws Exception { + final Reader in = new StringReader("a~|b~|c~|d~|~|f~|"); + final StringBuilder stringBuilder = new StringBuilder(); + try (CSVPrinter csvPrinter = new CSVPrinter(stringBuilder, CSVFormat.EXCEL); + CSVParser csvParser = CSVParser.parse(in, CSVFormat.Builder.create().setDelimiter("~|").get())) { + for (final CSVRecord csvRecord : csvParser) { + print(csvRecord, csvPrinter); + assertEquals("a,b,c,d,,f,", stringBuilder.toString()); + } + } + } +} diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv290Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv290Test.java index c20c321a61..f251eeb7a5 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv290Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv290Test.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.issues; @@ -56,7 +58,7 @@ // 2 xyz \\b:\b \\t:\t \\n:\n \\r:\r a b // 3 a b,c,d "quoted" e // -public class JiraCsv290Test { +class JiraCsv290Test { private void testHelper(final String fileName, final CSVFormat format) throws Exception { List> content = new ArrayList<>(); @@ -82,17 +84,17 @@ private void testHelper(final String fileName, final CSVFormat format) throws Ex } @Test - public void testPostgresqlCsv() throws Exception { + void testPostgresqlCsv() throws Exception { testHelper("psql.csv", CSVFormat.POSTGRESQL_CSV); } @Test - public void testPostgresqlText() throws Exception { + void testPostgresqlText() throws Exception { testHelper("psql.tsv", CSVFormat.POSTGRESQL_TEXT); } @Test - public void testWriteThenRead() throws Exception { + void testWriteThenRead() throws Exception { final StringWriter sw = new StringWriter(); final CSVFormat format = CSVFormat.POSTGRESQL_CSV.builder().setHeader().setSkipHeaderRecord(true).get(); try (CSVPrinter printer = new CSVPrinter(sw, format)) { diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv294Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv294Test.java index 27d1d31d97..0e5de0751b 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv294Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv294Test.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.issues; @@ -25,7 +27,6 @@ import java.io.IOException; import java.io.InputStreamReader; import java.io.OutputStreamWriter; -import java.io.StringReader; import java.nio.charset.StandardCharsets; import java.util.List; @@ -35,7 +36,7 @@ import org.apache.commons.csv.CSVRecord; import org.junit.jupiter.api.Test; -public class JiraCsv294Test { +class JiraCsv294Test { private static void testInternal(final CSVFormat format, final String expectedSubstring) throws IOException { final ByteArrayOutputStream bos = new ByteArrayOutputStream(); @@ -57,24 +58,24 @@ private static void testInternal(final CSVFormat format, final String expectedSu } @Test - public void testDefaultCsvFormatWithBackslashEscapeWorks() throws IOException { + void testDefaultCsvFormatWithBackslashEscapeWorks() throws IOException { testInternal(CSVFormat.Builder.create().setEscape('\\').get(), ",\"b \\\"\\\"\","); } @Test - public void testDefaultCsvFormatWithNullEscapeWorks() throws IOException { + void testDefaultCsvFormatWithNullEscapeWorks() throws IOException { testInternal(CSVFormat.Builder.create().setEscape(null).get(), ",\"b \"\"\"\"\","); } @Test - public void testDefaultCsvFormatWithQuoteEscapeWorks() throws IOException { + void testDefaultCsvFormatWithQuoteEscapeWorks() throws IOException { // this one doesn't actually work but should behave like setEscape(null) // Printer is writing the expected content but Parser is unable to consume it testInternal(CSVFormat.Builder.create().setEscape('"').get(), ",\"b \"\"\"\"\","); } @Test - public void testDefaultCsvFormatWorks() throws IOException { + void testDefaultCsvFormatWorks() throws IOException { testInternal(CSVFormat.Builder.create().get(), ",\"b \"\"\"\"\","); } } diff --git a/src/test/java/org/apache/commons/csv/issues/JiraCsv93Test.java b/src/test/java/org/apache/commons/csv/issues/JiraCsv93Test.java index 4b6ad53eff..7816412265 100644 --- a/src/test/java/org/apache/commons/csv/issues/JiraCsv93Test.java +++ b/src/test/java/org/apache/commons/csv/issues/JiraCsv93Test.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.issues; @@ -41,7 +43,7 @@ * Jira CSV-253 to a certain extent. *

*/ -public class JiraCsv93Test { +class JiraCsv93Test { private static Object[] objects1 = {"abc", "", null, "a,b,c", 123}; private static Object[] objects2 = {"abc", "NULL", null, "a,b,c", 123}; @@ -50,7 +52,7 @@ private void every(final CSVFormat csvFormat, final Object[] objects, final Stri throws IOException { final String source = csvFormat.format(objects); assertEquals(format, csvFormat.format(objects)); - try (final CSVParser csvParser = csvFormat.parse(new StringReader(source))) { + try (CSVParser csvParser = csvFormat.parse(new StringReader(source))) { final CSVRecord csvRecord = csvParser.iterator().next(); for (int i = 0; i < data.length; i++) { assertEquals(csvRecord.get(i), data[i]); @@ -59,7 +61,7 @@ private void every(final CSVFormat csvFormat, final Object[] objects, final Stri } @Test - public void testWithNotSetNullString() throws IOException { + void testWithNotSetNullString() throws IOException { // @formatter:off every(CSVFormat.DEFAULT, objects1, @@ -89,7 +91,7 @@ public void testWithNotSetNullString() throws IOException { } @Test - public void testWithSetNullStringEmptyString() throws IOException { + void testWithSetNullStringEmptyString() throws IOException { // @formatter:off every(CSVFormat.DEFAULT.builder().setNullString("").get(), objects1, @@ -119,7 +121,7 @@ public void testWithSetNullStringEmptyString() throws IOException { } @Test - public void testWithSetNullStringNULL() throws IOException { + void testWithSetNullStringNULL() throws IOException { // @formatter:off every(CSVFormat.DEFAULT.builder().setNullString("NULL").get(), objects2, diff --git a/src/test/java/org/apache/commons/csv/perf/PerformanceTest.java b/src/test/java/org/apache/commons/csv/perf/PerformanceTest.java index f229112878..bead12378d 100644 --- a/src/test/java/org/apache/commons/csv/perf/PerformanceTest.java +++ b/src/test/java/org/apache/commons/csv/perf/PerformanceTest.java @@ -1,18 +1,20 @@ /* - * Licensed to the Apache Software Foundation (ASF) under one or more - * contributor license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright ownership. - * The ASF licenses this file to You under the Apache License, Version 2.0 - * (the "License"); you may not use this file except in compliance with - * the License. You may obtain a copy of the License at + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at * - * http://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. */ package org.apache.commons.csv.perf; @@ -41,7 +43,7 @@ * * To run this test, use: mvn test -Dtest=PerformanceTest */ -public class PerformanceTest { +class PerformanceTest { private static final String TEST_RESRC = "org/apache/commons/csv/perf/worldcitiespop.txt.gz"; @@ -54,10 +56,8 @@ public static void setUpClass() throws FileNotFoundException, IOException { return; } System.out.println("Decompressing test fixture to: " + BIG_FILE + "..."); - try ( - final InputStream input = new GZIPInputStream( - PerformanceTest.class.getClassLoader().getResourceAsStream(TEST_RESRC)); - final OutputStream output = new FileOutputStream(BIG_FILE)) { + try (InputStream input = new GZIPInputStream(PerformanceTest.class.getClassLoader().getResourceAsStream(TEST_RESRC)); + OutputStream output = new FileOutputStream(BIG_FILE)) { IOUtils.copy(input, output); System.out.println(String.format("Decompressed test fixture %s: %,d bytes.", BIG_FILE, BIG_FILE.length())); } @@ -72,7 +72,7 @@ private BufferedReader createBufferedReader() throws IOException { private long parse(final Reader reader, final boolean traverseColumns) throws IOException { final CSVFormat format = CSVFormat.DEFAULT.builder().setIgnoreSurroundingSpaces(false).get(); long recordCount = 0; - try (final CSVParser parser = format.parse(reader)) { + try (CSVParser parser = format.parse(reader)) { for (final CSVRecord record : parser) { recordCount++; if (traverseColumns) { @@ -100,7 +100,7 @@ private long readLines(final BufferedReader in) throws IOException { public long testParseBigFile(final boolean traverseColumns) throws Exception { final long startMillis = System.currentTimeMillis(); - try (final BufferedReader reader = createBufferedReader()) { + try (BufferedReader reader = createBufferedReader()) { final long count = parse(reader, traverseColumns); final long totalMillis = System.currentTimeMillis() - startMillis; println( @@ -110,7 +110,7 @@ public long testParseBigFile(final boolean traverseColumns) throws Exception { } @Test - public void testParseBigFileRepeat() throws Exception { + void testParseBigFileRepeat() throws Exception { long bestTime = Long.MAX_VALUE; for (int i = 0; i < this.max; i++) { bestTime = Math.min(testParseBigFile(false), bestTime); @@ -119,12 +119,12 @@ public void testParseBigFileRepeat() throws Exception { } @Test - public void testReadBigFile() throws Exception { + void testReadBigFile() throws Exception { long bestTime = Long.MAX_VALUE; long count; for (int i = 0; i < this.max; i++) { final long startMillis; - try (final BufferedReader in = createBufferedReader()) { + try (BufferedReader in = createBufferedReader()) { startMillis = System.currentTimeMillis(); count = readLines(in); } diff --git a/src/test/resources/org/apache/commons/csv/CSV-196/emoji.csv b/src/test/resources/org/apache/commons/csv/CSV-196/emoji.csv new file mode 100644 index 0000000000..0bff7a44f3 --- /dev/null +++ b/src/test/resources/org/apache/commons/csv/CSV-196/emoji.csv @@ -0,0 +1,5 @@ +id,val1,val2,val3,val4,val5,val6,val7,val8,val9,val10,val11,val12,val13,val14,val15 +1,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„ +2,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„ +3,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„ +4,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„,๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„๐Ÿ˜„ \ No newline at end of file diff --git a/src/test/resources/org/apache/commons/csv/CSV-196/japanese.csv b/src/test/resources/org/apache/commons/csv/CSV-196/japanese.csv new file mode 100644 index 0000000000..b06e04bd6a --- /dev/null +++ b/src/test/resources/org/apache/commons/csv/CSV-196/japanese.csv @@ -0,0 +1,4 @@ +id,date,val1,val2,val3,val4,val5,val6,val7,val8,val9,val10,val11,val12,val13,val14,val15 +00000000000001,2017-01-01,ใใกใ‚“ใจ็ฏ€ๅˆ†่ฟ‘ใใซใฏๅ’ฒใ„ใฆใ‚‹ใ€‚่‡ช็„ถใฎๅŠ›ใฃใฆใ™ใ”ใ„ใช๏ฝž,v2,v3,v4,v5,v6,v7,v8,v9,v10,v11,v12,v13,v14,v15 +00000000000002,2017-01-01,ใใกใ‚“ใจ็ฏ€ๅˆ†่ฟ‘ใใซใฏๅ’ฒใ„ใฆใ‚‹ใ€‚่‡ช็„ถใฎๅŠ›ใฃใฆใ™ใ”ใ„ใช๏ฝž,v2,v3,v4,v5,v6,v7,v8,v9,v10,v11,v12,v13,v14,v15 +00000000000003,2017-01-01,ใใกใ‚“ใจ็ฏ€ๅˆ†่ฟ‘ใใซใฏๅ’ฒใ„ใฆใ‚‹ใ€‚่‡ช็„ถใฎๅŠ›ใฃใฆใ™ใ”ใ„ใช๏ฝž,v2,v3,v4,v5,v6,v7,v8,v9,v10,v11,v12,v13,v14,v15 \ No newline at end of file diff --git a/src/test/resources/org/apache/commons/csv/CSV-254/csv-254.csv b/src/test/resources/org/apache/commons/csv/CSV-254/csv-254.csv new file mode 100644 index 0000000000..e7d2972c5a --- /dev/null +++ b/src/test/resources/org/apache/commons/csv/CSV-254/csv-254.csv @@ -0,0 +1,3 @@ +AA,33, +AA,,"" +,33,CC