Skip to main content
summaryrefslogtreecommitdiffstats
blob: 4830f88ba6f7a9e0251be78741ec164420ed8248 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
/*******************************************************************************
 * Copyright (c) 2010 Boeing.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Boeing - initial API and implementation
 *******************************************************************************/
package org.eclipse.osee.coverage.editor;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.eclipse.osee.coverage.action.GenerateDetailedCoverageReportAction;
import org.eclipse.osee.coverage.action.ICoveragePackageHandler;
import org.eclipse.osee.coverage.help.ui.CoverageHelpContext;
import org.eclipse.osee.coverage.model.CoverageOption;
import org.eclipse.osee.coverage.model.CoverageOptionManager;
import org.eclipse.osee.coverage.model.CoveragePackageBase;
import org.eclipse.osee.coverage.model.CoverageUnit;
import org.eclipse.osee.coverage.util.CoverageUtil;
import org.eclipse.osee.framework.jdk.core.util.AHTML;
import org.eclipse.osee.framework.ui.plugin.util.HelpUtil;
import org.eclipse.osee.framework.ui.skynet.action.RefreshAction;
import org.eclipse.osee.framework.ui.skynet.action.RefreshAction.IRefreshActionHandler;
import org.eclipse.osee.framework.ui.skynet.action.browser.BrowserPrintAction;
import org.eclipse.osee.framework.ui.skynet.action.browser.IBrowserActionHandler;
import org.eclipse.osee.framework.ui.skynet.results.XResultData;
import org.eclipse.osee.framework.ui.skynet.results.html.XResultsComposite;
import org.eclipse.osee.framework.ui.swt.Displays;
import org.eclipse.osee.framework.ui.swt.ImageManager;
import org.eclipse.swt.SWT;
import org.eclipse.swt.browser.Browser;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.forms.IManagedForm;
import org.eclipse.ui.forms.editor.FormEditor;
import org.eclipse.ui.forms.editor.FormPage;
import org.eclipse.ui.forms.widgets.ScrolledForm;

/**
 * @author Donald G. Dunne
 */
public class CoverageEditorOverviewTab extends FormPage implements IRefreshActionHandler, ICoveragePackageHandler, IBrowserActionHandler {

   private final CoverageEditor coverageEditor;
   private final CoveragePackageBase coveragePackageBase;
   XResultsComposite xResultsComp;
   private static String ALL_COVERAGE_METHODS = " ALL Coverage Methods";
   private static String ALL_TOP_FOLDERS = " ALL Top Folders";
   public static String PAGE_ID = "coverage.overview";

   public CoverageEditorOverviewTab(String name, CoverageEditor coverageEditor, CoveragePackageBase provider) {
      super(coverageEditor, name, name);
      this.coverageEditor = coverageEditor;
      this.coveragePackageBase = provider;
   }

   @Override
   protected void createFormContent(IManagedForm managedForm) {
      super.createFormContent(managedForm);

      final ScrolledForm scrolledForm = managedForm.getForm();
      scrolledForm.setText(coveragePackageBase.getName());
      scrolledForm.setImage(ImageManager.getImage(CoverageUtil.getCoveragePackageBaseImage(coveragePackageBase)));

      createToolBar();
      Composite composite = scrolledForm.getBody();
      composite.setLayoutData(new GridData(SWT.FILL, SWT.NONE, true, false));
      composite.setLayout(new GridLayout(1, true));

      CoverageEditorCoverageTab.createBranchLabel(coverageEditor, composite);

      xResultsComp = new XResultsComposite(composite, SWT.NONE);
      xResultsComp.setLayoutData(new GridData(GridData.FILL_BOTH | GridData.VERTICAL_ALIGN_BEGINNING));
      GridData gd = new GridData(GridData.FILL_BOTH);
      gd.heightHint = 500;
      xResultsComp.setLayoutData(gd);
      coverageEditor.getToolkit().adapt(xResultsComp);

      HelpUtil.setHelp(xResultsComp, CoverageHelpContext.EDITOR__OVERVIEW_TAB);

      refreshHtml();
   }

   public void refreshHtml() {
      final XResultData rd = new XResultData(false);
      coveragePackageBase.getOverviewHtmlHeader(rd);
      rd.log("");
      rd.log(AHTML.getLabelValueStr(
         "Total Coverage ",
         CoverageUtil.getPercent(coveragePackageBase.getCoverageItemsCovered().size(),
            coveragePackageBase.getCoverageItems().size(), true).getSecond()));
      rd.log("");
      rd.log(AHTML.getLabelValueStr("Coverage Breakdown", ""));
      rd.addRaw(AHTML.beginMultiColumnTable(100, 1));

      // Create headers
      List<String> sortedHeaders = getSortedHeaders(coveragePackageBase);
      rd.addRaw(AHTML.addHeaderRowMultiColumnTable(sortedHeaders));

      for (String[] values : getRows(sortedHeaders, coveragePackageBase, true)) {
         rd.addRaw(AHTML.addRowMultiColumnTable(values));
      }

      rd.addRaw(AHTML.endMultiColumnTable());
      String branchName = null;
      try {
         branchName = coverageEditor.getBranch().getName();
      } catch (Exception ex) {
         branchName = "Exception: " + ex.getLocalizedMessage();
      }
      rd.addRaw(AHTML.newline());
      rd.addRaw(AHTML.getLabelValueStr("\nEditor Branch", branchName));
      if (coveragePackageBase.getLog() != null) {
         rd.log(AHTML.newline() + AHTML.bold("Log:") + AHTML.newline());
         rd.addRaw(coveragePackageBase.getLog().getReport("").getManipulatedHtml());
      }

      Displays.ensureInDisplayThread(new Runnable() {
         @Override
         public void run() {
            xResultsComp.setHtmlText(rd.getReport(coveragePackageBase.getName()).getManipulatedHtml(),
               coveragePackageBase.getName());
         }
      });
   }

