e-dialect
diff --git a/‎.github/workflows/e2e.yml
Lines changed: 6 additions & 0 deletions b/‎.github/workflows/e2e.yml
Lines changed: 6 additions & 0 deletions
diff --git a/‎.github/workflows/lint.yml
Lines changed: 2 additions & 7 deletions b/‎.github/workflows/lint.yml
Lines changed: 2 additions & 7 deletions
diff --git a/‎.gitignore
Lines changed: 1 addition & 0 deletions b/‎.gitignore
Lines changed: 1 addition & 0 deletions
diff --git a/‎LICENSE
Lines changed: 674 additions & 0 deletions b/‎LICENSE
Lines changed: 674 additions & 0 deletions
diff --git a/‎TESTING.md
Lines changed: 54 additions & 0 deletions b/‎TESTING.md
Lines changed: 54 additions & 0 deletions
diff --git a/‎hinghwa-dict-backend/AudioCompare/FFT.py
Lines changed: 7 additions & 4 deletions b/‎hinghwa-dict-backend/AudioCompare/FFT.py
Lines changed: 7 additions & 4 deletions
diff --git a/‎hinghwa-dict-backend/AudioCompare/InputFile.py
Lines changed: 12 additions & 11 deletions b/‎hinghwa-dict-backend/AudioCompare/InputFile.py
Lines changed: 12 additions & 11 deletions
diff --git a/‎hinghwa-dict-backend/AudioCompare/Matcher.py
Lines changed: 33 additions & 15 deletions b/‎hinghwa-dict-backend/AudioCompare/Matcher.py
Lines changed: 33 additions & 15 deletions
diff --git a/‎hinghwa-dict-backend/AudioCompare/common.py
Lines changed: 3 additions & 0 deletions b/‎hinghwa-dict-backend/AudioCompare/common.py
Lines changed: 3 additions & 0 deletions
diff --git a/‎hinghwa-dict-backend/AudioCompare/error.py
Lines changed: 0 additions & 2 deletions b/‎hinghwa-dict-backend/AudioCompare/error.py
Lines changed: 0 additions & 2 deletions
diff --git a/‎hinghwa-dict-backend/HinghwaDict/asgi.py
Lines changed: 1 addition & 1 deletion b/‎hinghwa-dict-backend/HinghwaDict/asgi.py
Lines changed: 1 addition & 1 deletion
@@ -34,6 +34,9 @@ jobs:
           python3 manage.py makemigrations
           python3 manage.py migrate
           DJANGO_SUPERUSER_PASSWORD=testtest123 python manage.py createsuperuser --username admin --email [email protected] --no-input
+          DJANGO_SUPERUSER_PASSWORD=testtest222 python manage.py createsuperuser --username admin2 --email [email protected] --no-input
+          echo -e "from django.contrib.auth.models import User\nuser=User.objects.create_user('user_test','user_test@user_test.com','123456')\nuser.set_password('123456')\nuser.save()\nexit()" | python manage.py shell
+          echo -e "from django.contrib.auth.models import User\nuser=User.objects.create_user('user_test_old_password','user_test_old_password@user_test_old_password.com','12')\nuser.set_password('12')\nuser.save()\nexit()"| python manage.py shell
           python3 manage.py runserver &
       - uses: actions/setup-node@v3
         with:
@@ -44,6 +47,9 @@ jobs:
       - name: Run tests
         run: |
           curl 127.0.0.1:8000/users/1
+          curl 127.0.0.1:8000/users/2
+          curl 127.0.0.1:8000/users/3
+          curl 127.0.0.1:8000/users/4
           cd tests
           for test in `ls .`
           do
 
@@ -22,12 +22,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install pylint
-          pip install pylint-django
-          cd hinghwa-dict-backend
-          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-          sudo apt-get update
-          sudo apt-get install ffmpeg -y
+          pip install black
 
       - name: Get changed files
         id: changed-files
@@ -38,6 +33,6 @@ jobs:
           for file in ${{ steps.changed-files.outputs.all_changed_files }} ; do
             # check if file is python file
             if [[ ${file} == *.py ]]; then
-              DJANGO_SETTINGS_MODULE=HinghwaDict.settings pylint --load-plugins pylint_django ${file}
+              black --check ${file}
             fi
           done
@@ -6,3 +6,4 @@ material
 logs
 .env
 db.sqlite3
