Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SonarScanで検出されたStaticVectorの範囲外アクセスを修正する #1679

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions sakura_core/util/StaticType.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
#define SAKURA_STATICTYPE_54CC2BD5_4C7C_4584_B515_EF8C533B90EA_H_
#pragma once

#include <stdexcept>

#include "util/string_ex.h"
#include "debug/Debug2.h"

Expand Down Expand Up @@ -62,8 +64,10 @@ class StaticVector{
void push_back(SET_TYPE e)
{
assert(m_nCount<MAX_SIZE);
m_nCount++;
m_aElements[m_nCount-1]=e;
if (MAX_SIZE <= m_nCount) {
throw std::out_of_range("m_nCount is out of range.");
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

範囲外のときにクラッシュさせても既存コードに影響はない建前ですよね?
気付いてないならないのと同じ?って見方もできます。
「何もしない」の危険性を考慮するなら、セオリー通り例外を使えばよいような。

m_aElements[m_nCount++] = e;
}
void resize(int nNewSize)
{
Expand Down
69 changes: 69 additions & 0 deletions tests/unittests/test-statictype.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
/*! @file */
/*
Copyright (C) 2021 Sakura Editor Organization

This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented;
you must not claim that you wrote the original software.
If you use this software in a product, an acknowledgment
in the product documentation would be appreciated but is
not required.

2. Altered source versions must be plainly marked as such,
and must not be misrepresented as being the original software.

3. This notice may not be removed or altered from any source
distribution.
*/
#include <gtest/gtest.h>

#ifndef NOMINMAX
#define NOMINMAX
#endif /* #ifndef NOMINMAX */

#include <tchar.h>
#include <Windows.h>
#include <Shlwapi.h>

#include "util/StaticType.h"

/*!
@brief StaticVectorのテスト
*/
TEST(StaticVector, push_back)
{
// サイズ1の配列を用意する
auto vec = StaticVector<long long, 1>();
const auto& constVec = vec;
EXPECT_EQ(0, vec.size());
EXPECT_EQ(1, vec.max_size());

// 1つめのデータを登録する
vec.push_back(0xabcdef);
EXPECT_EQ(1, vec.size());
EXPECT_EQ(0xabcdef, vec[0]);
EXPECT_EQ(0xabcdef, constVec[0]);

// 飽和したのでこれ以上追加できない
EXPECT_EQ(vec.max_size(), vec.size());

// 追加しようとしてもできないことを確認する

#ifdef _DEBUG
// デバッグビルドでは、正常にクラッシュする
EXPECT_DEATH({ vec.push_back(0xffffff); }, "");
#else
// リリースビルドでもクラッシュする
EXPECT_THROW({ vec.push_back(0xffffff); }, std::out_of_range);
#endif

// 追加できないので、サイズをカウントアップしてはいけない
EXPECT_EQ(1, vec.size());
}
1 change: 1 addition & 0 deletions tests/unittests/tests1.vcxproj
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@
<ClCompile Include="test-sample-disabled.cpp" />
<ClCompile Include="test-sample.cpp" />
<ClCompile Include="test-ssearchoption.cpp" />
<ClCompile Include="test-statictype.cpp" />
<ClCompile Include="test-StdControl.cpp" />
<ClCompile Include="test-string_ex.cpp" />
<ClCompile Include="test-zoom.cpp" />
Expand Down
3 changes: 3 additions & 0 deletions tests/unittests/tests1.vcxproj.filters
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,9 @@
<ClCompile Include="test-czipfile.cpp">
<Filter>Test Files</Filter>
</ClCompile>
<ClCompile Include="test-statictype.cpp">
<Filter>Test Files</Filter>
</ClCompile>
</ItemGroup>
<ItemGroup>
<ClInclude Include="StartEditorProcessForTest.h">
Expand Down