SONARPY-2001:Create GeneratedIPythonFile to hold offset data (#1859)

Author: joke1196

sonar-python-plugin/src/main/java/org/sonar/plugins/python/GeneratedIPythonFile.java

@@ -0,0 +1,56 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.plugins.python;
+
+import java.io.IOException;
+import org.sonar.api.batch.fs.InputFile;
+
+public class GeneratedIPythonFile implements PythonInputFile {
+
+  InputFile wrappedFile;
+
+  private String pythonContent;
+
+  public GeneratedIPythonFile(InputFile wrappedFile, String pythonContent) {
+    this.wrappedFile = wrappedFile;
+    this.pythonContent = pythonContent;
+  }
+  
+  @Override
+  public InputFile wrappedFile() {
+    return wrappedFile;
+  }
+
+  @Override
+  public Kind kind() {
+    return Kind.IPYTHON;
+  }
+
+  @Override
+  public String toString() {
+    return wrappedFile.toString();
+  }
+
+  @Override
+  public String contents() throws IOException {
+    return pythonContent;
+  }
+
+}

sonar-python-plugin/src/main/java/org/sonar/plugins/python/PythonInputFile.java

@@ -19,10 +19,24 @@
  */
 package org.sonar.plugins.python;
 
+import java.io.IOException;
 import org.sonar.api.batch.fs.InputFile;
 
 public interface PythonInputFile {
 
   InputFile wrappedFile();
 
+  default String contents() throws IOException {
+    return wrappedFile().contents();
+  }
+
+  default Kind kind() {
+    return Kind.PYTHON;
+  }
+
+  enum Kind {
+    PYTHON,
+    IPYTHON
+  }
+
 }

sonar-python-plugin/src/main/java/org/sonar/plugins/python/PythonInputFileImpl.java

@@ -28,24 +28,13 @@ public PythonInputFileImpl(InputFile wrappedFile) {
     this.wrappedFile = wrappedFile;
   }
 
+  @Override
   public InputFile wrappedFile() {
-    return this.wrappedFile;
+    return wrappedFile;
   }
 
   @Override
   public String toString() {
     return wrappedFile.toString();
   }
-
-
-  @Override
-  public boolean equals(Object obj) {
-    return wrappedFile.equals(obj);
-  }
-
-
-  @Override
-  public int hashCode() {
-    return wrappedFile.hashCode();
-  }
 }

sonar-python-plugin/src/test/java/org/sonar/plugins/python/GeneratedIPythonFileTest.java

@@ -0,0 +1,63 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.plugins.python;
+
+import java.io.IOException;
+import org.junit.jupiter.api.Test;
+import org.sonar.api.batch.fs.InputFile;
+import org.sonar.api.batch.fs.internal.TestInputFileBuilder;
+import org.sonar.plugins.python.PythonInputFile.Kind;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class GeneratedIPythonFileTest {
+
+  @Test
+  void shouldHaveIPythonKind() {
+    PythonInputFile inputFile = new GeneratedIPythonFile(createWrappedFile(), "");
+    assertThat(inputFile.kind()).isEqualTo(Kind.IPYTHON);
+  }
+
+  @Test
+  void shouldReturnTheWrappedFile() {
+    InputFile wrappedFile = createWrappedFile();
+    GeneratedIPythonFile inputFile = new GeneratedIPythonFile(wrappedFile, "");
+    assertThat(inputFile.wrappedFile()).isEqualTo(wrappedFile);
+  }
+
+  @Test
+  void shouldHaveTheWrappedFileToString() {
+    InputFile wrappedFile = createWrappedFile();
+    PythonInputFile inputFile = new GeneratedIPythonFile(wrappedFile, "");
+    assertThat(inputFile).hasToString(wrappedFile.toString());
+  }
+
+  @Test
+  void shouldHaveTheContentPassed() throws IOException {
+    InputFile wrappedFile = createWrappedFile();
+    PythonInputFile inputFile = new GeneratedIPythonFile(wrappedFile, "test");
+    assertThat(inputFile.contents()).isEqualTo("test");
+
+  }
+
+  private InputFile createWrappedFile() {
+    return TestInputFileBuilder.create("moduleKey", "name").setContents("Some content").build();
+  }
+}

sonar-python-plugin/src/test/java/org/sonar/plugins/python/PythonInputFileImplTest.java

@@ -0,0 +1,55 @@
+/*
+ * SonarQube Python Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.plugins.python;
+
+import java.io.IOException;
+import org.junit.jupiter.api.Test;
+import org.sonar.api.batch.fs.InputFile;
+import org.sonar.api.batch.fs.internal.TestInputFileBuilder;
+import org.sonar.plugins.python.PythonInputFile.Kind;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class PythonInputFileImplTest {
+
+  @Test
+  void shouldHavePythonKind() {
+    PythonInputFile inputFile = new PythonInputFileImpl(createWrappedFile());
+    assertThat(inputFile.kind()).isEqualTo(Kind.PYTHON);
+  }
+
+  @Test
+  void shouldHaveTheWrappedFileToString() {
+    InputFile wrappedFile = createWrappedFile();
+    PythonInputFile inputFile = new PythonInputFileImpl(wrappedFile);
+    assertThat(inputFile).hasToString(wrappedFile.toString());
+  }
+
+  @Test
+  void shouldReturnTheContentOfTheWrappedFile() throws IOException {
+    InputFile wrappedFile = createWrappedFile();
+    PythonInputFile inputFile = new PythonInputFileImpl(wrappedFile);
+    assertThat(inputFile.contents()).isEqualTo(wrappedFile.contents());
+  }
+
+  private InputFile createWrappedFile() {
+    return TestInputFileBuilder.create("moduleKey", "name").setContents("Test").build();
+  }
+}