+migrations
@@ -0,0 +1,54 @@
+## 测试说明
+
+### 原则
+
+理论上的测试类型包括：
+
+- 单元测试（Unit test）
+- 集成测试（Integration test）
+- 端到端测试（End-to-End test, e2e test）
+
+然而在这个项目中，由于时间精力和函数的实际复杂程度，我们直接使用端到端测试检验函数的正确性。（正常来说，应该是金字塔模型： 底部是单元测试，中间是集成测试，最上层是端到端测试）
+
+一个功能的上线要经过下列流程：
+
+- 发起 Pull Request 提交代码（具体见 [CONTRIBUTING.md](CONTRIBUTING.md) ）
+- 运行 [CI](./.github/workflows) 进行 `Github Actions` 进行一些相应的检查
+- 部署到测试服务器进行测试
+- 上线服务至正式服务器
+
+### CI
+
+CI，（*Continuous Integration*，持续集成），是一个可以帮助我们控制代码质量的好方法。
+
+在本项目目前的 CI 包括：
+
+- e2e：运行 [`tests`](./tests) 文件夹中的 `Apifox` 自动化测试脚本进行端到端测试
+- lint：通过 `blank` 进行代码格式化检查
+
+在运行端到端测试时，在会通过以下命令创建初始数据库：
+
+
+```shell
+python3 manage.py makemigrations
+python3 manage.py migrate
+DJANGO_SUPERUSER_PASSWORD=testtest123 python manage.py createsuperuser --username admin --email [email protected] --no-input
+DJANGO_SUPERUSER_PASSWORD=testtest222 python manage.py createsuperuser --username admin2 --email [email protected] --no-input
+```
+
+> 创建两个用户的原因是在目前的代码中，发送邮件默认是由2号用户进行发送。
+
+而在启动服务之后，你需要首先运行：
+
+```shell
+curl 127.0.0.1:8000/users/1
+curl 127.0.0.1:8000/users/2
+```
+
+其原因是：直接创建的用户只有 Django 默认的用户模型，不包括我们自定义的 `UserInfo` 模型，在获取用户模块中实现了自动创建功能，否则在其他模块调用时会出错。
+
+#### Apifox 自动化测试
+
+- 在 `Apifox` - `自动化测试` - `测试用例` 中添加相应的测试用例或测试套件。
+- 选择 `测试环境` 导出 `Apifox CLI` 格式的 `json` 源文件，格式化后放入 `tests` 文件夹即可。
+- 测试套件或测试用例可以自己根据需要进行组合、拼装。
@@ -32,9 +32,12 @@ def series(self, chunks=-1):
         samples = self.input_file.get_audio_samples(chunks * self.chunk_size)
         # mix those samples down into one channel
         samples = samples.mean(axis=0)
-        result = self.specgram(samples, NFFT=self.chunk_size,
-                               window=FFT.__window_hanning,
-                               noverlap=int(self.chunk_size / self.overlap_ratio))
+        result = self.specgram(
+            samples,
+            NFFT=self.chunk_size,
+            window=FFT.__window_hanning,
+            noverlap=int(self.chunk_size / self.overlap_ratio),
+        )
         result = result.transpose()
         return result
 
@@ -65,7 +68,7 @@ def specgram(self, x, NFFT, window, noverlap):
 
         # do the ffts of the slices
         for i in range(n):
-            thisX = x[ind[i]:ind[i] + NFFT]
+            thisX = x[ind[i] : ind[i] + NFFT]
             thisX = windowVals * thisX
             fx = np.fft.fft(thisX, n=NFFT)
             Pxx[:, i] = np.conjugate(fx[:numFreqs]) * fx[:numFreqs]
 
@@ -8,7 +8,6 @@
 
 
 class InputFile:
