From 4da405e4c7e179d5c16d5290a2588e91a7533908 Mon Sep 17 00:00:00 2001
From: Kumar Kartikay <krkartikay@gmail.com>
Date: Wed, 26 Feb 2020 03:11:51 +0530
Subject: [PATCH] fix #301584: test for duplicates names in palette

adds a test for checking if there are duplicate
names in the palettes in the default workspaces
and manually removed the duplicate items by making
the names more descriptive.
---
 mtest/CMakeLists.txt                 |   1 +
 mtest/mscore/palette/CMakeLists.txt  |  24 +++++
 mtest/mscore/palette/tst_palette.cpp | 139 +++++++++++++++++++++++++++
 mtest/mtest.cpp                      |   1 +
 share/workspaces/Advanced.xml        |  80 +++++++--------
 share/workspaces/Basic.xml           |  24 ++---
 6 files changed, 217 insertions(+), 52 deletions(-)
 create mode 100644 mtest/mscore/palette/CMakeLists.txt
 create mode 100644 mtest/mscore/palette/tst_palette.cpp

diff --git a/mtest/CMakeLists.txt b/mtest/CMakeLists.txt
index 9069b9f261b38..f19a223ef0e74 100644
--- a/mtest/CMakeLists.txt
+++ b/mtest/CMakeLists.txt
@@ -235,6 +235,7 @@ subdirs (
 #        libmscore/text        work in progress...
         libmscore/utils
         mscore/workspaces
+        mscore/palette
         importmidi
         capella
         biab
diff --git a/mtest/mscore/palette/CMakeLists.txt b/mtest/mscore/palette/CMakeLists.txt
new file mode 100644
index 0000000000000..238be5585ad77
--- /dev/null
+++ b/mtest/mscore/palette/CMakeLists.txt
@@ -0,0 +1,24 @@
+#=============================================================================
+#  MuseScore
+#  Music Composition & Notation
+#
+#  Copyright (C) 2020 MuseScore BVBA and others
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License version 2.
+#
+#  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 General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with this program; if not, write to the Free Software
+#  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+#=============================================================================
+
+set(TARGET tst_palette)
+
+set(MTEST_LINK_MSCOREAPP TRUE)
+
+include(${PROJECT_SOURCE_DIR}/mtest/cmake.inc)
diff --git a/mtest/mscore/palette/tst_palette.cpp b/mtest/mscore/palette/tst_palette.cpp
new file mode 100644
index 0000000000000..80e602893e85f
--- /dev/null
+++ b/mtest/mscore/palette/tst_palette.cpp
@@ -0,0 +1,139 @@
+//=============================================================================
+//  MuseScore
+//  Music Composition & Notation
+//
+//  Copyright (C) 2020 MuseScore BVBA and others
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License version 2
+//  as published by the Free Software Foundation and appearing in
+//  the file LICENCE.GPL
+//=============================================================================
+
+#include <QtTest/QtTest>
+#include "mtest/testutils.h"
+#include "mscore/musescore.h"
+#include "mscore/workspace.h"
+#include "mscore/palette/palettemodel.h"
+#include "mscore/palette/palettetree.h"
+
+using namespace Ms;
+
+class TestPaletteModel : public QObject, public MTest
+      {
+      Q_OBJECT
+
+      PaletteTreeModel* paletteModel;
+      QMap<QString, vector<QString>> paletteItemNames;
+
+      void initMuseScore();
+      void iterateOverModel(QAbstractItemModel *model, QModelIndex parent = QModelIndex());
+      void loadPaletteModel(QString name);
+
+   private slots:
+      void initTestCase();
+      void cleanupTestCase();
+
+      void testDuplicateItemNames_data();
+      void testDuplicateItemNames();
+      };
+
+//---------------------------------------------------------
+//   TestPaletteModel::testDuplicateItemNames_data
+//---------------------------------------------------------
+
+void TestPaletteModel::testDuplicateItemNames_data()
+      {
+      QTest::addColumn<QString>("workspaceName");
+      QTest::addRow("Basic") << "Basic";
+      QTest::addRow("Advanced") << "Advanced";
+      }
+
+//---------------------------------------------------------
+//   TestPaletteModel::testDuplicateItemNames
+//---------------------------------------------------------
+
+void TestPaletteModel::testDuplicateItemNames()
+      {
+      QFETCH(QString, workspaceName);
+      loadPaletteModel(workspaceName);
+      paletteItemNames.clear();
+      iterateOverModel(paletteModel);
+      bool duplicates = false;
+      qDebug("In %s workspace", qPrintable(workspaceName));
+      for (auto name = paletteItemNames.begin(); name != paletteItemNames.end(); ++name) {
+            if (name.value().size() != 1) {
+                  duplicates = true;
+                  for (auto parent : name.value())
+                        qDebug("%s (in %s)", qPrintable(name.key()), qPrintable(parent));
+                  }
+            }
+      // make sure there are no duplicates
+      QVERIFY(!duplicates);
+      }
+
+//---------------------------------------------------------
+//   TestPaletteModel::iterateOverModel
+//---------------------------------------------------------
+
+void TestPaletteModel::iterateOverModel(QAbstractItemModel* model, QModelIndex parent)
+      {
+      for (int r = 0; r < model->rowCount(parent); ++r) {
+            QModelIndex index = model->index(r, 0, parent);
+            QString name = model->data(index).toString();
+            QString parentName = model->data(parent).toString();
+            
+            paletteItemNames[name].push_back(parentName);
+            
+            if (model->hasChildren(index))
+                  iterateOverModel(model, index);
+            }
+      }
+
+//---------------------------------------------------------
+//   TestPaletteModel::initTestCase
+//---------------------------------------------------------
+
+void TestPaletteModel::initTestCase()
+      {
+      initMuseScore();
+      }
+
+//---------------------------------------------------------
+//   TestPaletteModel::loadPaletteModel
+//---------------------------------------------------------
+
+void TestPaletteModel::loadPaletteModel(QString name)
+      {
+      Workspace* w = WorkspacesManager::findByName(name);
+      paletteModel = new PaletteTreeModel(w->getPaletteTree());
+      }
+
+//---------------------------------------------------------
+//   TestPaletteModel::initMuseScore
+//---------------------------------------------------------
+
+void TestPaletteModel::initMuseScore()
+      {
+      qputenv("QML_DISABLE_DISK_CACHE", "true");
+      qSetMessagePattern("%{function}: %{message}");
+      MScore::noGui = true;
+      MScore::testMode = true;
+      initMuseScoreResources();
+      QStringList temp;
+      MuseScore::init(temp);
+      }
+
+//---------------------------------------------------------
+//   TestPaletteModel::cleanupTestCase
+//---------------------------------------------------------
+
+void TestPaletteModel::cleanupTestCase()
+      {
+      qApp->processEvents();
+      delete Ms::mscore;
+      Ms::mscore = nullptr;
+      }
+
+QTEST_MAIN(TestPaletteModel)
+#include "tst_palette.moc"
diff --git a/mtest/mtest.cpp b/mtest/mtest.cpp
index 2bf1c17c069a1..3f480ee31fa53 100644
--- a/mtest/mtest.cpp
+++ b/mtest/mtest.cpp
@@ -57,6 +57,7 @@ const char* tests[] = {
       "libmscore/selectionrangedelete/tst_selectionrangedelete",
       "libmscore/parts/tst_parts",
       "testscript/tst_runscripts",
+      "mscore/palette/tst_palette"
 #endif
 #if 0
       "libmscore/spanners/tst_spanners",              // FAIL
diff --git a/share/workspaces/Advanced.xml b/share/workspaces/Advanced.xml
index 521fa19f9b868..5e02047f342ba 100644
--- a/share/workspaces/Advanced.xml
+++ b/share/workspaces/Advanced.xml
@@ -403,7 +403,7 @@
           <Bracket type="Square">
             </Bracket>
           </Cell>
-        <Cell name="Line">
+        <Cell name="Line Bracket">
           <Bracket type="Line">
             </Bracket>
           </Cell>
@@ -998,7 +998,7 @@
             <name>noteShapeTriangleRoundWhite</name>
             </NoteHead>
           </Cell>
-        <Cell name="Add parentheses to element">
+        <Cell name="Add parentheses to notehead">
           <Icon>
             <subtype>22</subtype>
             <action>add-parentheses</action>
@@ -1127,7 +1127,7 @@
             <track>0</track>
             </Ottava>
           </Cell>
-        <Cell name="Pedal">
+        <Cell name="Pedal (with ped and line)">
           <Pedal id="18">
             <endHookType>1</endHookType>
             <beginText>&lt;sym&gt;keyboardPedalPed&lt;/sym&gt;</beginText>
@@ -1135,7 +1135,7 @@
             <track>0</track>
             </Pedal>
           </Cell>
-        <Cell name="Pedal">
+        <Cell name="Pedal (with ped and asterisk)">
           <Pedal id="19">
             <beginText>&lt;sym&gt;keyboardPedalPed&lt;/sym&gt;</beginText>
             <continueText>(&lt;sym&gt;keyboardPedalPed&lt;/sym&gt;)</continueText>
@@ -1144,28 +1144,28 @@
             <track>0</track>
             </Pedal>
           </Cell>
-        <Cell name="Pedal">
+        <Cell name="Pedal (straight lines)">
           <Pedal id="20">
             <endHookType>1</endHookType>
             <beginHookType>1</beginHookType>
             <track>0</track>
             </Pedal>
           </Cell>
-        <Cell name="Pedal">
+        <Cell name="Pedal (diagonal end line)">
           <Pedal id="21">
             <endHookType>2</endHookType>
             <beginHookType>1</beginHookType>
             <track>0</track>
             </Pedal>
           </Cell>
-        <Cell name="Pedal">
+        <Cell name="Pedal (both diagonal lines)">
           <Pedal id="22">
             <endHookType>2</endHookType>
             <beginHookType>2</beginHookType>
             <track>0</track>
             </Pedal>
           </Cell>
-        <Cell name="Pedal">
+        <Cell name="Pedal (diagonal start line)">
           <Pedal id="23">
             <endHookType>1</endHookType>
             <beginHookType>2</beginHookType>
@@ -1291,19 +1291,19 @@
             <subtype>double</subtype>
             </BarLine>
           </Cell>
-        <Cell name="Start repeat">
+        <Cell name="Start repeat (Barline)">
           <staff>1</staff>
           <BarLine>
             <subtype>start-repeat</subtype>
             </BarLine>
           </Cell>
-        <Cell name="End repeat">
+        <Cell name="End repeat (Barline)">
           <staff>1</staff>
           <BarLine>
             <subtype>end-repeat</subtype>
             </BarLine>
           </Cell>
-        <Cell name="End-start repeat">
+        <Cell name="End-start repeat (Barline)">
           <staff>1</staff>
           <BarLine>
             <subtype>end-start-repeat</subtype>
@@ -1368,32 +1368,32 @@
             <subtype>0</subtype>
             </Arpeggio>
           </Cell>
-        <Cell name="Arpeggio">
+        <Cell name="Up arpeggio">
           <Arpeggio>
             <subtype>1</subtype>
             </Arpeggio>
           </Cell>
-        <Cell name="Arpeggio">
+        <Cell name="Down arpeggio">
           <Arpeggio>
             <subtype>2</subtype>
             </Arpeggio>
           </Cell>
-        <Cell name="Arpeggio">
+        <Cell name="Bracket arpeggio">
           <Arpeggio>
             <subtype>3</subtype>
             </Arpeggio>
           </Cell>
-        <Cell name="Arpeggio">
+        <Cell name="Up straight arpeggio">
           <Arpeggio>
             <subtype>4</subtype>
             </Arpeggio>
           </Cell>
-        <Cell name="Arpeggio">
+        <Cell name="Down straight arpeggio">
           <Arpeggio>
             <subtype>5</subtype>
             </Arpeggio>
           </Cell>
-        <Cell name="Glissando">
+        <Cell name="Straight glissando">
           <Glissando id="36">
             <text>gliss.</text>
             <ticks>0</ticks>
@@ -1403,7 +1403,7 @@
             <length>100</length>
             </Glissando>
           </Cell>
-        <Cell name="Glissando">
+        <Cell name="Wavy glissando">
           <Glissando id="37">
             <text>gliss.</text>
             <subtype>1</subtype>
@@ -1589,7 +1589,7 @@
             <text>mute</text>
             </StaffText>
           </Cell>
-        <Cell name="Open" trElement="1">
+        <Cell name="Open (Text)" trElement="1">
           <StaffText>
             <channelSwitch voice="0" name="open"/>
             <text>open</text>
@@ -1603,7 +1603,7 @@
         <mag>0.65</mag>
         <grid>1</grid>
         <moreElements>0</moreElements>
-        <Cell name="Tempo text">
+        <Cell name="Half note equals 80 tempo text">
           <mag>1.5</mag>
           <Tempo>
             <tempo>2.66667</tempo>
@@ -1611,7 +1611,7 @@
             <text><sym>metNoteHalfUp</sym> = 80</text>
             </Tempo>
           </Cell>
-        <Cell name="Tempo text">
+        <Cell name="Quarter note equals 80 tempo text">
           <mag>1.5</mag>
           <Tempo>
             <tempo>1.33333</tempo>
@@ -1619,7 +1619,7 @@
             <text><sym>metNoteQuarterUp</sym> = 80</text>
             </Tempo>
           </Cell>
-        <Cell name="Tempo text">
+        <Cell name="8th note equals 80 tempo text">
           <mag>1.5</mag>
           <Tempo>
             <tempo>0.666667</tempo>
@@ -1627,7 +1627,7 @@
             <text><sym>metNote8thUp</sym> = 80</text>
             </Tempo>
           </Cell>
-        <Cell name="Tempo text">
+        <Cell name="Dotted Half note equals 80 tempo text">
           <mag>1.5</mag>
           <Tempo>
             <tempo>4</tempo>
@@ -1635,7 +1635,7 @@
             <text><sym>metNoteHalfUp</sym><sym>space</sym><sym>metAugmentationDot</sym> = 80</text>
             </Tempo>
           </Cell>
-        <Cell name="Tempo text">
+        <Cell name="Dotted Quarter note equals 80 tempo text">
           <mag>1.5</mag>
           <Tempo>
             <tempo>2</tempo>
@@ -1643,7 +1643,7 @@
             <text><sym>metNoteQuarterUp</sym><sym>space</sym><sym>metAugmentationDot</sym> = 80</text>
             </Tempo>
           </Cell>
-        <Cell name="Tempo text">
+        <Cell name="Dotted 8th note equals 80 tempo text">
           <mag>1.5</mag>
           <Tempo>
             <tempo>1</tempo>
@@ -1658,70 +1658,70 @@
             <text>Grave</text>
             </Tempo>
           </Cell>
-        <Cell name="Tempo text">
+        <Cell name="Largo">
           <mag>1.3</mag>
           <Tempo>
             <tempo>0.833333</tempo>
             <text>Largo</text>
             </Tempo>
           </Cell>
-        <Cell name="Tempo text">
+        <Cell name="Lento">
           <mag>1.3</mag>
           <Tempo>
             <tempo>0.875</tempo>
             <text>Lento</text>
             </Tempo>
           </Cell>
-        <Cell name="Tempo text">
+        <Cell name="Adagio">
           <mag>1.3</mag>
           <Tempo>
             <tempo>1.18333</tempo>
             <text>Adagio</text>
             </Tempo>
           </Cell>
-        <Cell name="Tempo text">
+        <Cell name="Andante">
           <mag>1.3</mag>
           <Tempo>
             <tempo>1.53333</tempo>
             <text>Andante</text>
             </Tempo>
           </Cell>
-        <Cell name="Tempo text">
+        <Cell name="Moderato">
           <mag>1.3</mag>
           <Tempo>
             <tempo>1.9</tempo>
             <text>Moderato</text>
             </Tempo>
           </Cell>
-        <Cell name="Tempo text">
+        <Cell name="Allegretto">
           <mag>1.3</mag>
           <Tempo>
             <tempo>1.93333</tempo>
             <text>Allegretto</text>
             </Tempo>
           </Cell>
-        <Cell name="Tempo text">
+        <Cell name="Allegro">
           <mag>1.3</mag>
           <Tempo>
             <tempo>2.4</tempo>
             <text>Allegro</text>
             </Tempo>
           </Cell>
-        <Cell name="Tempo text">
+        <Cell name="Vivace">
           <mag>1.3</mag>
           <Tempo>
             <tempo>2.86667</tempo>
             <text>Vivace</text>
             </Tempo>
           </Cell>
-        <Cell name="Tempo text">
+        <Cell name="Presto">
           <mag>1.3</mag>
           <Tempo>
             <tempo>3.11667</tempo>
             <text>Presto</text>
             </Tempo>
           </Cell>
-        <Cell name="Metric modulation">
+        <Cell name="Quarter note = Dotted Quarter note metric modulation">
           <mag>1.5</mag>
           <Tempo>
             <tempo>2</tempo>
@@ -1729,7 +1729,7 @@
             <text><sym>metNoteQuarterUp</sym> = <sym>metNoteQuarterUp</sym><sym>space</sym><sym>metAugmentationDot</sym></text>
             </Tempo>
           </Cell>
-        <Cell name="Metric modulation">
+        <Cell name="Dotted Quarter note = Quarter note metric modulation">
           <mag>1.5</mag>
           <Tempo>
             <tempo>2</tempo>
@@ -1737,7 +1737,7 @@
             <text><sym>metNoteQuarterUp</sym><sym>space</sym><sym>metAugmentationDot</sym> = <sym>metNoteQuarterUp</sym></text>
             </Tempo>
           </Cell>
-        <Cell name="Metric modulation">
+        <Cell name="Half note = Quarter note metric modulation">
           <mag>1.5</mag>
           <Tempo>
             <tempo>2</tempo>
@@ -1745,7 +1745,7 @@
             <text><sym>metNoteHalfUp</sym> = <sym>metNoteQuarterUp</sym></text>
             </Tempo>
           </Cell>
-        <Cell name="Metric modulation">
+        <Cell name="Quarter note = Half note metric modulation">
           <mag>1.5</mag>
           <Tempo>
             <tempo>2</tempo>
@@ -1753,7 +1753,7 @@
             <text><sym>metNoteQuarterUp</sym> = <sym>metNoteHalfUp</sym></text>
             </Tempo>
           </Cell>
-        <Cell name="Metric modulation">
+        <Cell name="8th note = 8th note metric modulation">
           <mag>1.5</mag>
           <Tempo>
             <tempo>2</tempo>
@@ -1761,7 +1761,7 @@
             <text><sym>metNote8thUp</sym> = <sym>metNote8thUp</sym></text>
             </Tempo>
           </Cell>
-        <Cell name="Metric modulation">
+        <Cell name="Quarter note = Quarter note metric modulation">
           <mag>1.5</mag>
           <Tempo>
             <tempo>2</tempo>
diff --git a/share/workspaces/Basic.xml b/share/workspaces/Basic.xml
index 6fe7b2c77cb43..c81a4e72f3dda 100644
--- a/share/workspaces/Basic.xml
+++ b/share/workspaces/Basic.xml
@@ -256,7 +256,7 @@
             <action>add-brackets</action>
             </Icon>
           </Cell>
-        <Cell name="Add parentheses to element">
+        <Cell name="Add parentheses to accidental">
           <Icon>
             <subtype>22</subtype>
             <action>add-parentheses</action>
@@ -418,28 +418,28 @@
             <track>0</track>
             </Ottava>
           </Cell>
-        <Cell name="Pedal">
+        <Cell name="Pedal (straight lines)">
           <Pedal id="12">
             <endHookType>1</endHookType>
             <beginHookType>1</beginHookType>
             <track>0</track>
             </Pedal>
           </Cell>
-        <Cell name="Pedal">
+        <Cell name="Pedal (diagonal end line)">
           <Pedal id="13">
             <endHookType>2</endHookType>
             <beginHookType>1</beginHookType>
             <track>0</track>
             </Pedal>
           </Cell>
-        <Cell name="Pedal">
+        <Cell name="Pedal (both diagonal lines)">
           <Pedal id="14">
             <endHookType>2</endHookType>
             <beginHookType>2</beginHookType>
             <track>0</track>
             </Pedal>
           </Cell>
-        <Cell name="Pedal">
+        <Cell name="Pedal (diagonal start line)">
           <Pedal id="15">
             <endHookType>1</endHookType>
             <beginHookType>2</beginHookType>
@@ -464,19 +464,19 @@
             <subtype>double</subtype>
             </BarLine>
           </Cell>
-        <Cell name="Start repeat">
+        <Cell name="Start repeat (Barline)">
           <staff>1</staff>
           <BarLine>
             <subtype>start-repeat</subtype>
             </BarLine>
           </Cell>
-        <Cell name="End repeat">
+        <Cell name="End repeat (Barline)">
           <staff>1</staff>
           <BarLine>
             <subtype>end-repeat</subtype>
             </BarLine>
           </Cell>
-        <Cell name="End-start repeat">
+        <Cell name="End-start repeat (Barline)">
           <staff>1</staff>
           <BarLine>
             <subtype>end-start-repeat</subtype>
@@ -585,7 +585,7 @@
         <mag>0.65</mag>
         <grid>1</grid>
         <moreElements>1</moreElements>
-        <Cell name="Tempo text">
+        <Cell name="Half note equals 80 tempo text">
           <mag>1.5</mag>
           <Tempo>
             <tempo>2.66667</tempo>
@@ -593,7 +593,7 @@
             <text><sym>metNoteHalfUp</sym> = 80</text>
             </Tempo>
           </Cell>
-        <Cell name="Tempo text">
+        <Cell name="Quarter note equals 80 tempo text">
           <mag>1.5</mag>
           <Tempo>
             <tempo>1.33333</tempo>
@@ -601,7 +601,7 @@
             <text><sym>metNoteQuarterUp</sym> = 80</text>
             </Tempo>
           </Cell>
-        <Cell name="Tempo text">
+        <Cell name="8th note equals 80 tempo text">
           <mag>1.5</mag>
           <Tempo>
             <tempo>0.666667</tempo>
@@ -609,7 +609,7 @@
             <text><sym>metNote8thUp</sym> = 80</text>
             </Tempo>
           </Cell>
-        <Cell name="Tempo text">
+        <Cell name="Dotted Quarter note equals 80 tempo text">
           <mag>1.5</mag>
           <Tempo>
             <tempo>2</tempo>