   public static List<String[]> getRows(List<String> sortedHeaders, CoveragePackageBase coveragePackageBase, boolean html) {

      Map<String, CoverageUnit> headerToCoverageUnit = new HashMap<String, CoverageUnit>();
      for (CoverageUnit coverageUnit : coveragePackageBase.getCoverageUnits()) {
         headerToCoverageUnit.put(coverageUnit.getName(), coverageUnit);
      }

      // Create rows
      String rowsSorted[] = getRowNamesSorted(coveragePackageBase);
      Map<String, CoverageOption> rowToCoverageOption = new HashMap<String, CoverageOption>();
      for (CoverageOption option : coveragePackageBase.getCoverageOptionManager().get()) {
         rowToCoverageOption.put(option.getName(), option);
      }

      List<String[]> rows = new ArrayList<String[]>();
      for (String rowName : rowsSorted) {
         List<String> values = new ArrayList<String>();
         for (String header : sortedHeaders) {
            if (header.equals("")) {
               if (html) {
                  values.add(AHTML.bold(rowName));
               } else {
                  values.add(rowName);
               }
            }
            // Show totals for ALL and Each CoverageOption
            else if (header.equals(ALL_TOP_FOLDERS)) {
               // Show totals for full coverage package
               if (rowName.equals(ALL_COVERAGE_METHODS)) {
                  String percent =
                     CoverageUtil.getPercent(coveragePackageBase.getCoverageItemsCovered().size(),
                        coveragePackageBase.getCoverageItems().size(), true).getSecond();
                  if (html) {
                     values.add(AHTML.bold(percent));
                  } else {
                     values.add(percent);
                  }
               }
               // Show totals for each coverage method
               else if (!rowName.equals(CoverageOptionManager.Not_Covered.getName())) {
                  int totalCoverageItems = coveragePackageBase.getCoverageItems().size();
                  if (totalCoverageItems == 0) {
                     values.add("0");
                  } else {
                     CoverageOption CoverageOption = rowToCoverageOption.get(rowName);
                     values.add(CoverageUtil.getPercent(
                        coveragePackageBase.getCoverageItemsCovered(CoverageOption).size(), totalCoverageItems, false).getSecond());
                  }
               }
            }
            // Show totals for ALL by top CoverageUnit and each CoverageOption by top CoverageUnit
            else {
               CoverageUnit coverageUnit = headerToCoverageUnit.get(header);
               if (rowName.equals(ALL_COVERAGE_METHODS)) {
                  int totalCoverageItems = coverageUnit.getCoverageItems(true).size();
                  if (totalCoverageItems == 0) {
                     values.add("0");
                  } else {
                     values.add(CoverageUtil.getPercent(coverageUnit.getCoverageItemsCovered(true).size(),
                        totalCoverageItems, false).getSecond());
                  }
               } else if (!rowName.equals(CoverageOptionManager.Not_Covered.getName())) {
                  CoverageOption CoverageOption = rowToCoverageOption.get(rowName);
                  int totalCoverageItems = coverageUnit.getCoverageItems(true).size();
                  if (totalCoverageItems == 0) {
                     values.add("0");
                  } else {
                     values.add(CoverageUtil.getPercent(
                        coverageUnit.getCoverageItemsCovered(true, CoverageOption).size(), totalCoverageItems, false).getSecond());
                  }
               }
            }
         }
         rows.add(values.toArray(new String[values.size()]));
      }
      return rows;
   }

   public static String[] getRowNamesSorted(CoveragePackageBase coveragePackageBase) {
      List<String> rowNames = new ArrayList<String>();
      rowNames.add(ALL_COVERAGE_METHODS);
      for (CoverageOption option : coveragePackageBase.getCoverageOptionManager().get()) {
         if (!option.getName().equals(CoverageOptionManager.Not_Covered.getName())) {
            rowNames.add(option.getName());
         }
      }
      String rowsSorted[] = rowNames.toArray(new String[rowNames.size()]);
      Arrays.sort(rowsSorted);
      return rowsSorted;
   }

   public static List<String> getSortedHeaders(CoveragePackageBase coveragePackageBase) {
      List<String> headers = new ArrayList<String>();
      headers.add("");
      if (coveragePackageBase.getChildren().size() > 1) {
         headers.add(ALL_TOP_FOLDERS);
      }
      for (CoverageUnit coverageUnit : coveragePackageBase.getCoverageUnits()) {
         headers.add(coverageUnit.getName());
      }
      String headersSorted[] = headers.toArray(new String[headers.size()]);
      Arrays.sort(headersSorted);
      return headers;
   }

   public void createToolBar() {
      getManagedForm().getForm().getToolBarManager().add(new GenerateDetailedCoverageReportAction(this));
      getManagedForm().getForm().getToolBarManager().add(new BrowserPrintAction(this));
      getManagedForm().getForm().getToolBarManager().add(new RefreshAction(this));
      CoverageEditor.addToToolBar(getManagedForm().getForm().getToolBarManager(), coverageEditor);
   }

   @Override
   public FormEditor getEditor() {
      return super.getEditor();
   }

   @Override
   public void refreshActionHandler() {
      refreshHtml();
   }

   @Override
   public Browser getBrowser() {
      return xResultsComp.getBrowser();
   }

   @Override
   public CoveragePackageBase getCoveragePackageBase() {
      return coveragePackageBase;
   }

   @Override
   public String getId() {
      return PAGE_ID;
   }

}

Back to the top