-
     def __init__(self, filename):
         """Open an Audio file with the given file path.
         Supported formats: WAVE, MP3.
@@ -27,7 +26,7 @@ def __init__(self, filename):
         original_name = filename
         self.wav_file = open(filename, "rb")
         # try to use lame to convert
-        self.workingdir = os.path.join(os.getcwd(), 'temp')
+        self.workingdir = os.path.join(os.getcwd(), "temp")
         if not os.path.exists(self.workingdir):
             os.makedirs(self.workingdir)
         if not self.__is_wave_file(self.wav_file):
@@ -37,14 +36,16 @@ def __init__(self, filename):
             # make sure the filename has a ".mp3" extension before sending to lame
             if filename[-4:] != ".mp3":
                 # create a copy of the file in
-                temp_file_name = os.path.join(self.workingdir, str(time.time()) + ".mp3")
+                temp_file_name = os.path.join(
+                    self.workingdir, str(time.time()) + ".mp3"
+                )
                 shutil.copyfile(filename, temp_file_name)
                 filename = temp_file_name
             # Use lame to make a wav representation of the mp3 file to be analyzed
-            lame = [lame, '--silent', '--decode', filename, canonical_form]
+            lame = [lame, "--silent", "--decode", filename, canonical_form]
 
             music = pydub.AudioSegment.from_file(filename)
-            music.export(canonical_form, format='wav')
+            music.export(canonical_form, format="wav")
 
             if not os.path.exists(canonical_form):
                 raise IOError("{f} 's format is not supported".format(f=original_name))
@@ -67,22 +68,22 @@ def __init__(self, filename):
 
         self.wav_file.seek(40, 0)
         self.data_chunk_size = InputFile.__read_size(self.wav_file)
-        self.total_samples = (self.data_chunk_size / self.block_align)
+        self.total_samples = self.data_chunk_size / self.block_align
 
     @staticmethod
     def __is_wave_file(file):
 
-        if (not InputFile.__check_riff_format(file)):
+        if not InputFile.__check_riff_format(file):
             return False
-        if (not InputFile.__check_wave_id(file)):
+        if not InputFile.__check_wave_id(file):
             return False
-        if (not InputFile.__check_fmt(file)):
+        if not InputFile.__check_fmt(file):
             return False
 
         file.seek(20)
         data = file.read(2)
         file.seek(0)
-        if (not InputFile.__check_fmt_valid(data)):
+        if not InputFile.__check_fmt_valid(data):
             return False
         return InputFile.__check_data(file)
 
@@ -146,7 +147,7 @@ def get_audio_samples(self, n):
         data = np.fromfile(self.wav_file, dtype=np.int16, count=n * self.channels)
         result = np.zeros((self.channels, n), dtype=int)
         for c in range(self.channels):
-            result[c] = data[c::self.channels]
+            result[c] = data[c :: self.channels]
 
         return result
 
 
@@ -16,7 +16,7 @@
 BUCKET_SIZE = 20
 BUCKETS = 4
 BITS_PER_NUMBER = int(math.ceil(math.log(BUCKET_SIZE, 2)))
-assert ((BITS_PER_NUMBER * BUCKETS) <= 32)
+assert (BITS_PER_NUMBER * BUCKETS) <= 32
 
 NORMAL_CHUNK_SIZE = 1024
 NORMAL_SAMPLE_RATE = 44100.0
@@ -67,9 +67,13 @@ def __str__(self):
         short_file2 = os.path.basename(self.file2)
         if self.score > SCORE_THRESHOLD:
             if self.file1_len < self.file2_len:
-                return "MATCH {f1} {f2} ({s})".format(f1=short_file1, f2=short_file2, s=self.score)
+                return "MATCH {f1} {f2} ({s})".format(
+                    f1=short_file1, f2=short_file2, s=self.score
+                )
             else:
-                return "MATCH {f2} {f1} ({s})".format(f1=short_file1, f2=short_file2, s=self.score)
+                return "MATCH {f2} {f1} ({s})".format(
+                    f1=short_file1, f2=short_file2, s=self.score
+                )
         else:
             return "NO MATCH"
 
@@ -91,7 +95,7 @@ def _to_fingerprints(freq_chunks):
             end_index = (bucket + 1) * BUCKET_SIZE
             bucket_vals = freq_chunks[chunk][start_index:end_index]
             max_index = bucket_vals.argmax()
-            fingerprint += (max_index << (bucket * BITS_PER_NUMBER))
+            fingerprint += max_index << (bucket * BITS_PER_NUMBER)
         fingerprints[chunk] = fingerprint
 
     # return the indexes of the loudest frequencies
@@ -116,7 +120,7 @@ def _file_fingerprint(filename):
         # file. It is important that each chunk represent the
         # same amount of time, regardless of the sample
         # rate of the file.
-        chunk_size_adjust_factor = (NORMAL_SAMPLE_RATE / file.get_sample_rate())
+        chunk_size_adjust_factor = NORMAL_SAMPLE_RATE / file.get_sample_rate()
         fft = FFT(file, int(NORMAL_CHUNK_SIZE / chunk_size_adjust_factor))
         series = fft.series()
 
@@ -153,7 +157,7 @@ def __init__(self, dir1, dir2):
         them for files."""
         self.dir1 = dir1
         self.dir2 = dir2
