style: add pre commit hook for style check and format (#29)

* fix: fetch data fail due to different endpoint in SessionDataSet; update Docker configuration and .NET version; enhance command-line options

* fix typo

* style: add pre commit hook for every pr or commit and format code style

* add license check ignore for pre commit check

* remove: delete obsolete iotdb symlink

* fix: add TMPDIR for pre-commit to avoid resolve permission issue

* fix: clean up dotnet temporary folder in pre-commit workflow

Author: lausannel

.github/workflows/pre-commit-format.yml

@@ -0,0 +1,48 @@
+name: Formatting
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - '**'
+  merge_group:
+    branches: [ main ]
+  schedule:
+    - cron: "0 0 * * *"
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  formatting-checks:
+    runs-on: ubuntu-20.04
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup dotnet
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: '9.0.x'
+
+      - name: Setup Python environment (for pre-commit)
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Clean dotnet temporary folder
+        run: |
+          sudo rm -rf /tmp/.dotnet
+
+      - name: Install pre-commit and dependencies
+        run: |
+          pip install pre-commit
+          pre-commit install-hooks
+
+      - name: Run pre-commit checks
+        env:
+          TMPDIR: ${{ runner.temp }}
+          DOTNET_CLI_HOME: ${{ runner.temp }}
+        run: |
+          pre-commit run --all-files

.licenserc.yaml

@@ -32,5 +32,6 @@ header:
     - 'Apache.IoTDB.sln'
     - '.gitignore'
     - '.dockerignore'
+    - '.pre-commit-config.yaml'
 
   comment: on-failure

.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+
+
+repos:
+  - repo: local
+    hooks:
+      - id: dotnet-format
+        name: dotnet format
+        entry: dotnet format --include
+        language: system
+        pass_filenames: true
+        files: '\.(cs|vb|fs|sln|csproj|fsproj)$'
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-added-large-files
+      - id: check-yaml
+      - id: check-json
+      - id: check-xml
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+      - id: codespell
+        args: ["--ignore-words-list=fo,teh,ba"]
+
+exclude: |
+  (?x)^(
+      src/Apache\.IoTDB/Rpc/|
+      .*\.md$
+  )

Apache-IoTDB-Client-CSharp-UserCase/Program.cs

@@ -118,4 +118,3 @@ static async Task Main(string[] args)
     }
 
 }
-

Apache.IoTDB.sln

@@ -26,8 +26,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{DEAC57D3-4
 		docs\time_profile_zh.pdf = docs\time_profile_zh.pdf
 	EndProjectSection
 EndProject
-Project("{E53339B2-1760-4266-BCC7-CA923CBCF16C}") = "docker-compose", "docker-compose.dcproj", "{4D457769-80CB-401F-9155-C3125C04FACD}"
-EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Apache.IoTDB.Data", "src\Apache.IoTDB.Data\Apache.IoTDB.Data.csproj", "{4308656F-D174-49A6-ACE4-15894B017D55}"
 EndProject
 Global

docker-compose-2c2d.yml

@@ -130,4 +130,4 @@ services:
       dockerfile: samples/Apache.IoTDB.Samples/Dockerfile
     command: ["--multi", "localhost:6667", "localhost:6668"]
     # command: ["sleep", "infinity"]
-    network_mode: host
+    network_mode: host

docker-compose.yml

@@ -15,7 +15,7 @@ services:
     networks:
         iotdb-network:
           ipv4_address: 172.18.0.2
-      
+
   iotdb:
    image: apache/iotdb:2.0.1-beta-datanode
    restart: always
@@ -38,7 +38,7 @@ services:
          - dn_rpc_address=iotdb
          - dn_internal_address=iotdb
          - dn_seed_config_node=iotdb-confignode-1:22277
-  
+
   iotdb-confignode-1:
    image: apache/iotdb:2.0.1-beta-confignode
    restart: always
@@ -58,6 +58,6 @@ services:
          - cn_seed_config_node=iotdb-confignode-1:22277
 
 
-networks: 
+networks:
     iotdb-network:
         external: true

launchSettings.json

@@ -11,4 +11,4 @@
       }
     }
   }
-}
+}

samples/Apache.IoTDB.Samples/Dockerfile

@@ -36,4 +36,4 @@ RUN dotnet publish "Apache.IoTDB.Samples.csproj" -c Release -o /app/publish
 FROM base AS final
 WORKDIR /app
 COPY --from=publish /app/publish .
-ENTRYPOINT ["dotnet", "Apache.IoTDB.Samples.dll"]
+ENTRYPOINT ["dotnet", "Apache.IoTDB.Samples.dll"]

samples/Apache.IoTDB.Samples/Program.cs

@@ -35,48 +35,48 @@ public static async Task Main(string[] args)
             () => "localhost",
             description: "Use single endpoint (e.g. --single localhost)");
 
-        var multiOption = new Option<List<string>>(
-            "--multi",
-            description: "Use multiple endpoints (e.g. --multi localhost:6667 localhost:6668)")
-        {
-            AllowMultipleArgumentsPerToken = true
-        };
+            var multiOption = new Option<List<string>>(
+                "--multi",
+                description: "Use multiple endpoints (e.g. --multi localhost:6667 localhost:6668)")
+            {
+                AllowMultipleArgumentsPerToken = true
+            };
 
-        var rootCommand = new RootCommand
+            var rootCommand = new RootCommand
         {
             singleOption,
             multiOption
         };
 
-        rootCommand.SetHandler(async (string single, List<string> multi) =>
-        {
-            var utilsTest = new UtilsTest();
-            utilsTest.TestParseEndPoint();
+            rootCommand.SetHandler(async (string single, List<string> multi) =>
+            {
+                var utilsTest = new UtilsTest();
+                utilsTest.TestParseEndPoint();
 
-            SessionPoolTest sessionPoolTest;
+                SessionPoolTest sessionPoolTest;
 
-            if (!string.IsNullOrEmpty(single) && (multi == null || multi.Count == 0))
-            {
-                sessionPoolTest = new SessionPoolTest(single);
-            }
-            else if (multi != null && multi.Count != 0)
-            {
-                sessionPoolTest = new SessionPoolTest(multi);
-            }
-            else
-            {
-                Console.WriteLine("Please specify either --single or --multi endpoints.");
-                return;
-            }
+                if (!string.IsNullOrEmpty(single) && (multi == null || multi.Count == 0))
+                {
+                    sessionPoolTest = new SessionPoolTest(single);
+                }
+                else if (multi != null && multi.Count != 0)
+                {
+                    sessionPoolTest = new SessionPoolTest(multi);
+                }
+                else
+                {
+                    Console.WriteLine("Please specify either --single or --multi endpoints.");
+                    return;
+                }
 
-            await sessionPoolTest.Test();
+                await sessionPoolTest.Test();
 
-            var tableSessionPoolTest = new TableSessionPoolTest(sessionPoolTest);
-            await tableSessionPoolTest.Test();
+                var tableSessionPoolTest = new TableSessionPoolTest(sessionPoolTest);
+                await tableSessionPoolTest.Test();
 
-        }, singleOption, multiOption);
+            }, singleOption, multiOption);
 
-        await rootCommand.InvokeAsync(args);
+            await rootCommand.InvokeAsync(args);
         }
 
         public static void OpenDebugMode(this SessionPool session)