-        if os.path.split(dir2)[1] != 'submit':
+        if os.path.split(dir2)[1] != "submit":
             self.change = True
         else:
             self.change = False
@@ -196,7 +200,11 @@ def __search_dir(dir):
             if stat.S_ISREG(node_stat.st_mode):
                 results.append(abs_node)
             else:
-                warn("An inode that is not a regular file was found at {f}".format(abs_node))
+                warn(
+                    "An inode that is not a regular file was found at {f}".format(
+                        abs_node
+                    )
+                )
 
         return results
 
@@ -288,7 +296,9 @@ def __report_file_matches(file, master_hash, file_lengths):
             else:
                 score = 0
 
-            results.append(MatchResult(file.filename, f, file.file_len, file_lengths[f], score))
+            results.append(
+                MatchResult(file.filename, f, file.file_len, file_lengths[f], score)
+            )
 
         return results
 
@@ -321,13 +331,15 @@ def match(self):
             # map2_result = [_file_fingerprint(item) for item in dir2_files]
             # map1_result = pool.map_async(_file_fingerprint, dir1_files)
             dir1_results = map1_result
-            if self.change or not os.path.exists(os.path.join(os.getcwd(), 'submit结果存储.pkl')):
+            if self.change or not os.path.exists(
+                os.path.join(os.getcwd(), "submit结果存储.pkl")
+            ):
                 map2_result = [_file_fingerprint(item) for item in dir2_files]
                 dir2_results = map2_result
-                with open(os.path.join(os.getcwd(), 'submit结果存储.pkl'), 'wb') as f:
+                with open(os.path.join(os.getcwd(), "submit结果存储.pkl"), "wb") as f:
                     pickle.dump(dir2_results, f)
             else:
-                with open(os.path.join(os.getcwd(), 'submit结果存储.pkl'), 'rb') as f:
+                with open(os.path.join(os.getcwd(), "submit结果存储.pkl"), "rb") as f:
                     dir2_results = pickle.load(f)
                 print(len(dir2_results))
             # Wait for pool to finish processing
@@ -337,7 +349,7 @@ def match(self):
             # dir2_results = map2_result
             # Get results from process pool
 
-            shutil.rmtree(os.path.join(os.getcwd(), 'temp'))
+            shutil.rmtree(os.path.join(os.getcwd(), "temp"))
         except KeyboardInterrupt:
             # pool.terminate()
             raise
@@ -351,8 +363,12 @@ def match(self):
 
         # Proceed only with fingerprints that were computed
         # successfully
-        dir1_successes = list(filter(lambda x: x.success and x.file_len > 0, dir1_results))
-        dir2_successes = list(filter(lambda x: x.success and x.file_len > 0, dir2_results))
+        dir1_successes = list(
+            filter(lambda x: x.success and x.file_len > 0, dir1_results)
+        )
+        dir2_successes = list(
+            filter(lambda x: x.success and x.file_len > 0, dir2_results)
+        )
 
         # Empty files should match other empty files
         # Our matching algorithm will not report these as a match,
@@ -400,7 +416,9 @@ def match(self):
             # same time difference relative to each
             # other. This indicates that the two files
             # contain similar audio.
-            file_matches = Matcher.__report_file_matches(file, master_hash, file_lengths)
+            file_matches = Matcher.__report_file_matches(
+                file, master_hash, file_lengths
+            )
             results.extend(file_matches)
 
         return results
@@ -1,15 +1,18 @@
 class BaseResult(object):
     """Used to report results of operations
     performed in our algorithms."""
+
     def __init__(self, success, message):
         self.success = success
         self.message = message
 
     def __str__(self):
         return self.message
 
+
 class FileErrorResult(BaseResult):
     """A result that indicates there was an error
     operating on a file."""
+
     def __init__(self, message):
         super(FileErrorResult, self).__init__(False, message)
@@ -8,5 +8,3 @@ def die(msg):
 
 def warn(msg):
     print(sys.stderr, "ERROR: {e}".format(e=msg))
-
-
@@ -11,6 +11,6 @@
 
 from django.core.asgi import get_asgi_application
 
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'HinghwaDict.settings')
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "HinghwaDict.settings")
 
 application = get_asgi_application()